com.pervasive.datarush.sequences

Interface TokenSequence

All Superinterfaces:

TokenTyped

All Known Subinterfaces:

BinaryTokenSequence, BooleanTokenSequence, CharTokenSequence, DateTokenSequence, DoubleTokenSequence, FloatTokenSequence, IntTokenSequence, LongTokenSequence, MutableBinaryTokenSequence, MutableBooleanTokenSequence, MutableCharTokenSequence, MutableDateTokenSequence, MutableDoubleTokenSequence, MutableFloatTokenSequence, MutableIntTokenSequence, MutableLongTokenSequence, MutableNumericTokenSequence, MutableObjectTokenSequence<O>, MutableRecordTokenSequence, MutableScalarTokenSequence, MutableStringTokenSequence, MutableTimestampTokenSequence, MutableTimeTokenSequence, MutableTokenSequence, NumericTokenSequence, ObjectTokenSequence<O>, RecordTokenSequence, ScalarTokenSequence, StringTokenSequence, TimestampTokenSequence, TimeTokenSequence

All Known Implementing Classes:

AbstractScalarTokenSequence, BinaryTokenList, BooleanTokenList, CharTokenList, CompositeTokenSequence, DateTokenList, DoubleTokenList, FloatTokenList, IntTokenList, LongTokenList, NumericTokenList, ObjectTokenList, RecordTokenList, SparseBinaryTokenList, SparseBooleanTokenList, SparseCharTokenList, SparseDateTokenList, SparseDoubleTokenList, SparseFloatTokenList, SparseIntTokenList, SparseLongTokenList, SparseNumericTokenList, SparseObjectTokenList, SparseRecordTokenList, SparseStringTokenList, SparseTimestampTokenList, SparseTimeTokenList, StringTokenList, TimestampTokenList, TimeTokenList

public interface TokenSequence
extends TokenTyped

A random-access, read-only view of a sequence of data tokens of homogeneous type. Sequences are zero-indexed, just as Java arrays are.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareElement(int index, TokenValued value) Compares the value of the specified token to the token at which the given port is positioned.
int	compareElements(int lhsIndex, int rhsIndex) Compares the values of the tokens at the specified positions.
ElementComparator	getElementComparator(TokenOrder sortOrder) Gets an ElementComparator for this sequence using the specified ordering.
TokenValued	getToken(int index) Gets the value at the specified position.
int	hashCode(int index) Gets the hash code for the token at the specified position.
boolean	isNull(int index) Indicates whether the specified token has a null value.
TokenValuedIterator	newValueIterator() Creates an iterator over the non-null values of this sequence.
int	size() Gets the length of the sequence.
String	toString(int index) Gets the string representation of the token at the specified position.

Methods inherited from interface com.pervasive.datarush.types.TokenTyped

getType

Method Detail

size

int size()

Gets the length of the sequence.

Returns:

the number of tokens in the sequence.

isNull

boolean isNull(int index)

Indicates whether the specified token has a null value.

Parameters:

index - the index of the token

Returns:

true if the element is null, false otherwise

compareElement

int compareElement(int index,
                 TokenValued value)

Compares the value of the specified token to the token at which the given port is positioned.

Parameters:

index - the index of the token

value - the input port positioned at the token for comparison

Returns:

0 if the values are equal, 1 if the sequence token value is greater, -1 if the sequence token value is lesser. A null value is greater than any other non-null; two null values compare as equal.

compareElements

int compareElements(int lhsIndex,
                  int rhsIndex)

Compares the values of the tokens at the specified positions.

Parameters:

lhsIndex - the index of the left-hand element

rhsIndex - the index of the right-hand element

Returns:

0 if the values are equal, 1 if the left hand value is greater, -1 if the left hand value is lesser. A null value is greater than any other non-null; two null values compare as equal.

getElementComparator

ElementComparator getElementComparator(TokenOrder sortOrder)

Gets an ElementComparator for this sequence using the specified ordering.

Parameters:

sortOrder - the desired ordering

Returns:

an ElementComparator for this sequence.

getToken

TokenValued getToken(int index)

Gets the value at the specified position.

Parameters:

index - the index of the token

Returns:

the value

hashCode

int hashCode(int index)

Gets the hash code for the token at the specified position.

Parameters:

index - the index of the token

Returns:

the hash code for the token

toString

String toString(int index)

Gets the string representation of the token at the specified position.

Parameters:

index - the index of the token

Returns:

the string representation of the token

newValueIterator

TokenValuedIterator newValueIterator()

Creates an iterator over the non-null values of this sequence. The iterator will automatically be reset as modifications are made to the sequence.

Returns:

an newly-created iterator over the non-null values of this sequence.