Package com.arangodb.entity.arangosearch

Enum AnalyzerFeature

java.lang.Object

java.lang.Enum<AnalyzerFeature>

com.arangodb.entity.arangosearch.AnalyzerFeature

All Implemented Interfaces:

Serializable, Comparable<AnalyzerFeature>

public enum AnalyzerFeature
extends Enum<AnalyzerFeature>

Author:

Michele Rastelli

Enum Constant Summary

Enum Constants

Enum Constant	Description
frequency	how often a term is seen, required for PHRASE()
norm	the field normalization factor
offset	enable search highlighting capabilities (Enterprise Edition only).
position	sequentially increasing term position, required for PHRASE().

Method Summary

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

frequency

public static final AnalyzerFeature frequency

how often a term is seen, required for PHRASE()

norm

public static final AnalyzerFeature norm

the field normalization factor

position

public static final AnalyzerFeature position

sequentially increasing term position, required for PHRASE(). If present then the frequency feature is also required.

offset

public static final AnalyzerFeature offset

enable search highlighting capabilities (Enterprise Edition only). If present, then the `position` and `frequency` features are also required.

Since:

ArangoDB 3.10

Method Detail

values

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

Returns:

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

valueOf

public static AnalyzerFeature 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