com.pervasive.datarush.sequences.scalar

Class StringTokenList

java.lang.Object

com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

com.pervasive.datarush.sequences.scalar.StringTokenList

All Implemented Interfaces:

MutableTokenSequence, MutableScalarTokenSequence, MutableStringTokenSequence, ScalarTokenAppendable, ScalarTokenSequence, StringTokenSequence, TokenAppendable, TokenSequence, ScalarTyped, TokenTyped

public final class StringTokenList
extends AbstractScalarTokenSequence

Primary implementation of MutableStringTokenSequence.

See Also:

TokenTypeConstant#STRING

Constructor Summary

Constructors

Constructor and Description
StringTokenList(int capacity) Create a new array of string tokens with the specified number of elements.

Method Summary

Modifier and Type	Method and Description
void	append(String value) Appends the specified string to this sequence.
void	append(String value, int count) Appends the specified string to this sequence multiple times.
int	compareElement(int index, String value)
protected void	expandValueBuffers(int capacity)
void	fillString(int start, int length, String value) Sets the tokens in the specified subsequence to the given string value.
void	fillValue(int startIndex, int count, TokenValued value) Sets the tokens in the specified subsequence to the given value.
String	getString(int i) Gets the value of the specified element as a string.
StringValued	getToken(int index) Gets the value at the specified position.
StringSettable	getTokenSetter(int index) Returns a mutator for the given index.
ScalarTokenType	getType() Gets the data type of the tokens in the sequence.
void	getValues(int index, String[] values, boolean[] nullFlags, int offset, int length) Gets the values and null indicators for a range of tokens.
boolean	isZero(int index) Indicates whether the specified token has a zero value.
StringValuedIterator	newValueIterator() Creates an iterator over the non-null values of this sequence.
void	setNull(int index) Sets the token at the specified position to be null valued.
void	setNull(int start, int length) Sets the tokens in the specified subsequence to be null valued.
void	setString(int index, String value) Sets the token at the specified position to the given string value.
void	setValue(int position, TokenValued value) Sets the token at the specified position to the given value.
void	setValues(int startIndex, TokenSequence values, int offset, int length) Sets the tokens in the specified subsequence of the array to the corresponding values from a subsequence of the given source sequence.
void	setZero(int index) Sets the token at the specified position to be zero valued.
void	setZero(int start, int length) Sets the tokens in the specified subsequence to be zero valued.

Methods inherited from class com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

append, append, append, append, appendNull, appendNull, appendZero, appendZero, capacity, compareElement, compareElements, ensureCanonical, getElementComparator, getModificationCount, hashCode, isNull, isNull, map, remaining, reset, size, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

ensureCanonical, getModificationCount

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

isNull

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

appendNull, appendNull, appendZero, appendZero, reset

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

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

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

append, append, append, append

Constructor Detail

StringTokenList

public StringTokenList(int capacity)

Create a new array of string tokens with the specified number of elements. All elements in the array will initially be null valued.

Parameters:

capacity - the number of string tokens in the array

Method Detail

getString

public String getString(int i)

Description copied from interface: StringTokenSequence

Gets the value of the specified element as a string.

Parameters:

i - 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

public void getValues(int index,
                      String[] values,
                      boolean[] nullFlags,
                      int offset,
                      int length)

Description copied from interface: StringTokenSequence

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

Parameters:

index - the starting index of the range

values - an array into which to place element values

nullFlags - 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

setNull

public void setNull(int index)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to be null valued.

Parameters:

index - the position of the token in the array

setNull

public void setNull(int start,
                    int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to be null valued.

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

setZero

public void setZero(int index)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to be zero valued.

Parameters:

index - the position of the token in the array

setZero

public void setZero(int start,
                    int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to be zero valued.

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

isZero

public boolean isZero(int index)

Description copied from interface: ScalarTokenSequence

Indicates whether the specified token has a zero value.

Parameters:

index - the index of the token

Returns:

true if the element is zero, false otherwise

setString

public void setString(int index,
                      String value)

Sets the token at the specified position to the given string value.

Parameters:

index - the position of the token in the array

value - the string value to which to set the token. Passing null is equivalent to calling setNull(index).

fillString

public void fillString(int start,
                       int length,
                       String value)

Sets the tokens in the specified subsequence to the given string value.

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

value - the string value to which to set the tokens. Passing null is equivalent to calling setNull(start, length).

setValue

public void setValue(int position,
                     TokenValued value)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to the given value.

Parameters:

position - the position of the token in the array

value - the value to which to set the token. This value must be of an appropriate type for the array.

fillValue

public void fillValue(int startIndex,
                      int count,
                      TokenValued value)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to the given value.

Parameters:

startIndex - the starting index of the subsequence in the array

count - the length of the subsequence

value - the value to which to set the tokens. This value must be of an appropriate type for the array

setValues

public void setValues(int startIndex,
                      TokenSequence values,
                      int offset,
                      int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence of the array to the corresponding values from a subsequence of the given source sequence.

Parameters:

startIndex - the starting index of the subsequence in the array

values - the source sequence. This sequence must be of an appropriate type for the array.

offset - the starting index in the source sequence. Corresponding values will be taken relative to this position. That is, the value of the token at position offset in values will be assigned to the token at position start, and so on.

length - the number of tokens to copy

expandValueBuffers

protected void expandValueBuffers(int capacity)

append

public void append(String value)

Description copied from interface: MutableStringTokenSequence

Appends the specified string to this sequence.

Parameters:

value - the value to append. If null, this is equivalent to appendNull().

append

public void append(String value,
                   int count)

Description copied from interface: MutableStringTokenSequence

Appends the specified string to this sequence multiple times.

Parameters:

value - the value to append. If null, this is equivalent to appendNull(count).

count - the number of copies to append.

newValueIterator

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

Returns:

an newly-created iterator over the non-null values of this sequence.

getType

public final ScalarTokenType getType()

Description copied from interface: ScalarTokenSequence

Gets the data type of the tokens in the sequence.

Specified by:

getType in interface ScalarTokenSequence

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

Returns:

the token data type

compareElement

public final int compareElement(int index,
                                String value)

getToken

public final 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 StringTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getTokenSetter

public final StringSettable getTokenSetter(int index)

Description copied from interface: MutableTokenSequence

Returns a mutator for the given index.

Specified by:

getTokenSetter in interface MutableTokenSequence

Specified by:

getTokenSetter in interface MutableScalarTokenSequence

Specified by:

getTokenSetter in interface MutableStringTokenSequence

Parameters:

index - the position

Returns:

a mutator for the given index.