org.apache.drill.exec.physical.impl.common

Class SpilledState<T extends SpilledPartitionMetadata>

java.lang.Object

org.apache.drill.exec.physical.impl.common.SpilledState<T>

Type Parameters:

T - The class holding spilled partition metadata.

Lifecycle

1. Create a SpilledState instance.
2. Call initialize(int)
3. Call addPartition(SpilledPartitionMetadata) (SpilledPartitionMetadata)}, getNextSpilledPartition(), or updateCycle(OperatorStats, SpilledPartitionMetadata, Updater)

• A user can call getCycle() at any time.

public class SpilledState<T extends SpilledPartitionMetadata>
extends Object

Manages the spilling information for an operator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpilledState.Updater This is a class that is used to do updates of the spilled state.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SpilledState()

Method Summary

Modifier and Type	Method and Description
boolean	addPartition(T spilledPartition) Add the partition metadata to the end of the queue to be processed.
int	getBitsInMask()
int	getCycle() Gets the current spill cycle.
T	getNextSpilledPartition() Get the next spilled partition to process.
int	getNumPartitions() Gets the number of partitions.
int	getPartitionMask()
void	initialize(int numPartitions) Initializes the number of partitions to use for the spilled state.
boolean	isEmpty() True if there are no spilled partitions.
boolean	isFirstCycle() True if this is the first cycle (0).
void	updateCycle(OperatorStats operatorStats, T spilledPartition, SpilledState.Updater updater) Update the current spill cycle.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

SpilledState

public SpilledState()

Method Detail

initialize

public void initialize(int numPartitions)

Initializes the number of partitions to use for the spilled state.

Parameters:

numPartitions - The number of partitions to use for the spilled state.

getNumPartitions

public int getNumPartitions()

Gets the number of partitions.

Returns:

The number of partitions.

isFirstCycle

public boolean isFirstCycle()

True if this is the first cycle (0).

Returns:

True if this is the first cycle (0).

getPartitionMask

public int getPartitionMask()

getBitsInMask

public int getBitsInMask()

addPartition

public boolean addPartition(T spilledPartition)

Add the partition metadata to the end of the queue to be processed.

Parameters:

spilledPartition - The partition metadata to process.

Returns:

getNextSpilledPartition

public T getNextSpilledPartition()

Get the next spilled partition to process.

Returns:

The metadata for the next spilled partition to process.

isEmpty

public boolean isEmpty()

True if there are no spilled partitions.

Returns:

True if there are no spilled partitions.

updateCycle

public void updateCycle(OperatorStats operatorStats,
                        T spilledPartition,
                        SpilledState.Updater updater)

Update the current spill cycle.

Parameters:

operatorStats - Current operator stats.

spilledPartition - The next spilled partition metadata to process.

updater - The updater implementation that executes custom logic if a spill cycle is incremented.

getCycle

public int getCycle()

Gets the current spill cycle.

Returns:

The current spill cycle.