com.pervasive.datarush.sequences.scalar

Class ObjectTokenList<O>

java.lang.Object

com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

com.pervasive.datarush.sequences.scalar.ObjectTokenList<O>

Type Parameters:

O - the type of Java objects in the list

All Implemented Interfaces:

MutableTokenSequence, MutableObjectTokenSequence<O>, MutableScalarTokenSequence, ObjectTokenSequence<O>, ScalarTokenAppendable, ScalarTokenSequence, TokenAppendable, TokenSequence, ObjectTyped<O>, ScalarTyped, TokenTyped

public final class ObjectTokenList<O>
extends AbstractScalarTokenSequence
implements MutableObjectTokenSequence<O>

Primary implementation of MutableObjectTokenSequence.

See Also:

TokenTypeConstant#OBJECT(Class)

Constructor Summary

Constructors

Constructor and Description
ObjectTokenList(ObjectTokenType<O> type, int capacity) Create an empty array

Method Summary

Modifier and Type	Method and Description
void	append(O value) Appends the specified object to this sequence.
void	append(O value, int count) Appends the specified object to this sequence multiple times.
void	fill(int start, int length, O value) Sets the tokens in the specified subsequence to the given object value.
void	fillValue(int start, int length, TokenValued value) Sets the tokens in the specified subsequence to the given value.
O	getObject(int i) Gets the value of the specified token as an object.
ObjectValued<O>	getToken(int index) Gets the value at the specified position.
ObjectSettable<O>	getTokenSetter(int index) Returns a mutator for the given index.
ObjectTokenType<O>	getType() Gets the data type of the tokens in the sequence.
void	getValues(int index, O[] 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.
ObjectValuedIterator<O>	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	setObject(int index, O value) Sets the token at the specified position to the given object value.
void	setValue(int index, TokenValued value) Sets the token at the specified position to the given value.
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.

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

ObjectTokenList

public ObjectTokenList(ObjectTokenType<O> type,
                       int capacity)

Create an empty array

Parameters:

type - the type of objects in the list

capacity - the initial capacity.

Method Detail

getType

public ObjectTokenType<O> getType()

Description copied from interface: ScalarTokenSequence

Gets the data type of the tokens in the sequence.

Specified by:

getType in interface ObjectTokenSequence<O>

Specified by:

getType in interface ScalarTokenSequence

Specified by:

getType in interface ObjectTyped<O>

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

Returns:

the token data type

getObject

public O getObject(int i)

Description copied from interface: ObjectTokenSequence

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.

Specified by:

getObject in interface ObjectTokenSequence<O>

Parameters:

i - the position of the token in the sequence

Returns:

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

getToken

public ObjectValued<O> getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface ObjectTokenSequence<O>

Specified by:

getToken in interface ScalarTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getTokenSetter

public ObjectSettable<O> 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 MutableObjectTokenSequence<O>

Specified by:

getTokenSetter in interface MutableScalarTokenSequence

Parameters:

index - the position

Returns:

a mutator for the given index.

getValues

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

Description copied from interface: ObjectTokenSequence

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.

Specified by:

getValues in interface ObjectTokenSequence<O>

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

setObject

public void setObject(int index,
                      O value)

Sets the token at the specified position to the given object value. If the object is mutable, subsequently modifying it will modify the token in the array.

Specified by:

setObject in interface MutableObjectTokenSequence<O>

Parameters:

index - the position of the token in the array

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

fill

public void fill(int start,
                 int length,
                 O value)

Sets the tokens in the specified subsequence to the given object value. If the object is mutable, subsequently modifying it will modify the tokens in the array.

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

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

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

append

public void append(O value)

Description copied from interface: MutableObjectTokenSequence

Appends the specified object to this sequence.

Specified by:

append in interface MutableObjectTokenSequence<O>

Parameters:

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

append

public void append(O value,
                   int count)

Description copied from interface: MutableObjectTokenSequence

Appends the specified object to this sequence multiple times.

Specified by:

append in interface MutableObjectTokenSequence<O>

Parameters:

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

count - the number of copies to append.

newValueIterator

public 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 ObjectTokenSequence<O>

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.