org.apache.cassandra.db

Class LegacyLayout.CellGrouper

java.lang.Object

org.apache.cassandra.db.LegacyLayout.CellGrouper

Enclosing class:

LegacyLayout

public static class LegacyLayout.CellGrouper
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
CFMetaData	metadata

Constructor Summary

Constructors

Constructor and Description
CellGrouper(CFMetaData metadata, SerializationHelper helper)

Method Summary

Modifier and Type	Method and Description
boolean	addAtom(LegacyLayout.LegacyAtom atom) Try adding the provided atom to the currently grouped row.
Clustering	currentRowClustering() The clustering of the current row of the cell grouper, or null if no row is currently started.
Row	getRow() Generates the row currently grouped by this grouper and reset it for the following row.
void	reset()
boolean	startsAfterCurrentRow(LegacyLayout.LegacyRangeTombstone rangeTombstone) Whether the provided range tombstone starts strictly after the current row of the cell grouper (if no row is currently started, this return false).
static LegacyLayout.CellGrouper	staticGrouper(CFMetaData metadata, SerializationHelper helper)

Methods inherited from class java.lang.Object

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

Field Detail

metadata

public final CFMetaData metadata

Constructor Detail

CellGrouper

public CellGrouper(CFMetaData metadata,
                   SerializationHelper helper)

Method Detail

staticGrouper

public static LegacyLayout.CellGrouper staticGrouper(CFMetaData metadata,
                                                     SerializationHelper helper)

reset

public void reset()

addAtom

public boolean addAtom(LegacyLayout.LegacyAtom atom)

Try adding the provided atom to the currently grouped row.

Parameters:

atom - the new atom to try to add. This must be a "row" atom, that is either a cell or a legacy range tombstone that covers only one row (row deletion) or a subset of it (collection deletion). Meaning that legacy range tombstone covering multiple rows (that should be handled as legit range tombstone in the new storage engine) should be handled separately. Atoms should also be provided in proper clustering order.

Returns:

true if the provided atom has been "consumed" by this grouper (this does _not_ mean the atom has been "used" by the grouper as the grouper will skip some shadowed atoms for instance, just that getRow() shouldn't be called just yet if there is more atom in the atom iterator we're grouping). false otherwise, that is if the row currently built by this grouper is done _without_ the provided atom being "consumed" (and so getRow() should be called and the grouper resetted, after which the provided atom should be provided again).

startsAfterCurrentRow

public boolean startsAfterCurrentRow(LegacyLayout.LegacyRangeTombstone rangeTombstone)

Whether the provided range tombstone starts strictly after the current row of the cell grouper (if no row is currently started, this return false).

currentRowClustering

public Clustering currentRowClustering()

The clustering of the current row of the cell grouper, or null if no row is currently started.

getRow

public Row getRow()

Generates the row currently grouped by this grouper and reset it for the following row.

Note that the only correct way to call this is when either all the atom we're trying to group has been consumed, or when #addAtom(LegacyAtom) returns false.

Returns:

the current row that has been grouped, or null in the rare case where all the atoms "consumed" by #addAtom(LegacyAtom) for this row were skipped (we skip atoms under a few conditions).