org.apache.directory.server.core.partition.impl.btree.mavibot

Class MavibotIndex<K>

java.lang.Object

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

org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotIndex<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

MavibotDnIndex, MavibotRdnIndex

public class MavibotIndex<K>
extends org.apache.directory.server.xdbm.AbstractIndex<K,String>

A Mavibot based index implementation. It creates an Index for a give AttributeType.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected MavibotTable<K,String>	forward the forward btree where the btree key is the value of the indexed attribute and the value of the btree is the entry id of the entry containing an attribute with that value
static String	FORWARD_BTREE the key used for the forward btree name
protected org.apache.directory.mavibot.btree.RecordManager	recordMan
protected MavibotTable<String,K>	reverse the reverse btree where the btree key is the entry id of the entry containing a value for the indexed attribute, and the btree value is the value of the indexed attribute
static String	REVERSE_BTREE the key used for the reverse btree name
protected File	wkDirPath a custom working directory path when specified in configuration

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
MavibotIndex(String attributeId, boolean withReverse) Creates a JdbmIndex instance for a give AttributeId

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal, String id)
void	close(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
long	count(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
long	count(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal)
void	drop(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal, String id)
void	drop(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, String entryId)
boolean	forward(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal)
boolean	forward(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal, String id)
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.server.xdbm.IndexEntry<K,String>>	forwardCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.server.xdbm.IndexEntry<K,String>>	forwardCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K key)
String	forwardLookup(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal) Do a lookup using the forward table
org.apache.directory.api.ldap.model.cursor.Cursor<String>	forwardValueCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K key)
URI	getWkDirPath() Gets the working directory path to something other than the default.
long	greaterThanCount(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal)
void	init(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Initialize the index for an Attribute, with a specific working directory (may be null).
boolean	isDupsEnabled()
long	lessThanCount(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K attrVal)
boolean	reverse(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, String id)
boolean	reverse(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, String id, K attrVal)
K	reverseLookup(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, String id)
org.apache.directory.api.ldap.model.cursor.Cursor<K>	reverseValueCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, String id)
void	setRecordManager(org.apache.directory.mavibot.btree.RecordManager rm) Sets the RecordManager
void	setWkDirPath(URI wkDirPath) Sets the working directory path to something other than the default.
void	sync() Force the flush of this index
String	toString()

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, wait, wait, wait

Field Detail

FORWARD_BTREE

public static final String FORWARD_BTREE

the key used for the forward btree name

See Also:

Constant Field Values

REVERSE_BTREE

public static final String REVERSE_BTREE

the key used for the reverse btree name

See Also:

Constant Field Values

forward

protected MavibotTable<K,String> forward

the forward btree where the btree key is the value of the indexed attribute and the value of the btree is the entry id of the entry containing an attribute with that value

reverse

protected MavibotTable<String,K> reverse

the reverse btree where the btree key is the entry id of the entry containing a value for the indexed attribute, and the btree value is the value of the indexed attribute

wkDirPath

protected File wkDirPath

a custom working directory path when specified in configuration

recordMan

protected org.apache.directory.mavibot.btree.RecordManager recordMan

Constructor Detail

MavibotIndex

public MavibotIndex(String attributeId,
                    boolean withReverse)

Creates a JdbmIndex instance for a give AttributeId

Parameters:

attributeId - The Attribute ID

withReverse - If we want a reverse index to be created

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 org.apache.directory.api.ldap.model.exception.LdapException,
                 IOException

Initialize the index for an Attribute, with a specific working directory (may be null).

Parameters:

schemaManager - The schemaManager to use to get back the Attribute

attributeType - The attributeType this index is created for

Throws:

IOException - If the initialization failed

org.apache.directory.api.ldap.model.exception.LdapException - If the initialization failed

setRecordManager

public void setRecordManager(org.apache.directory.mavibot.btree.RecordManager rm)

Sets the RecordManager

Parameters:

rm - the RecordManager instance

setWkDirPath

public void setWkDirPath(URI wkDirPath)

Sets the working directory path to something other than the default. Sometimes more performance is gained by locating indices on separate disk spindles.

Parameters:

wkDirPath - optional working directory path

getWkDirPath

public URI getWkDirPath()

Gets the working directory path to something other than the default. Sometimes more performance is gained by locating indices on separate disk spindles.

Returns:

optional working directory path

count

public long count(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
           throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

count

public long count(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                  K attrVal)
           throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

greaterThanCount

public long greaterThanCount(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                             K attrVal)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

lessThanCount

public long lessThanCount(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                          K attrVal)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

forwardLookup

public String forwardLookup(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                            K attrVal)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Do a lookup using the forward table

Parameters:

partitionTxn - The Transaction to use

attrVal - The Key we are looking for

Returns:

The found value

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the lookup failed

reverseLookup

public K reverseLookup(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                       String id)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

add

public void add(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                K attrVal,
                String id)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

drop

public void drop(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                 K attrVal,
                 String id)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

drop

public void drop(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                 String entryId)
          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<org.apache.directory.server.xdbm.IndexEntry<K,String>> forwardCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
                                                                                                                       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<org.apache.directory.server.xdbm.IndexEntry<K,String>> forwardCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                                                                                                                              K key)
                                                                                                                       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(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                                                                               String id)
                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

forwardValueCursor

public org.apache.directory.api.ldap.model.cursor.Cursor<String> forwardValueCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                                                                                    K key)
                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

forward

public boolean forward(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                       K attrVal)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

forward

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

Throws:

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

reverse

public boolean reverse(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                       String id)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

reverse

public boolean reverse(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                       String id,
                       K attrVal)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

close

public void close(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn)
           throws IOException

Throws:

IOException

sync

public void sync()
          throws IOException

Force the flush of this index

Throws:

IOException - If the flush failed

isDupsEnabled

public boolean isDupsEnabled()

Specified by:

isDupsEnabled in interface org.apache.directory.server.xdbm.Index<K,String>

Overrides:

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

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()