com.arakelian.elastic.model.search

Enum Highlighter.Type

java.lang.Object

java.lang.Enum<Highlighter.Type>

com.arakelian.elastic.model.search.Highlighter.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Highlighter.Type>

Enclosing interface:

Highlighter

public static enum Highlighter.Type
extends java.lang.Enum<Highlighter.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FVH The fvh highlighter uses the Lucene Fast Vector highlighter.
PLAIN The plain highlighter uses the standard Lucene highlighter.
UNIFIED The unified highlighter uses the Lucene Unified Highlighter.

Method Summary

Modifier and Type	Method and Description
static Highlighter.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Highlighter.Type[]	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

UNIFIED

public static final Highlighter.Type UNIFIED

The unified highlighter uses the Lucene Unified Highlighter. This highlighter breaks the text into sentences and uses the BM25 algorithm to score individual sentences as if they were documents in the corpus. It also supports accurate phrase and multi-term (fuzzy, prefix, regex) highlighting. This is the default highlighter.

PLAIN

public static final Highlighter.Type PLAIN

The plain highlighter uses the standard Lucene highlighter. It attempts to reflect the query matching logic in terms of understanding word importance and any word positioning criteria in phrase queries.

FVH

public static final Highlighter.Type FVH

The fvh highlighter uses the Lucene Fast Vector highlighter. This highlighter can be used on fields with term_vector set to with_positions_offsets in the mapping.

Method Detail

values

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

Returns:

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

valueOf

public static Highlighter.Type 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