Enum Class TermVectorAnnotator.Mode

java.lang.Object

java.lang.Enum<TermVectorAnnotator.Mode>

opennlp.tools.termvector.TermVectorAnnotator.Mode

All Implemented Interfaces:

Serializable, Comparable<TermVectorAnnotator.Mode>, Constable

Enclosing class:

TermVectorAnnotator

public static enum TermVectorAnnotator.Mode
extends Enum<TermVectorAnnotator.Mode>

How much each TermVector records.

Since:

3.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL	Counts occurrences and stores every occurrence span in original text coordinates.
SCORING_ONLY	Counts occurrences only; the emitted term vectors carry no spans, so scoring-only consumers do not pay for offset storage.

Method Summary

Modifier and Type	Method	Description
static TermVectorAnnotator.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TermVectorAnnotator.Mode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

public static final TermVectorAnnotator.Mode FULL

Counts occurrences and stores every occurrence span in original text coordinates.

SCORING_ONLY

public static final TermVectorAnnotator.Mode SCORING_ONLY

Counts occurrences only; the emitted term vectors carry no spans, so scoring-only consumers do not pay for offset storage.

Method Details

values

public static TermVectorAnnotator.Mode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TermVectorAnnotator.Mode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null