|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.xdbm.GenericIndex<K,O,ID>
public class GenericIndex<K,O,ID>
A generic index implementation that is just used to hold the index configuration parameters (attributeId, cacheSize, wkDirPath). All other methods are not working.
Field Summary | |
---|---|
protected java.lang.String |
attributeId
|
protected int |
cacheSize
|
protected java.io.File |
wkDirPath
|
Fields inherited from interface org.apache.directory.server.xdbm.Index |
---|
DEFAULT_INDEX_CACHE_SIZE |
Constructor Summary | |
---|---|
GenericIndex(java.lang.String attributeId,
int cacheSize)
Creates a new instance of GenericIndex. |
|
GenericIndex(java.lang.String attributeId,
int cacheSize,
java.io.File wkDirPath)
Creates a new instance of GenericIndex. |
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 id)
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()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String attributeId
protected int cacheSize
protected java.io.File wkDirPath
Constructor Detail |
---|
public GenericIndex(java.lang.String attributeId, int cacheSize)
attributeId
- the attribute IDcacheSize
- the cache sizepublic GenericIndex(java.lang.String attributeId, int cacheSize, java.io.File wkDirPath)
attributeId
- the attribute IDcacheSize
- the cache sizewkDirPath
- the working directoryMethod Detail |
---|
public void add(K attrVal, ID id) throws java.lang.Exception
add
in interface Index<K,O,ID>
java.lang.Exception
public void close() throws java.lang.Exception
close
in interface Index<K,O,ID>
java.lang.Exception
public int count() throws java.lang.Exception
Index
count
in interface Index<K,O,ID>
java.lang.Exception
- on failure to access index db filespublic int count(K attrVal) throws java.lang.Exception
Index
count
in interface Index<K,O,ID>
attrVal
- the value of the attribute to get a scan count for
java.lang.Exception
- on failure to access index db filespublic void drop(ID id) throws java.lang.Exception
Index
drop
in interface Index<K,O,ID>
id
- The master table entry ID to remove
java.lang.Exception
public void drop(K attrVal, ID id) throws java.lang.Exception
drop
in interface Index<K,O,ID>
java.lang.Exception
public IndexCursor<K,O,ID> forwardCursor() throws java.lang.Exception
forwardCursor
in interface Index<K,O,ID>
java.lang.Exception
public IndexCursor<K,O,ID> forwardCursor(K key) throws java.lang.Exception
forwardCursor
in interface Index<K,O,ID>
java.lang.Exception
public ID forwardLookup(K attrVal) throws java.lang.Exception
forwardLookup
in interface Index<K,O,ID>
java.lang.Exception
public org.apache.directory.shared.ldap.cursor.Cursor<ID> forwardValueCursor(K key) throws java.lang.Exception
forwardValueCursor
in interface Index<K,O,ID>
java.lang.Exception
public boolean forward(K attrVal) throws java.lang.Exception
forward
in interface Index<K,O,ID>
java.lang.Exception
public boolean forward(K attrVal, ID id) throws java.lang.Exception
forward
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverse(ID id) throws java.lang.Exception
reverse
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverse(ID id, K attrVal) throws java.lang.Exception
reverse
in interface Index<K,O,ID>
java.lang.Exception
public boolean forwardGreaterOrEq(K attrVal) throws java.lang.Exception
forwardGreaterOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean forwardGreaterOrEq(K attrVal, ID id) throws java.lang.Exception
forwardGreaterOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverseGreaterOrEq(ID id) throws java.lang.Exception
reverseGreaterOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverseGreaterOrEq(ID id, K attrVal) throws java.lang.Exception
reverseGreaterOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean forwardLessOrEq(K attrVal) throws java.lang.Exception
forwardLessOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean forwardLessOrEq(K attrVal, ID id) throws java.lang.Exception
forwardLessOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverseLessOrEq(ID id) throws java.lang.Exception
reverseLessOrEq
in interface Index<K,O,ID>
java.lang.Exception
public boolean reverseLessOrEq(ID id, K attrVal) throws java.lang.Exception
reverseLessOrEq
in interface Index<K,O,ID>
java.lang.Exception
public org.apache.directory.shared.ldap.schema.AttributeType getAttribute()
Index
getAttribute
in interface Index<K,O,ID>
public java.lang.String getAttributeId()
Index
getAttributeId
in interface Index<K,O,ID>
public int getCacheSize()
Index
getCacheSize
in interface Index<K,O,ID>
public K getNormalized(K attrVal) throws java.lang.Exception
Index
getNormalized
in interface Index<K,O,ID>
attrVal
- the user provided value to normalize
java.lang.Exception
- if something goes wrong.public java.io.File getWkDirPath()
Index
getWkDirPath
in interface Index<K,O,ID>
public int greaterThanCount(K attrVal) throws java.lang.Exception
greaterThanCount
in interface Index<K,O,ID>
java.lang.Exception
public boolean isCountExact()
Index
isCountExact
in interface Index<K,O,ID>
public int lessThanCount(K attrVal) throws java.lang.Exception
lessThanCount
in interface Index<K,O,ID>
java.lang.Exception
public IndexCursor<K,O,ID> reverseCursor() throws java.lang.Exception
reverseCursor
in interface Index<K,O,ID>
java.lang.Exception
public IndexCursor<K,O,ID> reverseCursor(ID id) throws java.lang.Exception
reverseCursor
in interface Index<K,O,ID>
java.lang.Exception
public K reverseLookup(ID id) throws java.lang.Exception
reverseLookup
in interface Index<K,O,ID>
java.lang.Exception
public org.apache.directory.shared.ldap.cursor.Cursor<K> reverseValueCursor(ID id) throws java.lang.Exception
reverseValueCursor
in interface Index<K,O,ID>
java.lang.Exception
public void setAttributeId(java.lang.String attributeId)
Index
setAttributeId
in interface Index<K,O,ID>
attributeId
- configured attribute oid or alias namepublic void setCacheSize(int cacheSize)
Index
setCacheSize
in interface Index<K,O,ID>
cacheSize
- the size of the index cachepublic void setWkDirPath(java.io.File wkDirPath)
Index
setWkDirPath
in interface Index<K,O,ID>
wkDirPath
- optional working directory pathpublic void sync() throws java.lang.Exception
sync
in interface Index<K,O,ID>
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |