org.opends.server.admin.std.meta
Enum LocalDBIndexCfgDefn.IndexType

java.lang.Object
  extended by java.lang.Enum<LocalDBIndexCfgDefn.IndexType>
      extended by org.opends.server.admin.std.meta.LocalDBIndexCfgDefn.IndexType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<LocalDBIndexCfgDefn.IndexType>
Enclosing class:
LocalDBIndexCfgDefn

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

Defines the set of permissable values for the "index-type" property.

Specifies the type(s) of indexing that should be performed for the associated attribute.

For equality, presence, and substring index types, the associated attribute type must have a corresponding matching rule.


Enum Constant Summary
APPROXIMATE
          This index type is used to improve the efficiency of searches using approximate matching search filters.
EQUALITY
          This index type is used to improve the efficiency of searches using equality search filters.
ORDERING
          This index type is used to improve the efficiency of searches using "greater than or equal to" or "less then or equal to" search filters.
PRESENCE
          This index type is used to improve the efficiency of searches using the presence search filters.
SUBSTRING
          This index type is used to improve the efficiency of searches using substring search filters.
 
Method Summary
 java.lang.String toString()
          
static LocalDBIndexCfgDefn.IndexType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LocalDBIndexCfgDefn.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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

APPROXIMATE

public static final LocalDBIndexCfgDefn.IndexType APPROXIMATE
This index type is used to improve the efficiency of searches using approximate matching search filters.


EQUALITY

public static final LocalDBIndexCfgDefn.IndexType EQUALITY
This index type is used to improve the efficiency of searches using equality search filters.


ORDERING

public static final LocalDBIndexCfgDefn.IndexType ORDERING
This index type is used to improve the efficiency of searches using "greater than or equal to" or "less then or equal to" search filters.


PRESENCE

public static final LocalDBIndexCfgDefn.IndexType PRESENCE
This index type is used to improve the efficiency of searches using the presence search filters.


SUBSTRING

public static final LocalDBIndexCfgDefn.IndexType SUBSTRING
This index type is used to improve the efficiency of searches using substring search filters.

Method Detail

values

public static LocalDBIndexCfgDefn.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 (LocalDBIndexCfgDefn.IndexType c : LocalDBIndexCfgDefn.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 LocalDBIndexCfgDefn.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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<LocalDBIndexCfgDefn.IndexType>