Module datarush.library
Class CompositeTokenSequence
- java.lang.Object
-
- com.pervasive.datarush.sequences.record.CompositeTokenSequence
-
- All Implemented Interfaces:
RecordTokenSequence
,TokenSequence
,RecordTyped
,TokenTyped
public class CompositeTokenSequence extends Object
A record sequence comprised of scalar sequences for fields.There is no guarantee of immutability for these objects. While no mutators are provided on
CompositeTokenSequence
, the underlying columns may refer to mutable objects.
-
-
Constructor Summary
Constructors Constructor Description CompositeTokenSequence(RecordTokenType type, ScalarTokenSequence[] columns)
Create a new sequence backed with the specified scalar token sequences containing the field values for each record element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 i)
Gets theScalarTokenSequence
containing the specified column data.ElementComparator
getElementComparator(SortKey... sortKeys)
Gets anElementComparator
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.RecordTokenType
getType()
Gets the type of data tokens handled by the implementor.int
hashCode(int index)
Gets the hash code for the token at the specified position.boolean
isNull(int index)
Indicates whether the specified token has a null value.RecordValuedIterator
newValueIterator()
Creates an iterator over the non-null values of this sequence.int
size()
Gets the length of the sequence.String
toString()
String
toString(int index)
Gets the string representation of the token at the specified position.
-
-
-
Constructor Detail
-
CompositeTokenSequence
public CompositeTokenSequence(RecordTokenType type, ScalarTokenSequence[] columns)
Create a new sequence backed with the specified scalar token sequences containing the field values for each record element. All sequences must be of the same length.- Parameters:
type
- the record schemacolumns
- theScalarTokenArray
objects containing the column data.- Throws:
IllegalArgumentException
- if not all columns are of the same length
-
-
Method Detail
-
columns
public final int columns()
Description copied from interface:RecordTokenSequence
Gets the number of columns in a record.- Specified by:
columns
in interfaceRecordTokenSequence
- Returns:
- the number of columns in a record.
-
getColumn
public ScalarTokenSequence getColumn(int i)
Description copied from interface:RecordTokenSequence
Gets theScalarTokenSequence
containing the specified column data.- Specified by:
getColumn
in interfaceRecordTokenSequence
- Parameters:
i
- the column sequence to get. Indexes are zero-based and ordered identically to the fields in theRecordTokenType
for this array.- Returns:
- a
ScalarTokenSequence
containing the token values for the column.
-
size
public final int size()
Description copied from interface:TokenSequence
Gets the length of the sequence.- Specified by:
size
in interfaceTokenSequence
- Returns:
- the number of tokens in the sequence.
-
getType
public final RecordTokenType getType()
Description copied from interface:TokenTyped
Gets the type of data tokens handled by the implementor.- Specified by:
getType
in interfaceRecordTyped
- Specified by:
getType
in interfaceTokenTyped
- Returns:
- the type of tokens associated with the class.
-
isNull
public final boolean isNull(int index)
Description copied from interface:TokenSequence
Indicates whether the specified token has a null value.- Specified by:
isNull
in interfaceTokenSequence
- Parameters:
index
- the index of the token- Returns:
true
if the element is null,false
otherwise
-
containsNull
public final boolean containsNull(int index)
Description copied from interface:RecordTokenSequence
Determines if any column in the specified row is null valued.- Specified by:
containsNull
in interfaceRecordTokenSequence
- Parameters:
index
- the row to check- Returns:
true
if at least one column is null valued,false
if none are
-
compareElement
public final int compareElement(int index, TokenValued value)
Description copied from interface:RecordTokenSequence
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 interfaceRecordTokenSequence
- Specified by:
compareElement
in interfaceTokenSequence
- Parameters:
index
- the index of the tokenvalue
- 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
public final 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 interfaceRecordTokenSequence
- Specified by:
compareElements
in interfaceTokenSequence
- Parameters:
lhsIndex
- the index of the left-hand elementrhsIndex
- 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
public final ElementComparator getElementComparator(TokenOrder sortOrder)
Description copied from interface:RecordTokenSequence
Gets an ElementComparator for the token array and given ordering. All columns will by sorted in the given order.- Specified by:
getElementComparator
in interfaceRecordTokenSequence
- Specified by:
getElementComparator
in interfaceTokenSequence
- Parameters:
sortOrder
- the desired ordering- Returns:
- an ElementComparator on the CompositeTokenArray.
-
getElementComparator
public final ElementComparator getElementComparator(TokenOrder... sortOrder)
Description copied from interface:RecordTokenSequence
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.- Specified by:
getElementComparator
in interfaceRecordTokenSequence
- Parameters:
sortOrder
- the desired ordering- Returns:
- an
ElementComparator
on this sequence
-
getElementComparator
public final ElementComparator getElementComparator(SortKey... sortKeys)
Description copied from interface:RecordTokenSequence
Gets anElementComparator
for the token array for the fields with the given names and the given token orders.- Specified by:
getElementComparator
in interfaceRecordTokenSequence
- Parameters:
sortKeys
- list of key fields and sort order for each- Returns:
- an
ElementComparator
on this sequence
-
getToken
public final RecordValued getToken(int index)
Description copied from interface:TokenSequence
Gets the value at the specified position.- Specified by:
getToken
in interfaceRecordTokenSequence
- Specified by:
getToken
in interfaceTokenSequence
- Parameters:
index
- the index of the token- Returns:
- the value
-
hashCode
public final int hashCode(int index)
Description copied from interface:TokenSequence
Gets the hash code for the token at the specified position.- Specified by:
hashCode
in interfaceTokenSequence
- Parameters:
index
- the index of the token- Returns:
- the hash code for the token
-
toString
public final String toString(int index)
Description copied from interface:TokenSequence
Gets the string representation of the token at the specified position.- Specified by:
toString
in interfaceTokenSequence
- Parameters:
index
- the index of the token- Returns:
- the string representation of the token
-
newValueIterator
public 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 interfaceRecordTokenSequence
- Specified by:
newValueIterator
in interfaceTokenSequence
- Returns:
- an newly-created iterator over the non-null values of this sequence.
-
-