Package org.apache.druid.timeline.partition

Class OvershadowableManager<T extends Overshadowable<T>>

java.lang.Object

org.apache.druid.timeline.partition.OvershadowableManager<T>

All Implemented Interfaces:

PartitionHolderContents<T>

public class OvershadowableManager<T extends Overshadowable<T>>
extends Object
implements PartitionHolderContents<T>

OvershadowableManager manages the state of AtomicUpdateGroup. See the below OvershadowableManager.State for details. Note that an AtomicUpdateGroup can consist of Overshadowables of the same majorVersion, minorVersion, rootPartition range, and atomicUpdateGroupSize. In VersionedIntervalTimeline, this class is used to manage segments in the same timeChunk. OvershadowableManager is only used when segment locking is in play, and segments with minor version != 0 have been created. See PartitionHolder.add(PartitionChunk). This class is not thread-safe.

Constructor Summary

Constructors

Constructor	Description
OvershadowableManager()

Method Summary

Modifier and Type	Method	Description
boolean	addChunk(PartitionChunk<T> chunk)	Adds a chunk.
boolean	areVisibleChunksConsistent()	Whether all visible chunks are consistent, meaning they can possibly be considered for PartitionHolder.isComplete().
OvershadowableManager<T>	copyVisible()	Returns a copy of this holder with only visible chunks.
OvershadowableManager<T>	deepCopy()	Returns a copy of this holder with all chunks.
boolean	equals(Object o)
static <T extends Overshadowable<T>> OvershadowableManager<T>	fromSimple(SimplePartitionHolderContents<T> contents)
PartitionChunk<T>	getChunk(int partitionId)	Returns the chunk with a given partition ID, or null if none exists.
List<PartitionChunk<T>>	getOvershadowedChunks()	Returns chunks that are tracked but not visible.
int	hashCode()
boolean	isEmpty()	Whether this holder is empty.
PartitionChunk<T>	removeChunk(PartitionChunk<T> partitionChunk)	Removes and returns a chunk with the same partition boundaries as the provided chunk.
String	toString()
Iterator<PartitionChunk<T>>	visibleChunksIterator()	Iterates through all visible chunks.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OvershadowableManager

public OvershadowableManager()

Method Details

fromSimple

public static <T extends Overshadowable<T>>
OvershadowableManager<T> fromSimple(SimplePartitionHolderContents<T> contents)

copyVisible

public OvershadowableManager<T> copyVisible()

Description copied from interface: PartitionHolderContents

Returns a copy of this holder with only visible chunks.

Specified by:

copyVisible in interface PartitionHolderContents<T extends Overshadowable<T>>

deepCopy

public OvershadowableManager<T> deepCopy()

Description copied from interface: PartitionHolderContents

Returns a copy of this holder with all chunks.

Specified by:

deepCopy in interface PartitionHolderContents<T extends Overshadowable<T>>

addChunk

public boolean addChunk(PartitionChunk<T> chunk)

Description copied from interface: PartitionHolderContents

Adds a chunk.

Specified by:

addChunk in interface PartitionHolderContents<T extends Overshadowable<T>>

Returns:

true if no chunk previously existed with these partition boundaries

removeChunk

@Nullable
public PartitionChunk<T> removeChunk(PartitionChunk<T> partitionChunk)

Description copied from interface: PartitionHolderContents

Removes and returns a chunk with the same partition boundaries as the provided chunk. Returns null if no such chunk exists.

Specified by:

removeChunk in interface PartitionHolderContents<T extends Overshadowable<T>>

isEmpty

public boolean isEmpty()

Description copied from interface: PartitionHolderContents

Whether this holder is empty.

Specified by:

isEmpty in interface PartitionHolderContents<T extends Overshadowable<T>>

areVisibleChunksConsistent

public boolean areVisibleChunksConsistent()

Description copied from interface: PartitionHolderContents

Whether all visible chunks are consistent, meaning they can possibly be considered for PartitionHolder.isComplete(). When segment locking is not being used, all chunks are consistent, so this always returns true.

Specified by:

areVisibleChunksConsistent in interface PartitionHolderContents<T extends Overshadowable<T>>

getChunk

@Nullable
public PartitionChunk<T> getChunk(int partitionId)

Description copied from interface: PartitionHolderContents

Returns the chunk with a given partition ID, or null if none exists.

Specified by:

getChunk in interface PartitionHolderContents<T extends Overshadowable<T>>

visibleChunksIterator

public Iterator<PartitionChunk<T>> visibleChunksIterator()

Description copied from interface: PartitionHolderContents

Iterates through all visible chunks. When segment locking is not being used, all chunks are visible, so this returns all chunks.

Specified by:

visibleChunksIterator in interface PartitionHolderContents<T extends Overshadowable<T>>

getOvershadowedChunks

public List<PartitionChunk<T>> getOvershadowedChunks()

Description copied from interface: PartitionHolderContents

Returns chunks that are tracked but not visible. When segment locking is not being used, all chunks are visible, so this returns nothing.

Specified by:

getOvershadowedChunks in interface PartitionHolderContents<T extends Overshadowable<T>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object