Package com.yahoo.searchdefinition.derived

Class SummaryMap

  • All Implemented Interfaces:
    com.yahoo.config.ConfigInstance.Producer, Exportable, com.yahoo.vespa.config.search.SummarymapConfig.Producer
    public class SummaryMap
extends Derived
implements com.yahoo.vespa.config.search.SummarymapConfig.Producer
    A summary map (describing search-time summary field transformations) derived from a search definition
    Author:
    bratseth

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void derive​(ImmutableSDField field, Search search)
      Derives the content of this configuration.
      protected void derive​(Search search)
      Derives the content of this configuration.
      void getConfig​(com.yahoo.vespa.config.search.SummarymapConfig.Builder builder)  
      protected java.lang.String getDerivedName()  
      static boolean isDynamicCommand​(java.lang.String commandName)
      Does this summary command name stand for a dynamic transform? We need this because some model information is shared through configs instead of model - see usage A dynamic transform needs the query to perform its computations.
      java.util.Iterator resultTransformIterator()
      Returns a read-only iterator of the FieldResultTransforms of this summary map

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • derive

        protected void derive​(Search search)
        Description copied from class: Derived
        Derives the content of this configuration. This default calls derive(Document) for each document and derive(SDField) for each search definition level field AND sets the name of this to the name of the input search definition
        Overrides:
        derive in class Derived

      • derive

        protected void derive​(ImmutableSDField field,
                      Search search)
        Description copied from class: Derived
        Derives the content of this configuration. This default does nothing.
        Overrides:
        derive in class Derived

      • resultTransformIterator

        public java.util.Iterator resultTransformIterator()
        Returns a read-only iterator of the FieldResultTransforms of this summary map

      • getDerivedName

        protected java.lang.String getDerivedName()
        Specified by:
        getDerivedName in class Derived

      • isDynamicCommand

        public static boolean isDynamicCommand​(java.lang.String commandName)
        Does this summary command name stand for a dynamic transform? We need this because some model information is shared through configs instead of model - see usage A dynamic transform needs the query to perform its computations.

      • getConfig

        public void getConfig​(com.yahoo.vespa.config.search.SummarymapConfig.Builder builder)
        Specified by:
        getConfig in interface com.yahoo.vespa.config.search.SummarymapConfig.Producer