Package org.apache.cassandra.db.rows

Interface WrappingUnfilteredRowIterator

All Superinterfaces:

AutoCloseable, BaseRowIterator<Unfiltered>, CloseableIterator<Unfiltered>, Iterator<Unfiltered>, UnfilteredRowIterator

public interface WrappingUnfilteredRowIterator
extends UnfilteredRowIterator

Abstract class to make writing unfiltered iterators that wrap another iterator easier. By default, the wrapping iterator simply delegate every call to the wrapped iterator so concrete implementations will have to override some methods.

Note that if most of what you want to do is modifying/filtering the returned Unfiltered, Transformation.apply(UnfilteredRowIterator, Transformation) can be a simpler option.

Method Summary

Modifier and Type	Method	Description
default void	close()
default RegularAndStaticColumns	columns()	A subset of the columns for the (static and regular) rows returned by this iterator.
default boolean	hasNext()
default boolean	isReverseOrder()	Whether or not the rows returned by this iterator are in reversed clustering order.
default TableMetadata	metadata()	The metadata for the table this iterator on.
default Unfiltered	next()
default DecoratedKey	partitionKey()	The partition key of the partition this in an iterator over.
default DeletionTime	partitionLevelDeletion()	The partition level deletion for the partition this iterate over.
default Row	staticRow()	The static part corresponding to this partition (this can be an empty row but cannot be null).
default EncodingStats	stats()	Return "statistics" about what is returned by this iterator.
UnfilteredRowIterator	wrapped()

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface org.apache.cassandra.db.rows.UnfilteredRowIterator

isEmpty

Method Details

wrapped

UnfilteredRowIterator wrapped()

metadata

default TableMetadata metadata()

Description copied from interface: BaseRowIterator

The metadata for the table this iterator on.

Specified by:

metadata in interface BaseRowIterator<Unfiltered>

columns

default RegularAndStaticColumns columns()

Description copied from interface: BaseRowIterator

A subset of the columns for the (static and regular) rows returned by this iterator. Every row returned by this iterator must guarantee that it has only those columns.

Specified by:

columns in interface BaseRowIterator<Unfiltered>

isReverseOrder

default boolean isReverseOrder()

Description copied from interface: BaseRowIterator

Whether or not the rows returned by this iterator are in reversed clustering order.

Specified by:

isReverseOrder in interface BaseRowIterator<Unfiltered>

partitionKey

default DecoratedKey partitionKey()

Description copied from interface: BaseRowIterator

The partition key of the partition this in an iterator over.

Specified by:

partitionKey in interface BaseRowIterator<Unfiltered>

partitionLevelDeletion

default DeletionTime partitionLevelDeletion()

Description copied from interface: UnfilteredRowIterator

The partition level deletion for the partition this iterate over.

Specified by:

partitionLevelDeletion in interface UnfilteredRowIterator

staticRow

default Row staticRow()

Description copied from interface: BaseRowIterator

The static part corresponding to this partition (this can be an empty row but cannot be null).

Specified by:

staticRow in interface BaseRowIterator<Unfiltered>

stats

default EncodingStats stats()

Description copied from interface: UnfilteredRowIterator

Return "statistics" about what is returned by this iterator. Those are used for performance reasons (for delta-encoding for instance) and code should not expect those to be exact.

Specified by:

stats in interface UnfilteredRowIterator

hasNext

default boolean hasNext()

Specified by:

hasNext in interface Iterator<Unfiltered>

next

default Unfiltered next()

Specified by:

next in interface Iterator<Unfiltered>

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableIterator<Unfiltered>