|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocalDBIndexCfg
A server-side interface for querying 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 | |
---|---|
void |
addChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener)
Register to be notified when this Local DB Index is changed. |
java.lang.Class<? extends LocalDBIndexCfg> |
configurationClass()
Gets the configuration class 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 |
removeChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener)
Deregister an existing Local DB Index configuration change listener. |
Methods inherited from interface org.opends.server.admin.Configuration |
---|
dn |
Method Detail |
---|
java.lang.Class<? extends LocalDBIndexCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener)
listener
- The Local DB Index configuration change listener.void removeChangeListener(ConfigurationChangeListener<LocalDBIndexCfg> listener)
listener
- The Local DB Index configuration change listener.AttributeType getAttribute()
Specifies the name of the attribute for which the index is to be maintained.
java.lang.Integer getIndexEntryLimit()
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.
java.util.SortedSet<LocalDBIndexCfgDefn.IndexType> getIndexType()
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.
int getSubstringLength()
The length of substrings in a substring index.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |