Package io.deephaven.web.client.api.subscription

Class TableSubscription

java.lang.Object

io.deephaven.web.client.api.event.HasEventHandling

io.deephaven.web.client.api.subscription.AbstractTableSubscription

io.deephaven.web.client.api.subscription.TableSubscription

@JsType(namespace="dh")
public final class TableSubscription
extends AbstractTableSubscription

Represents a non-viewport subscription to a table, and all data currently known to be present in the subscribed columns. This class handles incoming snapshots and deltas, and fires events to consumers to notify of data changes.

Unlike TableViewportSubscription, the "original" table does not have a reference to this instance, only the "private" table instance does, since the original cannot modify the subscription, and the private instance must forward data to it.

Represents a subscription to the table on the server. Changes made to the table will not be reflected here - the subscription must be closed and a new one optioned to see those changes. The event model is slightly different from viewports to make it less expensive to compute for large tables.

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.web.client.api.subscription.AbstractTableSubscription

AbstractTableSubscription.Status, AbstractTableSubscription.SubscriptionEventData, AbstractTableSubscription.SubscriptionRow, AbstractTableSubscription.UpdateEventData, AbstractTableSubscription.ViewportEventData

Nested classes/interfaces inherited from class io.deephaven.web.client.api.event.HasEventHandling

HasEventHandling.EventPair<T>

Field Summary

Fields inherited from class io.deephaven.web.client.api.subscription.AbstractTableSubscription

barrageSubscription, EVENT_UPDATED, rowStyleColumn, status, viewportRowSet

Fields inherited from class io.deephaven.web.client.api.event.HasEventHandling

INTERNAL_EVENT_RELEASED

Method Summary

Modifier and Type	Method	Description
void	changeSubscription(elemental2.core.JsArray<Column> columns, @JsNullable Double updateIntervalMs)	Updates the subscription to use the given columns and update interval.
static TableSubscription	createTableSubscription(DataOptions.SubscriptionOptions options, JsTable existingTable)
elemental2.core.JsArray<Column>	getColumns()	The columns that were subscribed to when this subscription was created
protected void	sendFirstSubscriptionRequest()
void	update(@TsTypeRef(SubscriptionOptions.class) Object options)	Update the options for this viewport subscription.

Methods inherited from class io.deephaven.web.client.api.subscription.AbstractTableSubscription

close, connection, createPreview, getPreviewListLengthLimit, hasValidSize, isClosed, isSubscriptionReady, makeColumnBitset, notifyUpdate, onStreamEnd, revive, sendBarrageSubscriptionRequest, size, state, subscriptionRequest

Methods inherited from class io.deephaven.web.client.api.event.HasEventHandling

addEventListener, addEventListenerOneShot, addEventListenerOneShot, failureHandled, fireCriticalEvent, fireCriticalEvent, fireEvent, fireEvent, fireEvent, hasListener, hasListeners, isSuppress, logPrefix, nextEvent, removeEventListener, suppressEvents, unsuppressEvents

Methods inherited from class java.lang.Object

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

Method Details

createTableSubscription

public static TableSubscription createTableSubscription(DataOptions.SubscriptionOptions options,
 JsTable existingTable)

sendFirstSubscriptionRequest

protected void sendFirstSubscriptionRequest()

Specified by:

sendFirstSubscriptionRequest in class AbstractTableSubscription

changeSubscription

public void changeSubscription(elemental2.core.JsArray<Column> columns,
 @JsNullable Double updateIntervalMs)

Updates the subscription to use the given columns and update interval.

Parameters:

columns - the new columns to subscribe to

updateIntervalMs - the new update interval, or null/omit to use the default of one second

update

@JsMethod
public void update(@TsTypeRef(SubscriptionOptions.class)
 @TsTypeRef(SubscriptionOptions.class) Object options)

Update the options for this viewport subscription. This cannot alter the update interval or preview options.

Parameters:

options - the subscription options

getColumns

@JsProperty
public elemental2.core.JsArray<Column> getColumns()

Description copied from class: AbstractTableSubscription

The columns that were subscribed to when this subscription was created

Overrides:

getColumns in class AbstractTableSubscription

Returns:

Column