Module datarush.library

Package com.pervasive.datarush.tokens.record

Class FieldIteratorProperties

java.lang.Object

com.pervasive.datarush.tokens.record.FieldIteratorProperties

public final class FieldIteratorProperties
extends Object

Various properties that control the behavior of a field iterator.

Constructor Summary

Constructors

Constructor	Description
FieldIteratorProperties(ScalarTokenType type)	Creates a new FieldIteratorProperties, whose selected fields are those that exactly match the given type.
FieldIteratorProperties(ScalarTokenType type, String[] selectedFields)	Creates a new FieldIteratorProperties, whose selected fields are those specified.
FieldIteratorProperties(ScalarTokenType type, String[] selectedFields, boolean sorted)	Creates a new FieldIteratorProperties, whose selected fields are those specified.

Method Summary

Modifier and Type	Method	Description
String[]	getSelectedFields()	Returns the list of selected fields.
ScalarTokenType	getType()	Returns the type of field iterator to select.
boolean	isSorted()	Returns whether the iterator is to always be sorted by absolute index.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldIteratorProperties

public FieldIteratorProperties(ScalarTokenType type)

Creates a new FieldIteratorProperties, whose selected fields are those that exactly match the given type. The field iterator will be sorted by absolute index.

Parameters:

type - The type of field iterator

FieldIteratorProperties

public FieldIteratorProperties(ScalarTokenType type,
                               String[] selectedFields)

Creates a new FieldIteratorProperties, whose selected fields are those specified. The field iterator will be sorted by absolute index.

Parameters:

type - The type of field iterator

selectedFields - The fields to select

FieldIteratorProperties

public FieldIteratorProperties(ScalarTokenType type,
                               String[] selectedFields,
                               boolean sorted)

Creates a new FieldIteratorProperties, whose selected fields are those specified.

Parameters:

type - The type of field iterator

selectedFields - The fields to select

sorted - If true, the iterator will always be sorted by absolute index.

Method Detail

getType

public ScalarTokenType getType()

Returns the type of field iterator to select.

Returns:

the type of field iterator to select.

getSelectedFields

public String[] getSelectedFields()

Returns the list of selected fields. A value of null means auto-discover based on type.

Returns:

the list of selected fields.

isSorted

public boolean isSorted()

Returns whether the iterator is to always be sorted by absolute index.

Returns:

whether the iterator is to always be sorted by absolute index.