Package io.deephaven.server.uri

Class BarrageTableResolver

java.lang.Object

io.deephaven.server.uri.BarrageTableResolver

All Implemented Interfaces:

UriResolver

@Singleton
public final class BarrageTableResolver
extends Object
implements UriResolver

The barrage table resolver is able to resolve remote URIs into tables.

For more advanced use cases, see BarrageSession.

See Also:

• remote URI format

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	MAX_INBOUND_MESSAGE_SIZE
static final BarrageSnapshotOptions	SNAP_OPTIONS
static final BarrageSubscriptionOptions	SUB_OPTIONS	The default options, which uses BarrageSubscriptionOptions.useDeephavenNulls().

Constructor Summary

Constructors

Constructor	Description
BarrageTableResolver(SessionFactoryCreator sessionFactoryCreator)

Method Summary

Modifier and Type	Method	Description
static BarrageTableResolver	get()
boolean	isResolvable(URI uri)	Returns true if the resolver can resolve the uri.
Table	resolve(URI uri)	Resolve uri into an object.
Set<String>	schemes()	The supported schemes.
Future<Table>	snapshot(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options)	Create a full snapshot to the table via the target.
Future<Table>	snapshot(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options, RowSet viewport, BitSet columns, boolean reverseViewport)	Create a partial table snapshot to the table via the target.
Future<Table>	snapshot(RemoteUri remoteUri)	Create a full snapshot of the remote URI.
Future<Table>	snapshot(String targetUri, TableSpec table)	Create a full snapshot to the table via the targetUri.
Future<Table>	snapshot(String targetUri, TableSpec table, RowSet viewport, BitSet columns)	Create a partial table snapshot to the table via the targetUri.
Future<Table>	snapshot(String targetUri, TableSpec table, RowSet viewport, BitSet columns, boolean reverseViewport)	Create a partial table snapshot to the table via the targetUri.
Future<Table>	subscribe(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options)	Create a full-subscription to the table via the target.
Future<Table>	subscribe(DeephavenTarget target, TableSpec table, BarrageSubscriptionOptions options, RowSet viewport, BitSet columns, boolean reverseViewport)	Create a partial table subscription to the table via the target.
Future<Table>	subscribe(RemoteUri remoteUri)	Create a full-subscription to the remote URI.
Future<Table>	subscribe(String targetUri, TableSpec table)	Create a full-subscription to the table via the targetUri.
Future<Table>	subscribe(String targetUri, TableSpec table, RowSet viewport, BitSet columns)	Create a partial table subscription to the table via the targetUri.
Future<Table>	subscribe(String targetUri, TableSpec table, RowSet viewport, BitSet columns, boolean reverseViewport)	Create a partial table subscription to the table via the targetUri.

Methods inherited from class java.lang.Object

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

Field Details

MAX_INBOUND_MESSAGE_SIZE

public static final Integer MAX_INBOUND_MESSAGE_SIZE

SUB_OPTIONS

public static final BarrageSubscriptionOptions SUB_OPTIONS

The default options, which uses BarrageSubscriptionOptions.useDeephavenNulls().

SNAP_OPTIONS

public static final BarrageSnapshotOptions SNAP_OPTIONS

Constructor Details

BarrageTableResolver

@Inject
public BarrageTableResolver(SessionFactoryCreator sessionFactoryCreator)

Method Details

get

public static BarrageTableResolver get()

schemes

public Set<String> schemes()

Description copied from interface: UriResolver

The supported schemes.

Specified by:

schemes in interface UriResolver

Returns:

the schemes

isResolvable

public boolean isResolvable(URI uri)

Description copied from interface: UriResolver

Returns true if the resolver can resolve the uri.

Specified by:

isResolvable in interface UriResolver

Parameters:

uri - the uri

Returns:

true if this resolver can resolve uri

resolve

public Table resolve(URI uri)
              throws InterruptedException

Description copied from interface: UriResolver

Resolve uri into an object.

Specified by:

resolve in interface UriResolver

Parameters:

uri - the URI

Returns:

the object

Throws:

InterruptedException - if the current thread is interrupted

subscribe

public Future<Table> subscribe(RemoteUri remoteUri)
                        throws InterruptedException,
TableHandle.TableHandleException

Create a full-subscription to the remote URI. Uses SUB_OPTIONS.

Parameters:

remoteUri - the remote URI

Returns:

the subscribed table

Throws:

InterruptedException

TableHandle.TableHandleException

subscribe

public Future<Table> subscribe(String targetUri,
 TableSpec table)
                        throws TableHandle.TableHandleException,
InterruptedException

Create a full-subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

Returns:

the subscribed table

Throws:

TableHandle.TableHandleException

InterruptedException

subscribe

public Future<Table> subscribe(DeephavenTarget target,
 TableSpec table,
 BarrageSubscriptionOptions options)
                        throws TableHandle.TableHandleException,
InterruptedException

Create a full-subscription to the table via the target.

Parameters:

target - the target

table - the table

options - the options

Returns:

the subscribed table

Throws:

TableHandle.TableHandleException

InterruptedException

subscribe

public Future<Table> subscribe(String targetUri,
 TableSpec table,
 RowSet viewport,
 BitSet columns)
                        throws TableHandle.TableHandleException,
InterruptedException

Create a partial table subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

Returns:

the subscribed table

Throws:

TableHandle.TableHandleException

InterruptedException

subscribe

public Future<Table> subscribe(String targetUri,
 TableSpec table,
 RowSet viewport,
 BitSet columns,
 boolean reverseViewport)
                        throws TableHandle.TableHandleException,
InterruptedException

Create a partial table subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the subscribed table

Throws:

TableHandle.TableHandleException

InterruptedException

subscribe

public Future<Table> subscribe(DeephavenTarget target,
 TableSpec table,
 BarrageSubscriptionOptions options,
 RowSet viewport,
 BitSet columns,
 boolean reverseViewport)
                        throws TableHandle.TableHandleException,
InterruptedException

Create a partial table subscription to the table via the target.

Parameters:

target - the target

table - the table

options - the options

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the subscribed table

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public Future<Table> snapshot(RemoteUri remoteUri)
                       throws InterruptedException,
TableHandle.TableHandleException

Create a full snapshot of the remote URI. Uses SUB_OPTIONS.

Parameters:

remoteUri - the remote URI

Returns:

the table to snapshot

Throws:

InterruptedException

TableHandle.TableHandleException

snapshot

public Future<Table> snapshot(String targetUri,
 TableSpec table)
                       throws TableHandle.TableHandleException,
InterruptedException

Create a full snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

Returns:

the table to snapshot

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public Future<Table> snapshot(DeephavenTarget target,
 TableSpec table,
 BarrageSubscriptionOptions options)
                       throws TableHandle.TableHandleException,
InterruptedException

Create a full snapshot to the table via the target.

Parameters:

target - the target

table - the table

options - the options

Returns:

the table to snapshot

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public Future<Table> snapshot(String targetUri,
 TableSpec table,
 RowSet viewport,
 BitSet columns)
                       throws TableHandle.TableHandleException,
InterruptedException

Create a partial table snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

Returns:

the table to snapshot

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public Future<Table> snapshot(String targetUri,
 TableSpec table,
 RowSet viewport,
 BitSet columns,
 boolean reverseViewport)
                       throws TableHandle.TableHandleException,
InterruptedException

Create a partial table snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the table to snapshot

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public Future<Table> snapshot(DeephavenTarget target,
 TableSpec table,
 BarrageSubscriptionOptions options,
 RowSet viewport,
 BitSet columns,
 boolean reverseViewport)
                       throws TableHandle.TableHandleException,
InterruptedException

Create a partial table snapshot to the table via the target.

Parameters:

target - the target

table - the table

options - the options

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the table to snapshot

Throws:

TableHandle.TableHandleException

InterruptedException