com.pervasive.datarush.sequences.scalar

Interface DateTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableDateTokenSequence

All Known Implementing Classes:

DateTokenList, SparseDateTokenList

public interface DateTokenSequence
extends ScalarTokenSequence

A TokenSequence containing date valued data.

See Also:

TokenTypeConstant#DATE

Method Summary

Modifier and Type	Method and Description
CalendarDate	getCalendarDate(int index) Gets the value of the specified token as a calendar date.
Date	getDate(int index) Deprecated. since 6.1; use getCalendarDate(int) instead to obtain an object representation of the date
Date	getDate(int index, TimeZone tz) Deprecated. since 6.1; use getCalendarDate(int) instead to obtain an object representation of the date
long	getEpochDays(int index) Get the value of the specified token as the number of days elapsed since January 1, 1970 00:00:00 GMT.
DateValued	getToken(int index) Gets the value at the specified position.
void	getValues(int start, long[] values, boolean[] nulls, int offset, int length) Gets the values and null indicators for a range of tokens.
DateValuedIterator	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

DateValued 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

getDate

@Deprecated
Date getDate(int index)

Deprecated. since 6.1; use getCalendarDate(int) instead to obtain an object representation of the date

Gets the value of the specified token as a date.

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.

getDate

@Deprecated
Date getDate(int index,
                         TimeZone tz)

Deprecated. since 6.1; use getCalendarDate(int) instead to obtain an object representation of the date

Gets the value of the specified token as a date interpreted in the given timezone.

Parameters:

index - the index of the token

tz - the timezone relative to which to interpret the date.

Returns:

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

getEpochDays

long getEpochDays(int index)

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

Parameters:

index - the index of the token

Returns:

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

getCalendarDate

CalendarDate getCalendarDate(int index)

Gets the value of the specified token as a calendar date.

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,
               long[] 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 epoch days

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

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