org.apache.directory.server.xdbm

Class AbstractIndex<K,E>

java.lang.Object

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

All Implemented Interfaces:

Index<K,E>

Direct Known Subclasses:

AvlIndex, JdbmIndex, MavibotIndex

public abstract class AbstractIndex<K,E>
extends Object
implements Index<K,E>

A generic index implementation that is just used to hold the index configuration parameters (attributeId, cacheSize, wkDirPath). All other methods are not working.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeId The attribute identifier for this index
protected org.apache.directory.api.ldap.model.schema.AttributeType	attributeType the attribute type resolved for this JdbmIndex
protected int	cacheSize the size (number of index entries) for the cache
protected AtomicInteger	commitNumber A counter used to differ the commit on disk after N operations
protected boolean	initialized whether or not this index has been initialized
protected boolean	withReverse Tells if this index has a Reverse table

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

DEFAULT_INDEX_CACHE_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIndex() Creates a new instance of AbstractIndex.
protected	AbstractIndex(boolean withReverse) Creates a new instance of AbstractIndex.
protected	AbstractIndex(String attributeId, boolean withReverse) Creates a new instance of AbstractIndex.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.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.
boolean	hasReverse() Tells if the index has a reverse table or not
boolean	isDupsEnabled() tells whether the Index implementation supports storing duplicate keys
protected void	protect(String property) Protects configuration properties from being set after initialization.
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.

Methods inherited from class java.lang.Object

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

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

add, close, count, count, drop, drop, forward, forward, forwardCursor, forwardCursor, forwardLookup, forwardValueCursor, getWkDirPath, greaterThanCount, lessThanCount, reverse, reverse, reverseLookup, reverseValueCursor, setWkDirPath

Field Detail

attributeId

protected String attributeId

The attribute identifier for this index

attributeType

protected org.apache.directory.api.ldap.model.schema.AttributeType attributeType

the attribute type resolved for this JdbmIndex

cacheSize

protected int cacheSize

the size (number of index entries) for the cache

initialized

protected boolean initialized

whether or not this index has been initialized

withReverse

protected boolean withReverse

Tells if this index has a Reverse table

commitNumber

protected AtomicInteger commitNumber

A counter used to differ the commit on disk after N operations

Constructor Detail

AbstractIndex

protected AbstractIndex()

Creates a new instance of AbstractIndex.

AbstractIndex

protected AbstractIndex(boolean withReverse)

Creates a new instance of AbstractIndex.

Parameters:

withReverse - If we should create a reverse index

AbstractIndex

protected AbstractIndex(String attributeId,
                        boolean withReverse)

Creates a new instance of AbstractIndex.

Parameters:

attributeId - the attribute ID

withReverse - If we should create a reverse index

Method Detail

getAttributeId

public String getAttributeId()

Description copied from interface: Index

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

Specified by:

getAttributeId in interface Index<K,E>

Returns:

configured attribute oid or alias name

getAttribute

public org.apache.directory.api.ldap.model.schema.AttributeType getAttribute()

Gets the attribute this Index is built upon.

Specified by:

getAttribute in interface Index<K,E>

Returns:

the id of the Index's attribute

setAttributeId

public void setAttributeId(String attributeId)

Description copied from interface: Index

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

Specified by:

setAttributeId in interface Index<K,E>

Parameters:

attributeId - configured attribute oid or alias name

isDupsEnabled

public boolean isDupsEnabled()

tells whether the Index implementation supports storing duplicate keys

Specified by:

isDupsEnabled in interface Index<K,E>

Returns:

true if duplicate keys are allowed false otherwise

getCacheSize

public int getCacheSize()

Gets the size of the index cache in terms of the number of index entries to be cached.

Specified by:

getCacheSize in interface Index<K,E>

Returns:

the size of the index cache

setCacheSize

public void setCacheSize(int cacheSize)

Sets the size of the index cache in terms of the number of index entries to be cached.

Specified by:

setCacheSize in interface Index<K,E>

Parameters:

cacheSize - the size of the index cache

protect

protected void protect(String property)

Protects configuration properties from being set after initialization.

Parameters:

property - the property to protect

hasReverse

public boolean hasReverse()

Tells if the index has a reverse table or not

Specified by:

hasReverse in interface Index<K,E>

Returns:

true if the index has a reverse table