|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocalDBIndexCfgClient
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 |
---|
ManagedObjectDefinition<? extends LocalDBIndexCfgClient,? extends LocalDBIndexCfg> definition()
definition
in interface ConfigurationClient
AttributeType getAttribute()
Specifies the name of the attribute for which the index is to be maintained.
void setAttribute(AttributeType value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "attribute" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Local DB Index is not being initialized.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.
void setIndexEntryLimit(java.lang.Integer value) throws IllegalPropertyValueException
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.
value
- The value of the "index-entry-limit" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setIndexType(java.util.Collection<LocalDBIndexCfgDefn.IndexType> values) throws IllegalPropertyValueException
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.
values
- The values of the "index-type" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.int getSubstringLength()
The length of substrings in a substring index.
void setSubstringLength(java.lang.Integer value) throws IllegalPropertyValueException
The length of substrings in a substring index.
value
- The value of the "substring-length" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |