Enum Highlightable
- All Implemented Interfaces:
Serializable
,Comparable<Highlightable>
Whether we want to be able to highlight this field.
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAllow any highlighter type be applied for highlighting the field.Use the backend-specific default that is dependent on an overall field configuration.Allow the fast vector highlighter type be applied for highlighting the field.Do not allow highlighting on the field.Allow the plain highlighter type be applied for highlighting the field.Allow the unified highlighter type be applied for highlighting the field. -
Method Summary
Modifier and TypeMethodDescriptionstatic Highlightable
Returns the enum constant of this type with the specified name.static Highlightable[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DEFAULT
Use the backend-specific default that is dependent on an overall field configuration.-
Lucene's default value is dependent on the
projectable value
configured for the field. If the field isprojectable
then[PLAIN, UNIFIED]
highlighters are supported.Otherwise
it defaults toNO
. - Elasticsearch's default value is
[PLAIN, UNIFIED]
-
Additionally, if the
term vector storing strategy
is set toTermVector.WITH_POSITIONS_OFFSETS
orTermVector.WITH_POSITIONS_OFFSETS_PAYLOADS
both backends, would support theFAST_VECTOR
highlighter, if they already support the other two ([PLAIN, UNIFIED]
).
-
Lucene's default value is dependent on the
-
NO
Do not allow highlighting on the field. -
ANY
Allow any highlighter type be applied for highlighting the field. -
PLAIN
Allow the plain highlighter type be applied for highlighting the field. -
UNIFIED
Allow the unified highlighter type be applied for highlighting the field. -
FAST_VECTOR
Allow the fast vector highlighter type be applied for highlighting the field.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-