org.apache.directory.server.core.partition.impl.btree
Interface TupleComparator

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IndexComparator, KeyOnlyComparator

public interface TupleComparator
extends java.io.Serializable

Used to compare the sorting order of binary data.

Version:

$Rev: 434579 $

Author:

Apache Directory Project

Method Summary

int	compareKey(java.lang.Object key1, java.lang.Object key2) Compares key Object to determine their sorting order returning a value = to, < or > than 0.
int	compareValue(java.lang.Object value1, java.lang.Object value2) Comparse value Objects to determine their sorting order returning a value = to, < or > than 0.
SerializableComparator	getKeyComparator() Gets the comparator used to compare keys.
SerializableComparator	getValueComparator() Gets the binary comparator used to compare valuess.

Method Detail

getKeyComparator

SerializableComparator getKeyComparator()

Gets the comparator used to compare keys. May be null in which case the compareKey method will throw an UnsupportedOperationException.

Returns:

the comparator for comparing keys.

getValueComparator

SerializableComparator getValueComparator()

Gets the binary comparator used to compare valuess. May be null in which case the compareValue method will throw an UnsupportedOperationException.

Returns:

the binary comparator for comparing values.

compareKey

int compareKey(java.lang.Object key1,
               java.lang.Object key2)

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

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

int compareValue(java.lang.Object value1,
                 java.lang.Object value2)

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

Parameters:

value1 - the first value to compare

value2 - the other 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.