Package io.deephaven.extensions.barrage

Class BarrageMessageWriterImpl.SnapshotView

java.lang.Object

io.deephaven.extensions.barrage.BarrageMessageWriterImpl.SnapshotView

All Implemented Interfaces:

BarrageMessageWriter.MessageView, BarrageMessageWriterImpl.RecordBatchMessageView

Enclosing class:

BarrageMessageWriterImpl

protected class BarrageMessageWriterImpl.SnapshotView
extends Object
implements BarrageMessageWriterImpl.RecordBatchMessageView

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SnapshotView(BarrageSnapshotOptions options, @Nullable RowSet viewport, boolean reverseViewport, @Nullable RowSet keyspaceViewport, @Nullable BitSet subscribedColumns, @Nullable DictionaryWriterRegistry dictionaryRegistry)

Method Summary

Modifier and Type	Method	Description
RowSet	addRowOffsets()
@Nullable DictionaryWriterRegistry	dictionaryRegistry()	Returns the DictionaryWriterRegistry for this stream, or null if no columns use dictionary encoding.
void	forEachStream(Consumer<DefensiveDrainable> visitor)
protected ByteBuffer	getSnapshotMetadata()
boolean	isColumnIncluded(int col)	Whether this view writes the data of column col.
RowSet	modRowOffsets(int col)
BarrageOptions	options()

Methods inherited from class java.lang.Object

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

Constructor Details

SnapshotView

protected SnapshotView(BarrageSnapshotOptions options,
 @Nullable
 @Nullable RowSet viewport,
 boolean reverseViewport,
 @Nullable
 @Nullable RowSet keyspaceViewport,
 @Nullable
 @Nullable BitSet subscribedColumns,
 @Nullable
 @Nullable DictionaryWriterRegistry dictionaryRegistry)

Method Details

isColumnIncluded

public boolean isColumnIncluded(int col)

Description copied from interface: BarrageMessageWriterImpl.RecordBatchMessageView

Whether this view writes the data of column col. A column the view leaves out still gets a field node in every batch, as the schema requires, but no rows: it is written as if the message held no data for it.

Specified by:

isColumnIncluded in interface BarrageMessageWriterImpl.RecordBatchMessageView

Parameters:

col - the column's index in the message

Returns:

whether the view writes the column's added and modified rows

dictionaryRegistry

@Nullable
public @Nullable DictionaryWriterRegistry dictionaryRegistry()

Description copied from interface: BarrageMessageWriterImpl.RecordBatchMessageView

Returns the DictionaryWriterRegistry for this stream, or null if no columns use dictionary encoding. The manager is shared across all batches of the same stream so that DictionaryWriterState instances survive across batch boundaries.

Specified by:

dictionaryRegistry in interface BarrageMessageWriterImpl.RecordBatchMessageView

forEachStream

public void forEachStream(Consumer<DefensiveDrainable> visitor)
                   throws IOException

Specified by:

forEachStream in interface BarrageMessageWriter.MessageView

Throws:

IOException

options

public BarrageOptions options()

Specified by:

options in interface BarrageMessageWriterImpl.RecordBatchMessageView

addRowOffsets

public RowSet addRowOffsets()

Specified by:

addRowOffsets in interface BarrageMessageWriterImpl.RecordBatchMessageView

modRowOffsets

public RowSet modRowOffsets(int col)

Specified by:

modRowOffsets in interface BarrageMessageWriterImpl.RecordBatchMessageView

getSnapshotMetadata

protected ByteBuffer getSnapshotMetadata()
                                  throws IOException

Throws:

IOException