Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Interface ObjectTokenSequence<O>

Type Parameters:

O - the type of Java objects in the sequence

All Superinterfaces:

ObjectTyped<O>, ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableObjectTokenSequence<O>

All Known Implementing Classes:

ObjectTokenList, SparseObjectTokenList

public interface ObjectTokenSequence<O>
extends ScalarTokenSequence, ObjectTyped<O>

A TokenSequence containing object valued data.

See Also:

TokenTypeConstant#OBJECT(Class)

Method Summary

Modifier and Type	Method	Description
O	getObject(int index)	Gets the value of the specified token as an object.
ObjectValued<O>	getToken(int index)	Gets the value at the specified position.
ObjectTokenType<O>	getType()	Gets the data type of the tokens in the sequence.
void	getValues(int start, O[] values, boolean[] nulls, int offset, int length)	Gets the values and null indicators for a range of tokens.
ObjectValuedIterator<O>	newValueIterator()	Creates an iterator over the non-null values of this sequence.

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

isNull, isZero

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

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

Method Detail

getToken

ObjectValued<O> 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

getType

ObjectTokenType<O> getType()

Description copied from interface: ScalarTokenSequence

Gets the data type of the tokens in the sequence.

Specified by:

getType in interface ObjectTyped<O>

Specified by:

getType in interface ScalarTokenSequence

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

Returns:

the token data type

getObject

O getObject(int index)

Gets the value of the specified token as an object.

This is a reference to the object representing the value. If the object is mutable, changing it modifies the value of the token in the sequence.

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

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

References to the objects representing the token values are returned. If these objects are mutable, changing any modifies the values of the tokens in the sequence.

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

ObjectValuedIterator<O> 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.