Package com.yahoo.vespa.documentmodel
Enum Class SummaryTransform
- All Implemented Interfaces:
Serializable
,Comparable<SummaryTransform>
,Constable
A value class representing a search time
transformation on a summary field.
- Author:
- bratseth
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionbold()
Returns the bolded version of this transform if possible, throws if notgetName()
boolean
isBolded()
Returns whether this value is boldedboolean
Whether this is dynamically generated, both teasers and bolded fields are dynamicboolean
Returns whether this transform always gets its value by accessing memory onlyboolean
isTeaser()
Returns whether this is a teaser, not the complete field valueboolean
isTokens()
toString()
unbold()
Returns the unbolded version of this transformstatic SummaryTransform
Returns the enum constant of this class with the specified name.static SummaryTransform[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
-
ATTRIBUTE
-
BOLDED
-
DISTANCE
-
DYNAMICBOLDED
-
DYNAMICTEASER
-
POSITIONS
-
RANKFEATURES
-
SUMMARYFEATURES
-
GEOPOS
-
ATTRIBUTECOMBINER
-
MATCHED_ELEMENTS_FILTER
-
MATCHED_ATTRIBUTE_ELEMENTS_FILTER
-
COPY
-
DOCUMENT_ID
-
TOKENS
-
ATTRIBUTE_TOKENS
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getName
-
bold
Returns the bolded version of this transform if possible, throws if not -
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 -
isTokens
public boolean isTokens() -
isInMemory
public boolean isInMemory()Returns whether this transform always gets its value by accessing memory only -
toString
- Overrides:
toString
in classEnum<SummaryTransform>
-