java.lang.Object
- java.lang.Enum<SummaryTransform>
- - com.yahoo.vespa.documentmodel.SummaryTransform

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SummaryTransform>
```
public enum SummaryTransform
extends java.lang.Enum<SummaryTransform>
```
A value class representing a search time transformation on a summary field.

Author:

bratseth

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ATTRIBUTE`
`ATTRIBUTECOMBINER`
`BOLDED`
`DISTANCE`
`DYNAMICBOLDED`
`DYNAMICTEASER`
`GEOPOS`
`MATCHED_ATTRIBUTE_ELEMENTS_FILTER`
`MATCHED_ELEMENTS_FILTER`
`NONE`
`POSITIONS`
`RANKFEATURES`
`SUMMARYFEATURES`
`TEXTEXTRACTOR`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SummaryTransform`	`bold()`	Returns the bolded version of this transform if possible, throws if not
`java.lang.String`	`getName()`
`boolean`	`isBolded()`	Returns whether this value is bolded
`boolean`	`isDynamic()`	Whether this is dynamically generated, both teasers and bolded fields are dynamic
`boolean`	`isInMemory()`	Returns whether this transform always gets its value by accessing memory only
`boolean`	`isTeaser()`	Returns whether this is a teaser, not the complete field value
`java.lang.String`	`toString()`
`SummaryTransform`	`unbold()`	Returns the unbolded version of this transform
`static SummaryTransform`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static SummaryTransform[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final SummaryTransform NONE
```
  - ATTRIBUTE
```
public static final SummaryTransform ATTRIBUTE
```
  - BOLDED
```
public static final SummaryTransform BOLDED
```
  - DISTANCE
```
public static final SummaryTransform DISTANCE
```
  - DYNAMICBOLDED
```
public static final SummaryTransform DYNAMICBOLDED
```
  - DYNAMICTEASER
```
public static final SummaryTransform DYNAMICTEASER
```
  - POSITIONS
```
public static final SummaryTransform POSITIONS
```
  - RANKFEATURES
```
public static final SummaryTransform RANKFEATURES
```
  - SUMMARYFEATURES
```
public static final SummaryTransform SUMMARYFEATURES
```
  - TEXTEXTRACTOR
```
public static final SummaryTransform TEXTEXTRACTOR
```
  - GEOPOS
```
public static final SummaryTransform GEOPOS
```
  - ATTRIBUTECOMBINER
```
public static final SummaryTransform ATTRIBUTECOMBINER
```
  - MATCHED_ELEMENTS_FILTER
```
public static final SummaryTransform MATCHED_ELEMENTS_FILTER
```
  - MATCHED_ATTRIBUTE_ELEMENTS_FILTER
```
public static final SummaryTransform MATCHED_ATTRIBUTE_ELEMENTS_FILTER
```
- Method Detail
  - values
```
public static SummaryTransform[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (SummaryTransform c : SummaryTransform.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SummaryTransform valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getName
```
public java.lang.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<SummaryTransform>

Enum SummaryTransform

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

ATTRIBUTE

BOLDED

DISTANCE

DYNAMICBOLDED

DYNAMICTEASER

POSITIONS

RANKFEATURES

SUMMARYFEATURES

TEXTEXTRACTOR

GEOPOS

ATTRIBUTECOMBINER

MATCHED_ELEMENTS_FILTER

MATCHED_ATTRIBUTE_ELEMENTS_FILTER

Method Detail

values

valueOf

getName

bold

unbold

isBolded

isDynamic

isTeaser

isInMemory

toString