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

Class JdbmIndex<K>

java.lang.Object

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

org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmIndex<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

JdbmDnIndex, JdbmRdnIndex

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

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

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DUPLICATE_LIMIT default duplicate limit before duplicate keys switch to using a btree for values
protected JdbmTable<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 int	numDupLimit duplicate limit before duplicate keys switch to using a btree for values
protected jdbm.RecordManager	recMan the JDBM record manager for the file containing this index
protected JdbmTable<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
JdbmIndex(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)
org.apache.directory.api.ldap.model.cursor.Cursor<String>	forwardValueCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, K key)
int	getNumDupLimit() Gets the threshold at which point duplicate keys use btree indirection to store their values.
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(jdbm.RecordManager recMan, 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	setNumDupLimit(int numDupLimit) Sets the threshold at which point duplicate keys use btree indirection to store their values.
void	setWkDirPath(URI wkDirPath) Sets the working directory path to something other than the default.
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

DEFAULT_DUPLICATE_LIMIT

public static final int DEFAULT_DUPLICATE_LIMIT

default duplicate limit before duplicate keys switch to using a btree for values

See Also:

Constant Field Values

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 JdbmTable<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 JdbmTable<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

recMan

protected jdbm.RecordManager recMan

the JDBM record manager for the file containing this index

numDupLimit

protected int numDupLimit

duplicate limit before duplicate keys switch to using a btree for values

wkDirPath

protected File wkDirPath

a custom working directory path when specified in configuration

Constructor Detail

JdbmIndex

public JdbmIndex(String attributeId,
                 boolean withReverse)

Creates a JdbmIndex instance for a give AttributeId

Parameters:

attributeId - The Attribute ID

withReverse - If we have to create a reverse index

Method Detail

init

public void init(jdbm.RecordManager recMan,
                 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:

recMan - The RecordManager

schemaManager - The schemaManager to use to get back the Attribute

attributeType - The attributeType this index is created for

Throws:

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

IOException - If the initialization failed

getNumDupLimit

public int getNumDupLimit()

Gets the threshold at which point duplicate keys use btree indirection to store their values.

Returns:

the threshold for storing a keys values in another btree

setNumDupLimit

public void setNumDupLimit(int numDupLimit)

Sets the threshold at which point duplicate keys use btree indirection to store their values.

Parameters:

numDupLimit - the threshold for storing a keys values in another btree

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

Throws:

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

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

Throws:

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

IOException

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()