com.pervasive.datarush.sequences.scalar

Interface TimestampTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableTimestampTokenSequence

All Known Implementing Classes:

SparseTimestampTokenList, TimestampTokenList

public interface TimestampTokenSequence
extends ScalarTokenSequence

A TokenSequence containing timestamp valued data.

See Also:

TokenTypeConstant#TIMESTAMP

Method Summary

Modifier and Type	Method and Description
long	getEpochSeconds(int index) Gets the value of the specified token as the number of seconds elapsed since January 1, 1970 00:00:00 GMT.
int	getOffsetSeconds(int index) Gets the time zone plus daylight savings time offset (in seconds) of the timestamp value of the specified token.
int	getSubsecondNanos(int index) Gets the subsecond portion (in nanoseconds) of the timestamp value of the specified token.
Timestamp	getTimestamp(int index) Gets the value of the specified token as a timestamp.
TimestampValued	getToken(int index) Gets the value at the specified position.
void	getValues(int start, long[] secValues, int[] nanoValues, int[] offsetValues, boolean[] nulls, int offset, int length) Gets the values and null indicators for a range of tokens.
TimestampValuedIterator	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

TimestampValued 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

getTimestamp

Timestamp getTimestamp(int index)

Gets the value of the specified token as a timestamp.

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.

getEpochSeconds

long getEpochSeconds(int index)

Gets the value of the specified token as the number of seconds elapsed since January 1, 1970 00:00:00 GMT.

Parameters:

index - the position of the token in the sequence

Returns:

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

getSubsecondNanos

int getSubsecondNanos(int index)

Gets the subsecond portion (in nanoseconds) of the timestamp value of the specified token.

Parameters:

index - the position of the token in the sequence

Returns:

the subsecond portion of the value in nanoseconds. If the token is null valued, 0 is returned.

getOffsetSeconds

int getOffsetSeconds(int index)

Gets the time zone plus daylight savings time offset (in seconds) of the timestamp value of the specified token.

Parameters:

index - the position of the token in the sequence

Returns:

the time zone plus daylight savings time offset in seconds. If the token is null valued, 0 is returned.

getValues

void getValues(int start,
               long[] secValues,
               int[] nanoValues,
               int[] offsetValues,
               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

secValues - an array into which to place the epoch second values of elements

nanoValues - an array into which to place the subsecond values of elements

offsetValues - an array into which to place the offset seconds values of elements

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

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