Package org.hibernate.search.engine.backend.types

Enum Highlightable

java.lang.Object

java.lang.Enum<Highlightable>

org.hibernate.search.engine.backend.types.Highlightable

All Implemented Interfaces:

Serializable, Comparable<Highlightable>

public enum Highlightable
extends Enum<Highlightable>

Whether we want to be able to highlight this field.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Allow any highlighter type be applied for highlighting the field.
DEFAULT	Use the backend-specific default that is dependent on an overall field configuration.
FAST_VECTOR	Allow the fast vector highlighter type be applied for highlighting the field.
NO	Do not allow highlighting on 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.

Method Summary

Modifier and Type	Method	Description
static Highlightable	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final Highlightable 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 is projectable then [PLAIN, UNIFIED] highlighters are supported. Otherwise it defaults to NO.
• Elasticsearch's default value is [PLAIN, UNIFIED]
• Additionally, if the term vector storing strategy is set to TermVector.WITH_POSITIONS_OFFSETS or TermVector.WITH_POSITIONS_OFFSETS_PAYLOADS both backends, would support the FAST_VECTOR highlighter, if they already support the other two ([PLAIN, UNIFIED]).

NO

public static final Highlightable NO

Do not allow highlighting on the field.

ANY

public static final Highlightable ANY

Allow any highlighter type be applied for highlighting the field.

PLAIN

public static final Highlightable PLAIN

Allow the plain highlighter type be applied for highlighting the field.

UNIFIED

public static final Highlightable UNIFIED

Allow the unified highlighter type be applied for highlighting the field.

FAST_VECTOR

public static final Highlightable FAST_VECTOR

Allow the fast vector highlighter type be applied for highlighting the field.

Method Detail

values

public static Highlightable[] 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 (Highlightable c : Highlightable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Highlightable valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null