Enum Class CQIndexType

java.lang.Object

java.lang.Enum<CQIndexType>

org.efs.io.CQIndexType

All Implemented Interfaces:

Serializable, Comparable<CQIndexType>, Constable

public enum CQIndexType
extends Enum<CQIndexType>

Defines CQEngine attribute index types supported by efs which are:

• HashIndex
• NavigableIndex
• RadixTreeIndex
• ReversedRadixTreeIndex
• SuffixTreeIndex
• SuffixTreeIndex

If no index is applied to an attribute, then NO_INDEX is used.

Author:

Charles W. Rapp

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
HASH_INDEX	Create a HashIndex for attribute.
NAVIGABLE_INDEX	Create a NavigableIndex for attribute.
NO_INDEX	Do not create an index for attribute.
RADIX_TREE_INDEX	Create a RadixTreeIndex for attribute.
REVERSED_RADIX_INDEX	Create a ReversedRadixTreeIndex for attribute.
SUFFIX_RADIX_INDEX	Create a SuffixTreeIndex for attribute.
UNIQUE_INDEX	Create a SuffixTreeIndex for attribute.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_INDEX

public static final CQIndexType NO_INDEX

Do not create an index for attribute. This is the default settings for CQAttribute.index().

HASH_INDEX

public static final CQIndexType HASH_INDEX

Create a HashIndex for attribute.

NAVIGABLE_INDEX

public static final CQIndexType NAVIGABLE_INDEX

Create a NavigableIndex for attribute.

RADIX_TREE_INDEX

public static final CQIndexType RADIX_TREE_INDEX

Create a RadixTreeIndex for attribute.

REVERSED_RADIX_INDEX

public static final CQIndexType REVERSED_RADIX_INDEX

Create a ReversedRadixTreeIndex for attribute.

SUFFIX_RADIX_INDEX

public static final CQIndexType SUFFIX_RADIX_INDEX

Create a SuffixTreeIndex for attribute.

UNIQUE_INDEX

public static final CQIndexType UNIQUE_INDEX

Create a SuffixTreeIndex for attribute.

Method Details

values

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