Module datarush.library
Package com.pervasive.datarush.sequences

Interface TokenValuedIterator

All Superinterfaces:
TokenTyped, TokenValued
All Known Subinterfaces:
BinaryValuedIterator, BooleanValuedIterator, CharValuedIterator, CloseableRecordValuedIterator, DateValuedIterator, DoubleValuedIterator, DurationValuedIterator, FloatValuedIterator, IntValuedIterator, Ip4AddressValuedIterator, Ip6AddressValuedIterator, LongValuedIterator, MoneyValuedIterator, NumericValuedIterator, ObjectValuedIterator<T>, PeriodValuedIterator, RecordValuedIterator, ScalarValuedIterator, SeekableRecordValuedIterator, SeekableScalarValuedIterator, SeekableTokenValuedIterator, StringValuedIterator, TimestampValuedIterator, TimeValuedIterator
All Known Implementing Classes:
DatasetIterator, RecordMap.RecordMapIterator
public interface TokenValuedIterator extends TokenValued
Iterator over token values. Provides a visitation pattern that is efficient for both sparse and dense data. When stepping, only those values not equal to "zero" will be returned.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAbsoluteIndex()
    Returns the dense value index for the current value.
    void
    resetIteration()
    Resets the iteration to the beginning.
    boolean
    stepNext()
    Advances to the next value not equal to "zero".

    Methods inherited from interface com.pervasive.datarush.tokens.TokenValued

    getType, isNull

  • Method Details

    • stepNext

      boolean stepNext()
      Advances to the next value not equal to "zero".
      Returns:
      true if position is beyond the end.
      Throws:
      IteratorEndOfDataException - If an attempt is made to call after it has already returned false

    • getAbsoluteIndex

      int getAbsoluteIndex()
      Returns the dense value index for the current value. Dense value index is the index of the value in the "dense" representation; If this represents an iterator over fields in a record, RecordTokenType.get(denseIndex) will return the associated field.

      NOTE: Iteration order is unspecified on this interface. Some implementations guarantee sort order whereas others do not. Please refer to the documentation on the factory method from which this iterator was constructed for ordering information.

      Returns:
      The dense index.

    • resetIteration

      void resetIteration()
      Resets the iteration to the beginning.