org.apache.directory.server.xdbm

Class AbstractTable<K,V>

java.lang.Object

org.apache.directory.server.xdbm.AbstractTable<K,V>

Type Parameters:

K - The key

V - The stored value

All Implemented Interfaces:

Table<K,V>

Direct Known Subclasses:

AvlTable

public abstract class AbstractTable<K,V>
extends Object
implements Table<K,V>

A Abstract Table implementation aggregating the methods common with all the different Table implementation.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowsDuplicates whether or not this table allows for duplicates
protected AtomicInteger	commitNumber A counter used to differ the commit on disk after N operations
protected long	count the current count of Tuples in this Table
protected Comparator<K>	keyComparator a key comparator for the keys in this Table
protected String	name the name of this table
protected org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The global SchemaManager
protected Comparator<V>	valueComparator a value comparator for the values in this Table

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTable(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, String name, Comparator<K> keyComparator, Comparator<V> valueComparator) Create an instance of Table

Method Summary

Modifier and Type	Method and Description
long	count(org.apache.directory.server.core.api.partition.PartitionTxn transaction) Gets the count of the number of Tuples in this Table.
Comparator<K>	getKeyComparator() Gets the key comparator used by this Table: may be null if this Table was not initialized with one.
String	getName() Gets the name of this Table.
Comparator<V>	getValueComparator() Gets the value comparator used by this Table: may be null if this Table was not initialized with one.
long	greaterThanCount(org.apache.directory.server.core.api.partition.PartitionTxn transaction, K key) Gets the number of records greater than or equal to a key value.
boolean	isDupsEnabled() Checks to see if this Table has allows for duplicate keys (a.k.a.
long	lessThanCount(org.apache.directory.server.core.api.partition.PartitionTxn transaction, K key) Gets the number of records less than or equal to a key value.
String	toString()

Methods inherited from class java.lang.Object

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

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

close, count, cursor, cursor, get, has, has, hasGreaterOrEqual, hasGreaterOrEqual, hasLessOrEqual, hasLessOrEqual, put, remove, remove, valueCursor

Field Detail

name

protected final String name

the name of this table

schemaManager

protected org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The global SchemaManager

keyComparator

protected final Comparator<K> keyComparator

a key comparator for the keys in this Table

valueComparator

protected final Comparator<V> valueComparator

a value comparator for the values in this Table

count

protected long count

the current count of Tuples in this Table

allowsDuplicates

protected boolean allowsDuplicates

whether or not this table allows for duplicates

commitNumber

protected AtomicInteger commitNumber

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

Constructor Detail

AbstractTable

protected AbstractTable(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                        String name,
                        Comparator<K> keyComparator,
                        Comparator<V> valueComparator)

Create an instance of Table

Parameters:

schemaManager - The server schemaManager

name - the name of the table

keyComparator - a key comparator

valueComparator - a value comparator

Method Detail

getKeyComparator

public Comparator<K> getKeyComparator()

Gets the key comparator used by this Table: may be null if this Table was not initialized with one.

Specified by:

getKeyComparator in interface Table<K,V>

Returns:

the key comparator or null if this Table was not created with one.

getValueComparator

public Comparator<V> getValueComparator()

Gets the value comparator used by this Table: may be null if this Table was not initialized with one.

Specified by:

getValueComparator in interface Table<K,V>

Returns:

the value comparator or null if this Table was not created with one.

getName

public String getName()

Gets the name of this Table.

Specified by:

getName in interface Table<K,V>

Returns:

the name

count

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

Gets the count of the number of Tuples in this Table.

Specified by:

count in interface Table<K,V>

Parameters:

transaction - The transaction we are running in

Returns:

the number of records

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a failure to read the underlying Db

greaterThanCount

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

Gets the number of records greater than or equal to a key value. The specific key argument provided need not exist for this call to return a non-zero value.

Specified by:

greaterThanCount in interface Table<K,V>

Parameters:

transaction - The transaction we are running in

key - the key to use in comparisons

Returns:

the number of keys greater than or equal to the key

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a failure to read the underlying db

lessThanCount

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

Gets the number of records less than or equal to a key value. The specific key argument provided need not exist for this call to return a non-zero value.

Specified by:

lessThanCount in interface Table<K,V>

Parameters:

transaction - The transaction we are running in

key - the key to use in comparisons

Returns:

the number of keys less than or equal to the key

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a failure to read the underlying db

isDupsEnabled

public boolean isDupsEnabled()

Checks to see if this Table has allows for duplicate keys (a.k.a. multiple values for the same key).

Specified by:

isDupsEnabled in interface Table<K,V>

Returns:

true if duplicate keys are enabled, false otherwise

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()