org.opends.server.admin.std.client
Interface LocalDBIndexCfgClient

All Superinterfaces:
ConfigurationClient

public interface LocalDBIndexCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Local DB Index settings.

Local DB Indexes are used to store information that makes it possible to locate entries very quickly when processing search operations.


Method Summary
 ManagedObjectDefinition<? extends LocalDBIndexCfgClient,? extends LocalDBIndexCfg> definition()
          Get the configuration definition associated with this Local DB Index.
 AttributeType getAttribute()
          Gets the "attribute" property.
 java.lang.Integer getIndexEntryLimit()
          Gets the "index-entry-limit" property.
 java.util.SortedSet<LocalDBIndexCfgDefn.IndexType> getIndexType()
          Gets the "index-type" property.
 int getSubstringLength()
          Gets the "substring-length" property.
 void setAttribute(AttributeType value)
          Sets the "attribute" property.
 void setIndexEntryLimit(java.lang.Integer value)
          Sets the "index-entry-limit" property.
 void setIndexType(java.util.Collection<LocalDBIndexCfgDefn.IndexType> values)
          Sets the "index-type" property.
 void setSubstringLength(java.lang.Integer value)
          Sets the "substring-length" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends LocalDBIndexCfgClient,? extends LocalDBIndexCfg> definition()
Get the configuration definition associated with this Local DB Index.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Local DB Index.

getAttribute

AttributeType getAttribute()
Gets the "attribute" property.

Specifies the name of the attribute for which the index is to be maintained.

Returns:
Returns the value of the "attribute" property.

setAttribute

void setAttribute(AttributeType value)
                  throws IllegalPropertyValueException,
                         PropertyIsReadOnlyException
Sets the "attribute" property.

Specifies the name of the attribute for which the index is to be maintained.

This property is read-only and can only be modified during creation of a Local DB Index.

Parameters:
value - The value of the "attribute" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Local DB Index is not being initialized.

getIndexEntryLimit

java.lang.Integer getIndexEntryLimit()
Gets the "index-entry-limit" property.

Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.

This is analogous to the ALL IDs threshold in the Sun Java System Directory Server. If this is specified, its value overrides the JE backend-wide configuration. For no limit, use 0 for the value.

Returns:
Returns the value of the "index-entry-limit" property.

setIndexEntryLimit

void setIndexEntryLimit(java.lang.Integer value)
                        throws IllegalPropertyValueException
Sets the "index-entry-limit" property.

Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.

This is analogous to the ALL IDs threshold in the Sun Java System Directory Server. If this is specified, its value overrides the JE backend-wide configuration. For no limit, use 0 for the value.

Parameters:
value - The value of the "index-entry-limit" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getIndexType

java.util.SortedSet<LocalDBIndexCfgDefn.IndexType> getIndexType()
Gets 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.

Returns:
Returns the values of the "index-type" property.

setIndexType

void setIndexType(java.util.Collection<LocalDBIndexCfgDefn.IndexType> values)
                  throws IllegalPropertyValueException
Sets 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.

Parameters:
values - The values of the "index-type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getSubstringLength

int getSubstringLength()
Gets the "substring-length" property.

The length of substrings in a substring index.

Returns:
Returns the value of the "substring-length" property.

setSubstringLength

void setSubstringLength(java.lang.Integer value)
                        throws IllegalPropertyValueException
Sets the "substring-length" property.

The length of substrings in a substring index.

Parameters:
value - The value of the "substring-length" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.