com.bigdata.striterator
Interface IKeyOrder<E>

Type Parameters:

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

All Known Implementing Classes:

LexiconKeyOrder, MagicKeyOrder, SPOKeyOrder

public interface IKeyOrder<E>

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

Version:

$Id: IKeyOrder.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

Method Summary

Comparator<E>	getComparator() Return the comparator that places elements into the natural order for the associated index.
String	getIndexName() The base name for the index.
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.

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.