Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Class MoneyTokenList

java.lang.Object

com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

com.pervasive.datarush.sequences.scalar.MoneyTokenList

All Implemented Interfaces:

MutableTokenSequence, DoubleTokenSequence, FloatTokenSequence, MoneyTokenSequence, MutableMoneyTokenSequence, MutableScalarTokenSequence, NumericTokenSequence, ScalarTokenAppendable, ScalarTokenSequence, TokenAppendable, TokenSequence, ScalarTyped, TokenTyped

public final class MoneyTokenList
extends AbstractScalarTokenSequence
implements MutableMoneyTokenSequence

Primary implementation of MutableMoneyTokenSequence.

See Also:

TokenTypeConstant.MONEY

Constructor Summary

Constructors

Constructor	Description
MoneyTokenList(int capacity)	Create an empty array

Method Summary

Modifier and Type	Method	Description
void	append(long value)	Appends the specified long to this sequence.
void	append(long value, int count)	Appends the specified long to this sequence multiple times.
void	fill(int start, int length, long value)	Sets the tokens in the specified subsequence to the given money value.
void	fillValue(int start, int length, TokenValued value)	Sets the tokens in the specified subsequence to the given value.
BigDecimal	getBigDecimal(int i)	Gets the value of the specified token as a BigDecimal.
long	getCents(int i)	Get the value of the specified token as a long representing cents.
double	getDouble(int i)	Gets the value of the specified token as a double.
float	getFloat(int i)	Gets the value of the specified token as a float.
MoneyValued	getToken(int index)	Gets the value at the specified position.
MoneySettable	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, double[] values, boolean[] nullFlags, int offset, int length)	Gets the values and null indicators for a range of tokens as doubles.
void	getValues(int index, float[] values, boolean[] nullFlags, int offset, int length)	Gets the values and null indicators for a range of tokens as floats.
void	getValues(int index, long[] values, boolean[] nullFlags, int offset, int length)	Gets the values and null indicators for a range of tokens as longs.
void	getValues(int index, BigDecimal[] values, boolean[] nullFlags, int offset, int length)	Gets the values and null indicators for a range of tokens as BigDecimal objects.
boolean	isZero(int index)	Indicates whether the specified token has a zero value.
MoneyValuedIterator	newValueIterator()	Creates an iterator over the non-null values of this sequence.
void	setCents(int index, long value)	Sets the token at the specified position to the given money 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, 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.MutableTokenSequence

appendNull, appendNull, appendZero, appendZero, reset

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

isNull

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

append, append, append, append

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

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

Constructor Detail

MoneyTokenList

public MoneyTokenList(int capacity)

Create an empty array

Parameters:

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

getBigDecimal

public BigDecimal getBigDecimal(int i)

Description copied from interface: NumericTokenSequence

Gets the value of the specified token as a BigDecimal.

Specified by:

getBigDecimal in interface NumericTokenSequence

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.

getDouble

public double getDouble(int i)

Description copied from interface: DoubleTokenSequence

Gets the value of the specified token as a double.

Specified by:

getDouble in interface DoubleTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

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

getFloat

public float getFloat(int i)

Description copied from interface: FloatTokenSequence

Gets the value of the specified token as a float.

Specified by:

getFloat in interface FloatTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

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

getCents

public long getCents(int i)

Description copied from interface: MoneyTokenSequence

Get the value of the specified token as a long representing cents.

Specified by:

getCents in interface MoneyTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

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

getToken

public MoneyValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface DoubleTokenSequence

Specified by:

getToken in interface FloatTokenSequence

Specified by:

getToken in interface MoneyTokenSequence

Specified by:

getToken in interface NumericTokenSequence

Specified by:

getToken in interface ScalarTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getTokenSetter

public MoneySettable getTokenSetter(int index)

Description copied from interface: MutableTokenSequence

Returns a mutator for the given index.

Specified by:

getTokenSetter in interface MutableMoneyTokenSequence

Specified by:

getTokenSetter in interface MutableScalarTokenSequence

Specified by:

getTokenSetter in interface MutableTokenSequence

Parameters:

index - the position

Returns:

a mutator for the given index.

getValues

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

Description copied from interface: MoneyTokenSequence

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

Specified by:

getValues in interface MoneyTokenSequence

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

getValues

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

Description copied from interface: FloatTokenSequence

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

Specified by:

getValues in interface FloatTokenSequence

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

getValues

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

Description copied from interface: DoubleTokenSequence

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

Specified by:

getValues in interface DoubleTokenSequence

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

getValues

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

Description copied from interface: NumericTokenSequence

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

Specified by:

getValues in interface NumericTokenSequence

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

setCents

public void setCents(int index,
                     long value)

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

Specified by:

setCents in interface MutableMoneyTokenSequence

Parameters:

index - the position of the token in the array

value - the cents value to which to set the token.

fill

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

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

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

value - the cents 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

append

public void append(long value)

Description copied from interface: MutableMoneyTokenSequence

Appends the specified long to this sequence.

Specified by:

append in interface MutableMoneyTokenSequence

Parameters:

value - the value to append.

append

public void append(long value,
                   int count)

Description copied from interface: MutableMoneyTokenSequence

Appends the specified long to this sequence multiple times.

Specified by:

append in interface MutableMoneyTokenSequence

Parameters:

value - the value to append.

count - the number of copies to append.

newValueIterator

public MoneyValuedIterator 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 DoubleTokenSequence

Specified by:

newValueIterator in interface FloatTokenSequence

Specified by:

newValueIterator in interface MoneyTokenSequence

Specified by:

newValueIterator in interface NumericTokenSequence

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.