opennlp.tools.coref

Enum LinkerMode

java.lang.Object

java.lang.Enum<LinkerMode>

opennlp.tools.coref.LinkerMode

All Implemented Interfaces:

Serializable, Comparable<LinkerMode>

public enum LinkerMode
extends Enum<LinkerMode>

Enumeration of modes in which a linker can run.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVAL Evaluation mode, used to evaluate identifed coreference relationships based on annotated text.
SIM Training mode, used to learn coreference relationships in annotated text.
TEST Testing mode, used to identify coreference relationships in un-annotated text.
TRAIN Training mode, used to learn coreference relationships in annotated text.

Method Summary

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

TEST

public static final LinkerMode TEST

Testing mode, used to identify coreference relationships in un-annotated text.

TRAIN

public static final LinkerMode TRAIN

Training mode, used to learn coreference relationships in annotated text.

EVAL

public static final LinkerMode EVAL

Evaluation mode, used to evaluate identifed coreference relationships based on annotated text.

SIM

public static final LinkerMode SIM

Training mode, used to learn coreference relationships in annotated text.

Method Detail

values

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

Returns:

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

valueOf

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