Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Interface NumericTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

DoubleTokenSequence, FloatTokenSequence, IntTokenSequence, LongTokenSequence, MoneyTokenSequence, MutableDoubleTokenSequence, MutableFloatTokenSequence, MutableIntTokenSequence, MutableLongTokenSequence, MutableMoneyTokenSequence, MutableNumericTokenSequence

All Known Implementing Classes:

DoubleTokenList, FloatTokenList, IntTokenList, LongTokenList, MoneyTokenList, NumericTokenList, SparseDoubleTokenList, SparseFloatTokenList, SparseIntTokenList, SparseLongTokenList, SparseMoneyTokenList, SparseNumericTokenList

public interface NumericTokenSequence
extends ScalarTokenSequence

A TokenSequence containing numeric valued data.

See Also:

TokenTypeConstant#NUMERIC

Method Summary

Modifier and Type	Method	Description
BigDecimal	getBigDecimal(int index)	Gets the value of the specified token as a BigDecimal.
NumericValued	getToken(int index)	Gets the value at the specified position.
void	getValues(int start, BigDecimal[] values, boolean[] nulls, int offset, int length)	Gets the values and null indicators for a range of tokens as BigDecimal objects.
NumericValuedIterator	newValueIterator()	Creates an iterator over the non-null values of this sequence.

Methods inherited from interface com.pervasive.datarush.sequences.scalar.ScalarTokenSequence

getType, isNull, isZero

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

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

Method Detail

getToken

NumericValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface ScalarTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getBigDecimal

BigDecimal getBigDecimal(int index)

Gets the value of the specified token as a BigDecimal.

Parameters:

index - the position of the token in the sequence

Returns:

the value of the token. If the token is null valued, null is returned.

getValues

void getValues(int start,
               BigDecimal[] values,
               boolean[] nulls,
               int offset,
               int length)

Gets the values and null indicators for a range of tokens as BigDecimal objects.

Parameters:

start - the starting index of the range

values - an array into which to place element values

nulls - an array into which to place null indicator values

offset - the starting offset into the target arrays. That is, elements[offset] and nulls[offset] will get the value and null indicator respectively of the token at position start, and so on.

length - number of tokens to get

newValueIterator

NumericValuedIterator 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 ScalarTokenSequence

Specified by:

newValueIterator in interface TokenSequence

Returns:

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