com.pervasive.datarush.sequences.record

Interface RecordTokenSequence

All Superinterfaces:

RecordTyped, TokenSequence, TokenTyped

All Known Subinterfaces:

MutableRecordTokenSequence

All Known Implementing Classes:

CompositeTokenSequence, RecordTokenList, SparseRecordTokenList

public interface RecordTokenSequence
extends TokenSequence, RecordTyped

A TokenSequence of composite tokens, representing record data. A RecordTokenSequence can be thought of as rows of tokens or, equivalently, as a table of tokens. Tokens can be accessed column-wise, as independent sequences, or row-wise, as elements.

Method Summary

Modifier and Type	Method and Description
int	columns() Gets the number of columns in a record.
int	compareElement(int index, TokenValued value) Compares the values of the specified row of tokens to the tokens at which the given port is positioned.
int	compareElements(int lhsIndex, int rhsIndex) Compares the values of the tokens at the specified positions.
boolean	containsNull(int index) Determines if any column in the specified row is null valued.
ScalarTokenSequence	getColumn(int index) Gets the ScalarTokenSequence containing the specified column data.
ElementComparator	getElementComparator(SortKey... sortKeys) Gets an ElementComparator for the token array for the fields with the given names and the given token orders.
ElementComparator	getElementComparator(TokenOrder... sortOrder) Gets an ElementComparator for the token array and given ordering.
ElementComparator	getElementComparator(TokenOrder sortOrder) Gets an ElementComparator for the token array and given ordering.
RecordValued	getToken(int index) Gets the value at the specified position.
RecordValuedIterator	newValueIterator() Creates an iterator over the non-null values of this sequence.

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

hashCode, isNull, size, toString

Methods inherited from interface com.pervasive.datarush.types.RecordTyped

getType

Method Detail

containsNull

boolean containsNull(int index)

Determines if any column in the specified row is null valued.

Parameters:

index - the row to check

Returns:

true if at least one column is null valued, false if none are

compareElement

int compareElement(int index,
                   TokenValued value)

Compares the values of the specified row of tokens to the tokens at which the given port is positioned. Tokens in a row are compared to the token of the subport in the same position as the token's column. Comparison starts with the first column and progresses until the tokens compare unequal or there are no more columns.

The source sequence must be composite and have the same number of columns as this sequence. All columns must be of comparable types.

Specified by:

compareElement in interface TokenSequence

Parameters:

index - the index of the token

value - the input port positioned at the token for comparison

Returns:

0 if the values are equal, 1 if the sequence token value is greater, -1 if the sequence token value is lesser. A null value is greater than any other non-null; two null values compare as equal.

compareElements

int compareElements(int lhsIndex,
                    int rhsIndex)

Description copied from interface: TokenSequence

Compares the values of the tokens at the specified positions.

Specified by:

compareElements in interface TokenSequence

Parameters:

lhsIndex - the index of the left-hand element

rhsIndex - the index of the right-hand element

Returns:

0 if the values are equal, 1 if the left hand value is greater, -1 if the left hand value is lesser. A null value is greater than any other non-null; two null values compare as equal.

getElementComparator

ElementComparator getElementComparator(TokenOrder sortOrder)

Gets an ElementComparator for the token array and given ordering. All columns will by sorted in the given order.

Specified by:

getElementComparator in interface TokenSequence

Parameters:

sortOrder - the desired ordering

Returns:

an ElementComparator on the CompositeTokenArray.

getElementComparator

ElementComparator getElementComparator(TokenOrder... sortOrder)

Gets an ElementComparator for the token array and given ordering. Each column will be sorted by the order specified in the matching position in the ordering array. An ordering must be specified for each column.

Parameters:

sortOrder - the desired ordering

Returns:

an ElementComparator on this sequence

Throws:

IllegalArgumentException - if the ordering does not contain the same number of values as there are columns.

getElementComparator

ElementComparator getElementComparator(SortKey... sortKeys)

Gets an ElementComparator for the token array for the fields with the given names and the given token orders.

Parameters:

sortKeys - list of key fields and sort order for each

Returns:

an ElementComparator on this sequence

Throws:

IllegalArgumentException - if the key field list does not contain the same number of values as the sort order list.

getToken

RecordValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

columns

int columns()

Gets the number of columns in a record.

Returns:

the number of columns in a record.

getColumn

ScalarTokenSequence getColumn(int index)

Gets the ScalarTokenSequence containing the specified column data.

Parameters:

index - the column sequence to get. Indexes are zero-based and ordered identically to the fields in the RecordTokenType for this array.

Returns:

a ScalarTokenSequence containing the token values for the column.

newValueIterator

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

Returns:

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