org.apache.directory.server.core.partition.impl.btree
Class ForwardIndexComparator<K>

java.lang.Object
  org.apache.directory.server.core.partition.impl.btree.ForwardIndexComparator<K>

All Implemented Interfaces:

Serializable, TupleComparator<K,Long>

public class ForwardIndexComparator<K>
extends Object
implements TupleComparator<K,Long>

TupleComparator for index records.

Author:

Apache Directory Project

See Also:

Serialized Form

Constructor Summary

ForwardIndexComparator(org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<K> keyComparator)
Creates an IndexComparator.

Method Summary

int	compareKey(K key1, K key2) Compares key Object to determine their sorting order returning a value = to, < or > than 0.
int	compareValue(Long l1, Long l2) Comparse value Objects to determine their sorting order returning a value = to, < or > than 0.
org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<K>	getKeyComparator() Gets the comparator used to compare keys.
org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<Long>	getValueComparator() Gets the binary comparator used to compare values which are the indices into the master table.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardIndexComparator

public ForwardIndexComparator(org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<K> keyComparator)

Creates an IndexComparator.

Parameters:

keyComparator - the table comparator to use for keys

Method Detail

getKeyComparator

public org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<K> getKeyComparator()

Gets the comparator used to compare keys.

Specified by:

getKeyComparator in interface TupleComparator<K,Long>

Returns:

the comparator for comparing keys.

getValueComparator

public org.apache.directory.shared.ldap.model.schema.comparators.SerializableComparator<Long> getValueComparator()

Gets the binary comparator used to compare values which are the indices into the master table.

Specified by:

getValueComparator in interface TupleComparator<K,Long>

Returns:

the binary comparator for comparing values.

compareKey

public int compareKey(K key1,
                      K key2)

Compares key Object to determine their sorting order returning a value = to, < or > than 0.

Specified by:

compareKey in interface TupleComparator<K,Long>

Parameters:

key1 - the first key to compare

key2 - the other key to compare to the first

Returns:

0 if both are equal, a negative value less than 0 if the first is less than the second, or a postive value if the first is greater than the second byte array.

compareValue

public int compareValue(Long l1,
                        Long l2)

Comparse value Objects to determine their sorting order returning a value = to, < or > than 0.

Specified by:

compareValue in interface TupleComparator<K,Long>

Parameters:

l1 - the first Long value to compare

l2 - the other Long value to compare to the first

Returns:

0 if both are equal, a negative value less than 0 if the first is less than the second, or a postive value if the first is greater than the second Object.