com.bigdata.striterator

Interface IKeyOrder<E>

Type Parameters:

E - The generic type of the elements in the relation.

All Known Implementing Classes:

AbstractKeyOrder, LexiconKeyOrder, R.KeyOrder, SPOKeyOrder

public interface IKeyOrder<E>

An interface representing the natural traversal orders for the different indices for some class of relation.

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
Comparator<E>	getComparator() Return the comparator that places elements into the natural order for the associated index.
byte[]	getFromKey(IKeyBuilder keyBuilder, IPredicate<E> predicate) Return the inclusive lower bound which would be used for a query against this IKeyOrder for the given IPredicate.
String	getIndexName() The base name for the index.
byte[]	getKey(IKeyBuilder keyBuilder, E element) Return the key for an element of the relation.
int	getKeyArity() Return the #of elements in the key for this natural order.
int	getKeyOrder(int keyPos) Return the index of the slot in the IPredicate which appears at the specified position in the key.
byte[]	getToKey(IKeyBuilder keyBuilder, IPredicate<E> predicate) Return the exclusive upper bound which would be used for a query against this IKeyOrder for the given IPredicate.

Method Detail

getKeyArity

int getKeyArity()

Return the #of elements in the key for this natural order.

getComparator

Comparator<E> getComparator()

Return the comparator that places elements into the natural order for the associated index.

getIndexName

String getIndexName()

The base name for the index.

getKeyOrder

int getKeyOrder(int keyPos)

Return the index of the slot in the IPredicate which appears at the specified position in the key.

Parameters:

keyPos - The index into the key that is being generated.

Returns:

The index of the slot in the IPredicate.

getKey

byte[] getKey(IKeyBuilder keyBuilder,
            E element)

Return the key for an element of the relation.

Parameters:

keyBuilder - The object which will be used to construct the key.

element - An element for the associated relation.

Returns:

The key for the index associated with this IKeyOrder.

getFromKey

byte[] getFromKey(IKeyBuilder keyBuilder,
                IPredicate<E> predicate)

Return the inclusive lower bound which would be used for a query against this IKeyOrder for the given IPredicate.

Parameters:

keyBuilder - The object which will be used to construct the key.

predicate - A predicate describing bound and unbound fields for the key.

Returns:

The key corresponding to the inclusive lower bound for a query against that IPredicate.

getToKey

byte[] getToKey(IKeyBuilder keyBuilder,
              IPredicate<E> predicate)

Return the exclusive upper bound which would be used for a query against this IKeyOrder for the given IPredicate.

Parameters:

keyBuilder - The object which will be used to construct the key.

predicate - A predicate describing bound and unbound fields for the key.

Returns:

The key corresponding to the exclusive upper bound for a query against that IPredicate.