|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Index<K,O,ID>
An index into the master table which returns one or more entry's positions in the master table for those entries which posses an attribute with the specified value. Cursors over indices can also be gotten to traverse the values of the index.
Field Summary | |
---|---|
static int |
DEFAULT_INDEX_CACHE_SIZE
|
Method Summary | |
---|---|
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. |
java.lang.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. |
java.io.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(java.lang.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(java.io.File wkDirPath)
Sets the working directory path to something other than the default. |
void |
sync()
|
Field Detail |
---|
static final int DEFAULT_INDEX_CACHE_SIZE
Method Detail |
---|
java.lang.String getAttributeId()
void setAttributeId(java.lang.String attributeId)
attributeId
- configured attribute oid or alias nameint getCacheSize()
void setCacheSize(int cacheSize)
cacheSize
- the size of the index cachevoid setWkDirPath(java.io.File wkDirPath)
wkDirPath
- optional working directory pathjava.io.File getWkDirPath()
boolean isCountExact()
org.apache.directory.shared.ldap.schema.AttributeType getAttribute()
K getNormalized(K attrVal) throws java.lang.Exception
attrVal
- the user provided value to normalize
java.lang.Exception
- if something goes wrong.int count() throws java.lang.Exception
java.lang.Exception
- on failure to access index db filesint count(K attrVal) throws java.lang.Exception
attrVal
- the value of the attribute to get a scan count for
java.lang.Exception
- on failure to access index db filesint greaterThanCount(K attrVal) throws java.lang.Exception
java.lang.Exception
int lessThanCount(K attrVal) throws java.lang.Exception
java.lang.Exception
ID forwardLookup(K attrVal) throws java.lang.Exception
java.lang.Exception
K reverseLookup(ID id) throws java.lang.Exception
java.lang.Exception
void add(K attrVal, ID id) throws java.lang.Exception
java.lang.Exception
void drop(ID entryId) throws java.lang.Exception
entryId
- The master table entry ID to remove
java.lang.Exception
void drop(K attrVal, ID id) throws java.lang.Exception
java.lang.Exception
IndexCursor<K,O,ID> reverseCursor() throws java.lang.Exception
java.lang.Exception
IndexCursor<K,O,ID> forwardCursor() throws java.lang.Exception
java.lang.Exception
IndexCursor<K,O,ID> reverseCursor(ID id) throws java.lang.Exception
java.lang.Exception
IndexCursor<K,O,ID> forwardCursor(K key) throws java.lang.Exception
java.lang.Exception
org.apache.directory.shared.ldap.cursor.Cursor<K> reverseValueCursor(ID id) throws java.lang.Exception
java.lang.Exception
org.apache.directory.shared.ldap.cursor.Cursor<ID> forwardValueCursor(K key) throws java.lang.Exception
java.lang.Exception
boolean forward(K attrVal) throws java.lang.Exception
java.lang.Exception
boolean forward(K attrVal, ID id) throws java.lang.Exception
java.lang.Exception
boolean reverse(ID id) throws java.lang.Exception
java.lang.Exception
boolean reverse(ID id, K attrVal) throws java.lang.Exception
java.lang.Exception
boolean forwardGreaterOrEq(K attrVal) throws java.lang.Exception
java.lang.Exception
boolean forwardGreaterOrEq(K attrVal, ID id) throws java.lang.Exception
java.lang.Exception
boolean reverseGreaterOrEq(ID id) throws java.lang.Exception
java.lang.Exception
boolean reverseGreaterOrEq(ID id, K attrVal) throws java.lang.Exception
java.lang.Exception
boolean forwardLessOrEq(K attrVal) throws java.lang.Exception
java.lang.Exception
boolean forwardLessOrEq(K attrVal, ID id) throws java.lang.Exception
java.lang.Exception
boolean reverseLessOrEq(ID id) throws java.lang.Exception
java.lang.Exception
boolean reverseLessOrEq(ID id, K attrVal) throws java.lang.Exception
java.lang.Exception
void close() throws java.lang.Exception
java.lang.Exception
void sync() throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |