com.pervasive.datarush.sequences.scalar

Interface StringTokenSequence

All Superinterfaces:

ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableStringTokenSequence

All Known Implementing Classes:

SparseStringTokenList, StringTokenList

public interface StringTokenSequence
extends ScalarTokenSequence

A TokenSequence containing string valued data.

See Also:

TokenTypeConstant.STRING

Method Summary

Methods

Modifier and Type	Method and Description
String	getString(int index) Gets the value of the specified element as a string.
StringValued	getToken(int index) Gets the value at the specified position.
void	getValues(int start, String[] values, boolean[] nulls, int offset, int length) Gets the values and null indicators for a range of tokens.
StringValuedIterator	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

StringValued 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

getString

String getString(int index)

Gets the value of the specified element as a string.

Parameters:

index - the position of the token in the sequence

Returns:

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

getValues

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

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

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