org.gecko.search.api

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.gecko.search.api.IndexType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexType>

public enum IndexType
extends java.lang.Enum<IndexType>

Defines supported index types

Since:

08.12.2018

Enum Constant Summary

Enum Constants

Enum Constant and Description
FACETTED Used for faceted indexing
INDEX Used for ordinary indexing
SUGGEST Used for auto-proposal, suggestion indexing

Method Summary

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

INDEX

public static final IndexType INDEX

Used for ordinary indexing

FACETTED

public static final IndexType FACETTED

Used for faceted indexing

SUGGEST

public static final IndexType SUGGEST

Used for auto-proposal, suggestion indexing

Method Detail

values

public static 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 (IndexType c : 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 IndexType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null