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

Class WebBarrageSubscription

java.lang.Object

io.deephaven.web.client.api.barrage.data.WebBarrageSubscription

Direct Known Subclasses:

WebBarrageSubscription.BlinkImpl, WebBarrageSubscription.RedirectedImpl, WebBarrageSubscription.ViewportImpl

public abstract class WebBarrageSubscription
extends Object

In contrast to the server implementation, the JS API holds the "table" as distinct from the "subscription", so that developers are acutely aware of extra async costs in requesting data, and can clearly indicate how much data is requested. This class represents a barrage subscription for the JS API, and exposes access to the data presently available on the client.

This is a rough analog to BarrageTable and its subtypes, but isn't directly exposed to API consumers. Instead, the subscription types wrap this, and delegate their data storage and snapshot/delta handling here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebBarrageSubscription.BlinkImpl
static interface	WebBarrageSubscription.DataChangedHandler
static class	WebBarrageSubscription.RedirectedImpl
static interface	WebBarrageSubscription.ViewportChangedHandler
static class	WebBarrageSubscription.ViewportImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATCH_SIZE
protected long	capacity
static final boolean	COLUMNS_AS_LIST
protected final RangeSet	currentRowSet
protected final WebBarrageSubscription.DataChangedHandler	dataChangedHandler
protected WebColumnData[]	destSources
static final int	MAX_MESSAGE_SIZE
protected BitSet	serverColumns
protected boolean	serverReverseViewport
protected RangeSet	serverViewport
protected final ClientTableState	state
protected final WebBarrageSubscription.ViewportChangedHandler	viewportChangedHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebBarrageSubscription(ClientTableState state, WebBarrageSubscription.ViewportChangedHandler viewportChangedHandler, WebBarrageSubscription.DataChangedHandler dataChangedHandler, WebColumnData[] dataSinks)

Method Summary

Modifier and Type	Method	Description
abstract void	applyUpdates(WebBarrageMessage message)
RangeSet	getCurrentRowSet()
long	getCurrentSize()
abstract jsinterop.base.Any	getData(long key, int col)	Reads a value from the table subscription.
RangeSet	getServerViewport()
boolean	isReversed()
protected boolean	isSubscribedColumn(int ii)
protected int	numColumns()
static WebBarrageSubscription	subscribe(SubscriptionType subscriptionType, ClientTableState cts, WebBarrageSubscription.ViewportChangedHandler viewportChangedHandler, WebBarrageSubscription.DataChangedHandler dataChangedHandler)
protected void	updateServerViewport(RangeSet viewport, BitSet columns, boolean reverseViewport)

Methods inherited from class java.lang.Object

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

Field Details

COLUMNS_AS_LIST

public static final boolean COLUMNS_AS_LIST

See Also:

• Constant Field Values

MAX_MESSAGE_SIZE

public static final int MAX_MESSAGE_SIZE

See Also:

• Constant Field Values

BATCH_SIZE

public static final int BATCH_SIZE

See Also:

• Constant Field Values

state

protected final ClientTableState state

viewportChangedHandler

protected final WebBarrageSubscription.ViewportChangedHandler viewportChangedHandler

dataChangedHandler

protected final WebBarrageSubscription.DataChangedHandler dataChangedHandler

currentRowSet

protected final RangeSet currentRowSet

capacity

protected long capacity

destSources

protected WebColumnData[] destSources

serverViewport

protected RangeSet serverViewport

serverColumns

protected BitSet serverColumns

serverReverseViewport

protected boolean serverReverseViewport

Constructor Details

WebBarrageSubscription

protected WebBarrageSubscription(ClientTableState state,
 WebBarrageSubscription.ViewportChangedHandler viewportChangedHandler,
 WebBarrageSubscription.DataChangedHandler dataChangedHandler,
 WebColumnData[] dataSinks)

Method Details

subscribe

public static WebBarrageSubscription subscribe(SubscriptionType subscriptionType,
 ClientTableState cts,
 WebBarrageSubscription.ViewportChangedHandler viewportChangedHandler,
 WebBarrageSubscription.DataChangedHandler dataChangedHandler)

applyUpdates

public abstract void applyUpdates(WebBarrageMessage message)

getCurrentSize

public long getCurrentSize()

Returns:

the current size of the table

updateServerViewport

protected void updateServerViewport(RangeSet viewport,
 BitSet columns,
 boolean reverseViewport)

numColumns

protected int numColumns()

getCurrentRowSet

public RangeSet getCurrentRowSet()

getServerViewport

public RangeSet getServerViewport()

isReversed

public boolean isReversed()

getData

public abstract jsinterop.base.Any getData(long key,
 int col)

Reads a value from the table subscription.

Parameters:

key - the row to read in key-space

col - the index of the column to read

Returns:

the value read from the table

isSubscribedColumn

protected boolean isSubscribedColumn(int ii)