Package com.yahoo.vespa.documentmodel

Enum Class SummaryTransform

java.lang.Object
java.lang.Enum<SummaryTransform>
com.yahoo.vespa.documentmodel.SummaryTransform
All Implemented Interfaces:
Serializable, Comparable<SummaryTransform>, Constable
public enum SummaryTransform extends Enum<SummaryTransform>
A value class representing a search time transformation on a summary field.
Author:
bratseth

  • Enum Constant Details

  • Method Details

    • values

      public static SummaryTransform[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SummaryTransform valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()

    • bold

      public SummaryTransform bold()
      Returns the bolded version of this transform if possible, throws if not

    • unbold

      public SummaryTransform unbold()
      Returns the unbolded version of this transform

    • isBolded

      public boolean isBolded()
      Returns whether this value is bolded

    • isDynamic

      public boolean isDynamic()
      Whether this is dynamically generated, both teasers and bolded fields are dynamic

    • isTeaser

      public boolean isTeaser()
      Returns whether this is a teaser, not the complete field value

    • isInMemory

      public boolean isInMemory()
      Returns whether this transform always gets its value by accessing memory only

    • toString

      public String toString()
      Overrides:
      toString in class Enum<SummaryTransform>