Class SummaryClass
- java.lang.Object
-
- com.yahoo.searchdefinition.derived.Derived
-
- com.yahoo.searchdefinition.derived.SummaryClass
-
- All Implemented Interfaces:
Exportable
public class SummaryClass extends Derived
A summary derived from a search definition. Each summary definition have at least one summary, the default which has the same name as the search definition.- Author:
- bratseth
-
-
Field Summary
Fields Modifier and Type Field Description static String
DOCUMENT_ID_FIELD
-
Constructor Summary
Constructors Constructor Description SummaryClass(Schema schema, DocumentSummary summary, com.yahoo.config.application.api.DeployLogger deployLogger)
Creates a summary class from a search definition summary
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addField(SummaryClassField field)
Iterator<SummaryClassField>
fieldIterator()
Returns an iterator of the fields of this summary.protected String
getDerivedName()
SummaryClassField
getField(String name)
int
getFieldCount()
Map<String,SummaryClassField>
getFields()
Returns the writable map of fields of this summarycom.yahoo.vespa.config.search.SummaryConfig.Classes.Builder
getSummaryClassConfig()
int
hashCode()
String
toString()
-
-
-
Field Detail
-
DOCUMENT_ID_FIELD
public static final String DOCUMENT_ID_FIELD
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SummaryClass
public SummaryClass(Schema schema, DocumentSummary summary, com.yahoo.config.application.api.DeployLogger deployLogger)
Creates a summary class from a search definition summary- Parameters:
deployLogger
- aDeployLogger
-
-
Method Detail
-
fieldIterator
public Iterator<SummaryClassField> fieldIterator()
Returns an iterator of the fields of this summary. Removes on this iterator removes the field from this summary
-
addField
public void addField(SummaryClassField field)
-
getFields
public Map<String,SummaryClassField> getFields()
Returns the writable map of fields of this summary
-
getField
public SummaryClassField getField(String name)
-
getFieldCount
public int getFieldCount()
-
getSummaryClassConfig
public com.yahoo.vespa.config.search.SummaryConfig.Classes.Builder getSummaryClassConfig()
-
getDerivedName
protected String getDerivedName()
- Specified by:
getDerivedName
in classDerived
-
-