Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Interface TimeTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableTimeTokenSequence

All Known Implementing Classes:

SparseTimeTokenList, TimeTokenList

public interface TimeTokenSequence
extends ScalarTokenSequence

A TokenSequence containing time valued data.

See Also:

TokenTypeConstant#TIME

Method Summary

Modifier and Type	Method	Description
int	getDayMillis(int index)	Get the value of the specified token as the number of milliseconds elapsed since midnight.
TimeOfDay	getTimeOfDay(int index)	Gets the value of the specified token as a time of day.
TimeValued	getToken(int index)	Gets the value at the specified position.
void	getValues(int start, int[] values, boolean[] nulls, int offset, int length)	Gets the values and null indicators for a range of tokens.
TimeValuedIterator	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

TimeValued 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

getDayMillis

int getDayMillis(int index)

Get the value of the specified token as the number of milliseconds elapsed since midnight.

Parameters:

index - the index of the token

Returns:

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

getTimeOfDay

TimeOfDay getTimeOfDay(int index)

Gets the value of the specified token as a time of day.

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,
               int[] values,
               boolean[] nulls,
               int offset,
               int length)

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

Parameters:

start - the starting index of the range

values - an array into which to place element values, represented as milliseconds since midnight

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

See Also:

#getEpochDays(int)

newValueIterator

TimeValuedIterator 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.