Package org.basex.index

Enum Class IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.basex.index.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>, java.lang.constant.Constable

public enum IndexType
extends Enum<IndexType>

This enumeration lists available index types.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTRIBUTE	Attribute index.
ATTRNAME	Attribute names.
ELEMNAME	Element names.
FULLTEXT	Full-text index.
PATH	Path index.
TEXT	Text index.
TOKEN	Token index.

Method Summary

Modifier and Type	Method	Description
void	check(Data data, InputInfo ii)	Checks if the specified database has this index.
String	toString()
static IndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ELEMNAME

public static final IndexType ELEMNAME

Element names.

ATTRNAME

public static final IndexType ATTRNAME

Attribute names.

PATH

public static final IndexType PATH

Path index.

TEXT

public static final IndexType TEXT

Text index.

ATTRIBUTE

public static final IndexType ATTRIBUTE

Attribute index.

TOKEN

public static final IndexType TOKEN

Token index.

FULLTEXT

public static final IndexType FULLTEXT

Full-text index.

Method Details

values

public static IndexType[] 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 IndexType 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

toString

public String toString()

Overrides:

toString in class Enum<IndexType>

check

public void check(Data data,
 InputInfo ii)
           throws QueryException

Checks if the specified database has this index.

Parameters:

data - data reference

ii - input info

Throws:

QueryException - query exception