Package com.yahoo.vespa.documentmodel

Class DocumentSummary

java.lang.Object
com.yahoo.vespa.documentmodel.FieldView
com.yahoo.vespa.documentmodel.DocumentSummary
All Implemented Interfaces:
Serializable
public class DocumentSummary extends FieldView
A document summary definition - a list of summary fields.
Author:
bratseth
See Also:

  • Constructor Details

    • DocumentSummary

      public DocumentSummary(String name, Schema owner)
      Creates a DocumentSummary with the given name.

  • Method Details

    • id

      public int id()

    • setFromDisk

      public void setFromDisk(boolean fromDisk)

    • isFromDisk

      public boolean isFromDisk()
      Returns whether the user has noted explicitly that this summary accesses disk

    • setOmitSummaryFeatures

      public void setOmitSummaryFeatures(boolean value)

    • omitSummaryFeatures

      public boolean omitSummaryFeatures()

    • add

      public void add(SummaryField summaryField)
      The model is constrained to ensure that summary fields of the same name in different classes have the same summary transform, because this is what is supported by the backend currently.
      Parameters:
      summaryField - the summaryfield to add

    • getSummaryField

      public SummaryField getSummaryField(String name)

    • getSummaryFields

      public Map<String,SummaryField> getSummaryFields()

    • purgeImplicits

      public void purgeImplicits()
      Removes implicit fields which shouldn't be included. This is implicitly added fields which are sources for other fields. We then assume they are not intended to be added implicitly in addition. This should be called when this summary is complete.

    • setInherited

      public void setInherited(String inherited)
      Sets the parent of this. Both summaries must be present in the same search definition

    • inherited

      public Optional<DocumentSummary> inherited()
      Returns the parent of this, if any

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validate

      public void validate(com.yahoo.config.application.api.DeployLogger logger)