org.apache.directory.server.xdbm.impl.avl

Class AvlIndex<K>

java.lang.Object

org.apache.directory.server.xdbm.AbstractIndex<K,String>

org.apache.directory.server.xdbm.impl.avl.AvlIndex<K>

All Implemented Interfaces:

Index<K,String>

Direct Known Subclasses:

AvlRdnIndex

public class AvlIndex<K>
extends AbstractIndex<K,String>

An Index backed by an AVL Tree.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected AvlTable<K,String>	forward
protected org.apache.directory.api.ldap.model.schema.Normalizer	normalizer
protected AvlTable<String,K>	reverse

Fields inherited from class org.apache.directory.server.xdbm.AbstractIndex

attributeId, attributeType, cacheSize, commitNumber, initialized, withReverse

Fields inherited from interface org.apache.directory.server.xdbm.Index

DEFAULT_INDEX_CACHE_SIZE

Constructor Summary

Constructors

Constructor and Description
AvlIndex()
AvlIndex(String attributeId)
AvlIndex(String attributeId, boolean withReverse)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(K attrVal, String id) Add an entry into the index, associated with the element ID.
void	close()
long	count() Gets the total scan count for this index.
long	count(K attrVal) Gets the scan count for the occurrence of a specific attribute value within the index.
void	drop(K attrVal, String id) Remove the pair from the index for the given value and id.
void	drop(String id) Remove all the reference to an entry from the index.
boolean	forward(K attrVal)
boolean	forward(K attrVal, String id)
org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>	forwardCursor()
org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>	forwardCursor(K key)
String	forwardLookup(K attrVal)
org.apache.directory.api.ldap.model.cursor.Cursor<String>	forwardValueCursor(K key)
URI	getWkDirPath() this method always returns null for AvlIndex cause this is a in-memory index.
long	greaterThanCount(K attrVal)
void	init(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
boolean	isDupsEnabled() tells whether the Index implementation supports storing duplicate keys
long	lessThanCount(K attrVal)
boolean	reverse(String id)
boolean	reverse(String id, K attrVal)
org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>	reverseCursor()
org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>	reverseCursor(String id)
K	reverseLookup(String id)
org.apache.directory.api.ldap.model.cursor.Cursor<K>	reverseValueCursor(String id)
void	setWkDirPath(URI wkDirPath) throws UnsupportedOperationException cause it is a in-memory index
void	sync()

Methods inherited from class org.apache.directory.server.xdbm.AbstractIndex

getAttribute, getAttributeId, getCacheSize, hasReverse, protect, setAttributeId, setCacheSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

normalizer

protected org.apache.directory.api.ldap.model.schema.Normalizer normalizer

forward

protected AvlTable<K,String> forward

reverse

protected AvlTable<String,K> reverse

Constructor Detail

AvlIndex

public AvlIndex()

AvlIndex

public AvlIndex(String attributeId)

AvlIndex

public AvlIndex(String attributeId,
        boolean withReverse)

Method Detail

init

public void init(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
        org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
          throws Exception

Throws:

Exception

add

public void add(K attrVal,
       String id)
         throws Exception

Description copied from interface: Index

Add an entry into the index, associated with the element ID. The added value is the key to retrieve the element having the given ID.

Parameters:

attrVal - The added value

id - The element ID pointed by the added value

Throws:

Exception - If the addition can't be done

close

public void close()
           throws Exception

Throws:

Exception

count

public long count()
           throws Exception

Gets the total scan count for this index.

Returns:

the number of key/value pairs in this index

Throws:

Exception - on failure to access index db files

count

public long count(K attrVal)
           throws Exception

Gets the scan count for the occurrence of a specific attribute value within the index.

Parameters:

attrVal - the value of the attribute to get a scan count for

Returns:

the number of key/value pairs in this index with the value value

Throws:

Exception - on failure to access index db files

drop

public void drop(String id)
          throws Exception

Remove all the reference to an entry from the index.
As an entry might be referenced more than once in the forward index, depending on which index we are dealing with, we need to iterate over all the values contained into the reverse index for this entryId.
For instance, considering the ObjectClass index for an entry having three ObjectClasses (top, person, inetOrgPerson), then the reverse index will contain :

 [entryId, [top, person, inetOrgPerson]]
 

and the forward index will contain many entries like :

 [top, [..., entryId, ...]]
 [person,  [..., entryId, ...]]
 [inetOrgPerson,  [..., entryId, ...]]
 

So dropping the entryId means that we must first get all the values from the reverse index (and we will get [top, person, inetOrgPerson]) then to iterate through all those values to remove entryId from the associated list of entryIds.

Parameters:

id - The master table entry ID to remove

Throws:

Exception

drop

public void drop(K attrVal,
        String id)
          throws Exception

Remove the pair from the index for the given value and id.

Parameters:

attrVal - The value we want to remove from the index

id - The associated ID

Throws:

Exception - If the removal can't be done

forward

public boolean forward(K attrVal)
                throws Exception

Throws:

Exception

forward

public boolean forward(K attrVal,
              String id)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

forwardCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>> forwardCursor()
                                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

forwardCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>> forwardCursor(K key)
                                                                                      throws Exception

Throws:

Exception

forwardLookup

public String forwardLookup(K attrVal)
                     throws Exception

Throws:

Exception

forwardValueCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<String> forwardValueCursor(K key)
                                                                             throws Exception

Throws:

Exception

greaterThanCount

public long greaterThanCount(K attrVal)
                      throws Exception

Throws:

Exception

lessThanCount

public long lessThanCount(K attrVal)
                   throws Exception

Throws:

Exception

reverse

public boolean reverse(String id)
                throws Exception

Throws:

Exception

reverse

public boolean reverse(String id,
              K attrVal)
                throws Exception

Throws:

Exception

reverseCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>> reverseCursor()
                                                                                      throws Exception

Throws:

Exception

reverseCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>> reverseCursor(String id)
                                                                                      throws Exception

Throws:

Exception

reverseLookup

public K reverseLookup(String id)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

reverseValueCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<K> reverseValueCursor(String id)
                                                                        throws Exception

Throws:

Exception

setWkDirPath

public void setWkDirPath(URI wkDirPath)

throws UnsupportedOperationException cause it is a in-memory index

Parameters:

wkDirPath - optional working directory path

getWkDirPath

public URI getWkDirPath()

this method always returns null for AvlIndex cause this is a in-memory index.

Returns:

optional working directory path

isDupsEnabled

public boolean isDupsEnabled()

tells whether the Index implementation supports storing duplicate keys

Specified by:

isDupsEnabled in interface Index<K,String>

Overrides:

isDupsEnabled in class AbstractIndex<K,String>

Returns:

true if duplicate keys are allowed false otherwise

sync

public void sync()
          throws Exception

Throws:

Exception