gate.mimir

Enum SemanticAnnotationHelper.Mode

java.lang.Object

java.lang.Enum<SemanticAnnotationHelper.Mode>

gate.mimir.SemanticAnnotationHelper.Mode

All Implemented Interfaces:

Serializable, Comparable<SemanticAnnotationHelper.Mode>

Enclosing interface:

SemanticAnnotationHelper

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

Functioning mode for the annotation helper.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATION The default mode: the helper gets annotation values and produces mention URIs associated with them.
DOCUMENT Mode used when indexing document features.

Method Summary

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

ANNOTATION

public static final SemanticAnnotationHelper.Mode ANNOTATION

The default mode: the helper gets annotation values and produces mention URIs associated with them.

DOCUMENT

public static final SemanticAnnotationHelper.Mode DOCUMENT

Mode used when indexing document features. At indexing time, a helper configured in this way will only get its SemanticAnnotationHelper#getMentionUris(Annotation, int, Indexer) method called once, with a null value for the annotation. At search time, the helper will emulate document-spanning annotations by obtaining the document length from the QueryEngine#getDocumentSizes() method.

Method Detail

values

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

Returns:

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

valueOf

public static SemanticAnnotationHelper.Mode 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