Package io.deephaven.engine.table.impl.sources.regioned

Class RegionedColumnSourceManager

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessArtifact

io.deephaven.engine.table.impl.sources.regioned.RegionedColumnSourceManager

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ColumnSourceManager, Serializable

public class RegionedColumnSourceManager
extends LivenessArtifact
implements ColumnSourceManager

Manage column sources made up of regions in their own row key address space.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
void	addLocation(@NotNull TableLocation tableLocation)	Add a table location to the list to be checked in run().
final Collection<TableLocation>	allLocations()	Get the added locations, first the ones that have been "included" (found to exist with non-zero size) in order of inclusion, then the remainder in order of discovery.
void	deliverError(@NotNull Throwable error, TableListener.Entry entry)	Advise this ColumnSourceManager that an error has occurred, and that it will no longer be refreshed.
final Map<String,? extends ColumnSource<?>>	getColumnSources()	Get a map of name to ColumnSource for the column sources maintained by this manager.
final Collection<TableLocation>	includedLocations()	Get the added locations that have been found to exist and have non-zero size.
TrackingWritableRowSet	initialize()	Observe initial sizes for the previously added table locations, and update the managed column sources accordingly.
final boolean	isEmpty()	Report whether this ColumnSourceManager has no locations that have been "included" (i.e.
String	locationColumnName()	Get the name of the column that contains the TableLocation values from ColumnSourceManager.locationTable().
Table	locationTable()	Get the added locations that have been found to exist and have non-zero size as a table containing the row sets for each location.
WritableRowSet	refresh()	Observe size changes in the previously added table locations, and update the managed column sources accordingly.
boolean	removeLocationKey(@NotNull ImmutableTableLocationKey locationKey)	Remove a table location key from the sources.
String	rowSetColumnName()	Get the name of the column that contains the RowSet values from ColumnSourceManager.locationTable().

Methods inherited from class io.deephaven.engine.liveness.LivenessArtifact

manageWithCurrentScope

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

destroy, dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage

Methods inherited from interface io.deephaven.engine.liveness.LivenessNode

unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Method Details

addLocation

public void addLocation(@NotNull
 @NotNull TableLocation tableLocation)

Description copied from interface: ColumnSourceManager

Add a table location to the list to be checked in run().

Specified by:

addLocation in interface ColumnSourceManager

Parameters:

tableLocation - The table location to be added

removeLocationKey

public boolean removeLocationKey(@NotNull
 @NotNull ImmutableTableLocationKey locationKey)

Description copied from interface: ColumnSourceManager

Remove a table location key from the sources.

Specified by:

removeLocationKey in interface ColumnSourceManager

Parameters:

locationKey - the location key being removed

Returns:

true if the location key was actually removed

initialize

public TrackingWritableRowSet initialize()

Description copied from interface: ColumnSourceManager

Observe initial sizes for the previously added table locations, and update the managed column sources accordingly. Create any data indexes that may be derived from the locations.

Specified by:

initialize in interface ColumnSourceManager

Returns:

The initial set of initially-available row keys, to be owned by the caller. This row set will have a data indexer populated with any data indexes that were created.

refresh

public WritableRowSet refresh()

Description copied from interface: ColumnSourceManager

Observe size changes in the previously added table locations, and update the managed column sources accordingly.

Specified by:

refresh in interface ColumnSourceManager

Returns:

The set of added row keys, to be owned by the caller

deliverError

public void deliverError(@NotNull
 @NotNull Throwable error,
 @Nullable
 TableListener.Entry entry)

Description copied from interface: ColumnSourceManager

Advise this ColumnSourceManager that an error has occurred, and that it will no longer be refreshed. This method should ensure that the error is delivered to downstream listeners if appropriate.

Specified by:

deliverError in interface ColumnSourceManager

Parameters:

error - The error that occurred

entry - The failing node's entry, if known

allLocations

public final Collection<TableLocation> allLocations()

Description copied from interface: ColumnSourceManager

Get the added locations, first the ones that have been "included" (found to exist with non-zero size) in order of inclusion, then the remainder in order of discovery.

Specified by:

allLocations in interface ColumnSourceManager

Returns:

All known locations, ordered as described

includedLocations

public final Collection<TableLocation> includedLocations()

Description copied from interface: ColumnSourceManager

Get the added locations that have been found to exist and have non-zero size.

Specified by:

includedLocations in interface ColumnSourceManager

Returns:

The added locations that have been found to exist and have non-zero size

locationTable

public Table locationTable()

Description copied from interface: ColumnSourceManager

Get the added locations that have been found to exist and have non-zero size as a table containing the row sets for each location. May only be called after ColumnSourceManager.initialize(). The returned table will also have columns corresponding to the partitions found in the locations, for the convenience of many downstream operations.

Specified by:

locationTable in interface ColumnSourceManager

Returns:

The added locations that have been found to exist and have non-zero size

locationColumnName

public String locationColumnName()

Description copied from interface: ColumnSourceManager

Get the name of the column that contains the TableLocation values from ColumnSourceManager.locationTable().

Specified by:

locationColumnName in interface ColumnSourceManager

Returns:

The name of the location column

rowSetColumnName

public String rowSetColumnName()

Description copied from interface: ColumnSourceManager

Get the name of the column that contains the RowSet values from ColumnSourceManager.locationTable().

Specified by:

rowSetColumnName in interface ColumnSourceManager

Returns:

The name of the row set column

isEmpty

public final boolean isEmpty()

Description copied from interface: ColumnSourceManager

Report whether this ColumnSourceManager has no locations that have been "included" (i.e. found to exist with non-zero size).

Specified by:

isEmpty in interface ColumnSourceManager

Returns:

True if there are no included locations

getColumnSources

public final Map<String,? extends ColumnSource<?>> getColumnSources()

Description copied from interface: ColumnSourceManager

Get a map of name to ColumnSource for the column sources maintained by this manager.

Specified by:

getColumnSources in interface ColumnSourceManager

Returns:

An unmodifiable view of the column source map maintained by this manager.