public interface Index<K,O,ID>
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_INDEX_CACHE_SIZE |
Modifier and Type | Method and Description |
---|---|
void |
add(K attrVal,
ID id) |
void |
close() |
int |
count()
Gets the total scan count for this index.
|
int |
count(K attrVal)
Gets the scan count for the occurance of a specific attribute value
within the index.
|
void |
drop(ID entryId)
Remove all the reference to an entry from the index.
|
void |
drop(K attrVal,
ID id) |
boolean |
forward(K attrVal) |
boolean |
forward(K attrVal,
ID id) |
IndexCursor<K,O,ID> |
forwardCursor() |
IndexCursor<K,O,ID> |
forwardCursor(K key) |
boolean |
forwardGreaterOrEq(K attrVal) |
boolean |
forwardGreaterOrEq(K attrVal,
ID id) |
boolean |
forwardLessOrEq(K attrVal) |
boolean |
forwardLessOrEq(K attrVal,
ID id) |
ID |
forwardLookup(K attrVal) |
org.apache.directory.shared.ldap.cursor.Cursor<ID> |
forwardValueCursor(K key) |
org.apache.directory.shared.ldap.schema.AttributeType |
getAttribute()
Gets the attribute this Index is built upon.
|
String |
getAttributeId()
Gets the attribute identifier set at configuration time for this index which may not
be the OID but an alias name for the attributeType associated with this Index
|
int |
getCacheSize()
Gets the size of the index cache in terms of the number of index entries to be cached.
|
K |
getNormalized(K attrVal)
Gets the normalized value for an attribute.
|
File |
getWkDirPath()
Gets the working directory path to something other than the default.
|
int |
greaterThanCount(K attrVal) |
boolean |
isCountExact()
Checks whether or not calls to count the number of keys greater than or
less than the key are exact.
|
int |
lessThanCount(K attrVal) |
boolean |
reverse(ID id) |
boolean |
reverse(ID id,
K attrVal) |
IndexCursor<K,O,ID> |
reverseCursor() |
IndexCursor<K,O,ID> |
reverseCursor(ID id) |
boolean |
reverseGreaterOrEq(ID id) |
boolean |
reverseGreaterOrEq(ID id,
K attrVal) |
boolean |
reverseLessOrEq(ID id) |
boolean |
reverseLessOrEq(ID id,
K attrVal) |
K |
reverseLookup(ID id) |
org.apache.directory.shared.ldap.cursor.Cursor<K> |
reverseValueCursor(ID id) |
void |
setAttributeId(String attributeId)
Sets the attribute identifier set at configuration time for this index which may not
be the OID but an alias name for the attributeType associated with this Index
|
void |
setCacheSize(int cacheSize)
Sets the size of the index cache in terms of the number of index entries to be cached.
|
void |
setWkDirPath(File wkDirPath)
Sets the working directory path to something other than the default.
|
void |
sync() |
static final int DEFAULT_INDEX_CACHE_SIZE
String getAttributeId()
void setAttributeId(String attributeId)
attributeId
- configured attribute oid or alias nameint getCacheSize()
void setCacheSize(int cacheSize)
cacheSize
- the size of the index cachevoid setWkDirPath(File wkDirPath)
wkDirPath
- optional working directory pathFile getWkDirPath()
boolean isCountExact()
org.apache.directory.shared.ldap.schema.AttributeType getAttribute()
K getNormalized(K attrVal) throws Exception
attrVal
- the user provided value to normalizeException
- if something goes wrong.int count() throws Exception
Exception
- on failure to access index db filesint count(K attrVal) throws Exception
attrVal
- the value of the attribute to get a scan count forException
- on failure to access index db filesvoid drop(ID entryId) throws Exception
entryId
- The master table entry ID to removeException
org.apache.directory.shared.ldap.cursor.Cursor<K> reverseValueCursor(ID id) throws Exception
Exception
org.apache.directory.shared.ldap.cursor.Cursor<ID> forwardValueCursor(K key) throws Exception
Exception
Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.