com.pervasive.datarush.sequences.scalar

Class CharTokenList

java.lang.Object

com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

com.pervasive.datarush.sequences.scalar.CharTokenList

All Implemented Interfaces:

MutableTokenSequence, CharTokenSequence, MutableCharTokenSequence, MutableScalarTokenSequence, ScalarTokenAppendable, ScalarTokenSequence, TokenAppendable, TokenSequence, ScalarTyped, TokenTyped, CharSequence

public final class CharTokenList
extends AbstractScalarTokenSequence
implements MutableCharTokenSequence

Primary implementation of MutableCharTokenSequence.

See Also:

TokenTypeConstant.CHAR

Constructor Summary

Constructors

Constructor and Description
CharTokenList(int initialCapacity) Create an empty array

Method Summary

Modifier and Type	Method and Description
void	append(char value) Appends the specified character to this sequence.
void	append(char value, int count) Appends the specified character to this sequence multiple times.
void	appendChars(CharSequence seq) Appends the specified character sequence to this sequence.
void	appendChars(CharSequence seq, int start, int length) Appends a subsequence of the specified character sequence to this sequence.
char	charAt(int index)
void	fillChar(int start, int length, char value) Sets the tokens in the specified subsequence to the given character value.
void	fillValue(int start, int length, TokenValued value) Sets the tokens in the specified subsequence to the given value.
char	getChar(int i) Gets the value of the specified token as a char.
String	getString(int start, int length) Gets a subsequence of tokens as a string.
CharValued	getToken(int index) Gets the value at the specified position.
CharSettable	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, char[] 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.
int	length()
CharValuedIterator	newValueIterator() Creates an iterator over the non-null values of this sequence.
void	setChar(int index, char value) Sets the token at the specified position to the given character value.
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	setValue(int index, TokenValued value) Sets the token at the specified position to the given value.
void	setValues(int start, CharSequence 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 CharSequence.
void	setValues(int start, 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.
CharSequence	subSequence(int start, int end)
String	toString()

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

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

CharTokenList

public CharTokenList(int initialCapacity)

Create an empty array

Parameters:

initialCapacity - the initial capacity.

Method Detail

getType

public 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

getChar

public char getChar(int i)

Description copied from interface: CharTokenSequence

Gets the value of the specified token as a char.

Specified by:

getChar in interface CharTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

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

getString

public String getString(int start,
                        int length)

Description copied from interface: CharTokenSequence

Gets a subsequence of tokens as a string. An null values in the subsequence are represented as Character.MAX_VALUE.

Specified by:

getString in interface CharTokenSequence

Parameters:

start - the index of the first token in the subsequence

length - the length of the subsequence

Returns:

a string containing the values of the selected tokens.

length

public final int length()

Specified by:

length in interface CharSequence

charAt

public final char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public final CharSequence subSequence(int start,
                                      int end)

Specified by:

subSequence in interface CharSequence

toString

public final String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractScalarTokenSequence

getToken

public CharValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface CharTokenSequence

Specified by:

getToken in interface ScalarTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getTokenSetter

public CharSettable 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 MutableCharTokenSequence

Specified by:

getTokenSetter in interface MutableScalarTokenSequence

Parameters:

index - the position

Returns:

a mutator for the given index.

getValues

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

Description copied from interface: CharTokenSequence

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

Specified by:

getValues in interface CharTokenSequence

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.

Specified by:

setNull in interface MutableTokenSequence

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.

Specified by:

setNull in interface MutableTokenSequence

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.

Specified by:

setZero in interface MutableTokenSequence

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.

Specified by:

setZero in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

isZero

public final boolean isZero(int index)

Description copied from interface: ScalarTokenSequence

Indicates whether the specified token has a zero value.

Specified by:

isZero in interface ScalarTokenSequence

Parameters:

index - the index of the token

Returns:

true if the element is zero, false otherwise

setChar

public void setChar(int index,
                    char value)

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

Specified by:

setChar in interface MutableCharTokenSequence

Parameters:

index - the position of the token in the array

value - the character value to which to set the token

fillChar

public void fillChar(int start,
                     int length,
                     char value)

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

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

value - the character value to which to set the tokens

setValue

public void setValue(int index,
                     TokenValued value)

Description copied from interface: MutableTokenSequence

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

Specified by:

setValue in interface MutableTokenSequence

Parameters:

index - 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 start,
                      int length,
                      TokenValued value)

Description copied from interface: MutableTokenSequence

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

Specified by:

fillValue in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

length - 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 start,
                      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.

Specified by:

setValues in interface MutableTokenSequence

Parameters:

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

setValues

public void setValues(int start,
                      CharSequence 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 CharSequence.

Parameters:

start - the starting index of the subsequence in the array

values - the source CharSequence

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

length - the number of values to copy

append

public void append(char value)

Description copied from interface: MutableCharTokenSequence

Appends the specified character to this sequence.

Specified by:

append in interface MutableCharTokenSequence

Parameters:

value - the value to append.

append

public void append(char value,
                   int count)

Description copied from interface: MutableCharTokenSequence

Appends the specified character to this sequence multiple times.

Specified by:

append in interface MutableCharTokenSequence

Parameters:

value - the value to append.

count - the number of copies to append.

appendChars

public void appendChars(CharSequence seq)

Description copied from interface: MutableCharTokenSequence

Appends the specified character sequence to this sequence.

Specified by:

appendChars in interface MutableCharTokenSequence

Parameters:

seq - the character sequence to append.

appendChars

public void appendChars(CharSequence seq,
                        int start,
                        int length)

Description copied from interface: MutableCharTokenSequence

Appends a subsequence of the specified character sequence to this sequence.

Specified by:

appendChars in interface MutableCharTokenSequence

Parameters:

seq - the character sequence to append.

start - the index of the initial character in the subsequence

length - the length of the subsequence

newValueIterator

public CharValuedIterator 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 CharTokenSequence

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.