Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Interface PeriodTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutablePeriodTokenSequence

All Known Implementing Classes:

PeriodTokenList, SparsePeriodTokenList

public interface PeriodTokenSequence
extends ScalarTokenSequence

A TokenSequence containing period valued data.

See Also:

TokenTypeConstant#PERIOD

Method Summary

Modifier and Type	Method	Description
int	getDays(int index)	Gets the day portion of the value of the specified token.
int	getMonths(int index)	Gets the month portion of the value of the specified token.
Period	getPeriod(int index)	Gets the value of the specified token as a period.
PeriodValued	getToken(int index)	Gets the value at the specified position.
void	getValues(int start, int[] yearValues, int[] monthValues, int[] dayValues, boolean[] nulls, int offset, int length)	Gets the values and null indicators for a range of tokens.
int	getYears(int index)	Gets the year portion of the value of the specified token.
PeriodValuedIterator	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

PeriodValued 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

getPeriod

Period getPeriod(int index)

Gets the value of the specified token as a period.

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.

getYears

int getYears(int index)

Gets the year portion of the value of the specified token.

Parameters:

index - the position of the token in the sequence

Returns:

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

getMonths

int getMonths(int index)

Gets the month portion of the value of the specified token.

Parameters:

index - the position of the token in the sequence

Returns:

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

getDays

int getDays(int index)

Gets the day portion of the value of the specified token.

Parameters:

index - the position of the token in the sequence

Returns:

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

getValues

void getValues(int start,
               int[] yearValues,
               int[] monthValues,
               int[] dayValues,
               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

yearValues - an array into which to place the year values of elements

monthValues - an array into which to place the month values of elements

dayValues - an array into which to place the day 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

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