SummaryMap (config-model 8.35.5 API)

java.lang.Object

com.yahoo.schema.derived.Derived

com.yahoo.schema.derived.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 Schema.

Author:: bratseth

Method Summary

Modifier and Type

Method

Description

protected void

derive(ImmutableSDField field, Schema schema)

Derives the content of this configuration.

protected void

derive(Schema schema)

Derives the content of this configuration.

void

getConfig(com.yahoo.vespa.config.search.SummarymapConfig.Builder builder)

protected String

getDerivedName()

static boolean

isDynamicCommand(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.

Map<String,FieldResultTransform>

resultTransforms()

Returns a read-only iterator of the FieldResultTransforms of this summary map

Methods inherited from class com.yahoo.schema.derived.Derived
derive, derive, export, getFileName, getIndex, getName, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- derive
  
  protected void derive(Schema schema)
  
  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, Schema schema)
  
  Description copied from class: Derived
  
  Derives the content of this configuration. This default does nothing.
  
  Overrides:
  
  derive in class Derived
- resultTransforms
  
  public Map<String,FieldResultTransform> resultTransforms()
  
  Returns a read-only iterator of the FieldResultTransforms of this summary map
- getDerivedName
  
  protected String getDerivedName()
  
  Specified by:
  
  getDerivedName in class Derived
- isDynamicCommand
  
  public static boolean isDynamicCommand(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