gate.mimir.search

Enum QueryEngine.IndexType

java.lang.Object

java.lang.Enum<QueryEngine.IndexType>

gate.mimir.search.QueryEngine.IndexType

All Implemented Interfaces:

Serializable, Comparable<QueryEngine.IndexType>

Enclosing class:

QueryEngine

public static enum QueryEngine.IndexType
extends Enum<QueryEngine.IndexType>

Represents the type of index that should be searched. Mimir uses two types of indexes: token indexes (which index the text input) and annotation indexes (which index semantic annotations).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATIONS Value representing annotation indexes, used for the document semantic annotations.
TOKENS Value representing token indexes, used for the document text.

Method Summary

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

TOKENS

public static final QueryEngine.IndexType TOKENS

Value representing token indexes, used for the document text.

ANNOTATIONS

public static final QueryEngine.IndexType ANNOTATIONS

Value representing annotation indexes, used for the document semantic annotations.

Method Detail

values

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

Returns:

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

valueOf

public static QueryEngine.IndexType 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