Package io.deephaven.web.client.api.barrage

Class WebDictionaryWriterRegistryImpl

java.lang.Object

io.deephaven.web.client.api.barrage.WebDictionaryWriterRegistryImpl

All Implemented Interfaces:

DictionaryWriterRegistry

public final class WebDictionaryWriterRegistryImpl
extends Object
implements DictionaryWriterRegistry

The JS API's DictionaryWriterRegistry. The JS API does not yet write dictionary-encoded columns, so this registry never has any entries; the server implementation is backed by fastutil maps that are not available under GWT.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.extensions.barrage.chunk.DictionaryWriterRegistry

DictionaryWriterRegistry.Entry

Constructor Summary

Constructors

Constructor	Description
WebDictionaryWriterRegistryImpl()

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<DictionaryWriterRegistry.Entry>	entries()	Returns all registered entries.
@NotNull DictionaryWriterState	getOrCreate(long dictId, @NotNull ChunkWriter<Chunk<Values>> valuesWriter, @NotNull ChunkType valuesChunkType)	Returns (or creates) the DictionaryWriterState for the given dictionary id.
boolean	hasAnyDelta()	Returns true if any registered dictionary has a pending delta that needs a DictionaryBatch message.
void	maybeResetEntries(@NotNull LongUnaryOperator maxSizeForDictId)	Resets each registered DictionaryWriterState whose totalSize exceeds the limit maxSizeForDictId gives for its dictionary id, so the next DictionaryBatch will be isDelta=false with a compacted dictionary.
void	resetDeltas()	Advances the delta boundary for every registered state that currently has a pending delta.

Methods inherited from class java.lang.Object

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

Constructor Details

WebDictionaryWriterRegistryImpl

public WebDictionaryWriterRegistryImpl()

Method Details

getOrCreate

@NotNull
public @NotNull DictionaryWriterState getOrCreate(long dictId,
 @NotNull
 @NotNull ChunkWriter<Chunk<Values>> valuesWriter,
 @NotNull
 @NotNull ChunkType valuesChunkType)

Description copied from interface: DictionaryWriterRegistry

Returns (or creates) the DictionaryWriterState for the given dictionary id.

The first call for a given dictId registers the valuesWriter for that id and creates the appropriate state type. Subsequent calls for the same id return the existing state.

Specified by:

getOrCreate in interface DictionaryWriterRegistry

entries

@NotNull
public @NotNull Collection<DictionaryWriterRegistry.Entry> entries()

Description copied from interface: DictionaryWriterRegistry

Returns all registered entries.

Specified by:

entries in interface DictionaryWriterRegistry

hasAnyDelta

public boolean hasAnyDelta()

Description copied from interface: DictionaryWriterRegistry

Returns true if any registered dictionary has a pending delta that needs a DictionaryBatch message.

Specified by:

hasAnyDelta in interface DictionaryWriterRegistry

resetDeltas

public void resetDeltas()

Description copied from interface: DictionaryWriterRegistry

Advances the delta boundary for every registered state that currently has a pending delta.

Specified by:

resetDeltas in interface DictionaryWriterRegistry

maybeResetEntries

public void maybeResetEntries(@NotNull
 @NotNull LongUnaryOperator maxSizeForDictId)

Description copied from interface: DictionaryWriterRegistry

Resets each registered DictionaryWriterState whose totalSize exceeds the limit maxSizeForDictId gives for its dictionary id, so the next DictionaryBatch will be isDelta=false with a compacted dictionary. This applies to local (viewport/snapshot) registries only; a shared-backed registry ignores this call, as its SharedWriterDictionary is reset externally.

Specified by:

maybeResetEntries in interface DictionaryWriterRegistry

Parameters:

maxSizeForDictId - the most values the dictionary with a given id may hold before it is reset; typically no more than the live row count visible to the subscription