com.pervasive.datarush.sequences.scalar

Interface ScalarTokenSequence

All Superinterfaces:

ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface ScalarTokenSequence
extends TokenSequence, ScalarTyped

A TokenSequence containing scalar typed tokens. The scalar token types are enumerated in TokenTypeConstant.

Method Summary

Methods

Modifier and Type	Method and Description
ScalarValued	getToken(int index) Gets the value at the specified position.
ScalarTokenType	getType() Gets the data type of the tokens in the sequence.
boolean	isNull() Returns whether all elements are null.
boolean	isZero(int index) Indicates whether the specified token has a zero value.
ScalarValuedIterator	newValueIterator() Creates an iterator over the non-null values of this sequence.

Methods inherited from interface com.pervasive.datarush.sequences.TokenSequence

compareElement, compareElements, getElementComparator, hashCode, isNull, size, toString

Method Detail

getType

ScalarTokenType getType()

Gets the data type of the tokens in the sequence.

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

Returns:

the token data type

getToken

ScalarValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

newValueIterator

ScalarValuedIterator newValueIterator()

Description copied from interface: TokenSequence

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

Specified by:

newValueIterator in interface TokenSequence

Returns:

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

isNull

boolean isNull()

Returns whether all elements are null.

Returns:

whether all elements are null.

isZero

boolean isZero(int index)

Indicates whether the specified token has a zero value.

Parameters:

index - the index of the token

Returns:

true if the element is zero, false otherwise