Package io.deephaven.server.uri

Class BarrageTableResolver

java.lang.Object
io.deephaven.server.uri.BarrageTableResolver
All Implemented Interfaces:
io.deephaven.uri.resolver.UriResolver
@Singleton public final class BarrageTableResolver extends Object implements io.deephaven.uri.resolver.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 io.deephaven.extensions.barrage.BarrageSnapshotOptions
    SNAP_OPTIONS
     
    static final io.deephaven.extensions.barrage.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)
     
    io.deephaven.engine.table.Table
    resolve(URI uri)
     
    Set<String>
    schemes()
     
    Future<io.deephaven.engine.table.Table>
    snapshot(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options)
    Create a full snapshot to the table via the target.
    Future<io.deephaven.engine.table.Table>
    snapshot(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport)
    Create a partial table snapshot to the table via the target.
    Future<io.deephaven.engine.table.Table>
    snapshot(io.deephaven.uri.RemoteUri remoteUri)
    Create a full snapshot of the remote URI.
    Future<io.deephaven.engine.table.Table>
    snapshot(String targetUri, io.deephaven.qst.table.TableSpec table)
    Create a full snapshot to the table via the targetUri.
    Future<io.deephaven.engine.table.Table>
    snapshot(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns)
    Create a partial table snapshot to the table via the targetUri.
    Future<io.deephaven.engine.table.Table>
    snapshot(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport)
    Create a partial table snapshot to the table via the targetUri.
    Future<io.deephaven.engine.table.Table>
    subscribe(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options)
    Create a full-subscription to the table via the target.
    Future<io.deephaven.engine.table.Table>
    subscribe(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport)
    Create a partial table subscription to the table via the target.
    Future<io.deephaven.engine.table.Table>
    subscribe(io.deephaven.uri.RemoteUri remoteUri)
    Create a full-subscription to the remote URI.
    Future<io.deephaven.engine.table.Table>
    subscribe(String targetUri, io.deephaven.qst.table.TableSpec table)
    Create a full-subscription to the table via the targetUri.
    Future<io.deephaven.engine.table.Table>
    subscribe(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns)
    Create a partial table subscription to the table via the targetUri.
    Future<io.deephaven.engine.table.Table>
    subscribe(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.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 io.deephaven.extensions.barrage.BarrageSubscriptionOptions SUB_OPTIONS
      The default options, which uses BarrageSubscriptionOptions.useDeephavenNulls().

    • SNAP_OPTIONS

      public static final io.deephaven.extensions.barrage.BarrageSnapshotOptions SNAP_OPTIONS

  • Constructor Details

    • BarrageTableResolver

      @Inject public BarrageTableResolver(SessionFactoryCreator sessionFactoryCreator)

  • Method Details

    • get

      public static BarrageTableResolver get()

    • schemes

      public Set<String> schemes()
      Specified by:
      schemes in interface io.deephaven.uri.resolver.UriResolver

    • isResolvable

      public boolean isResolvable(URI uri)
      Specified by:
      isResolvable in interface io.deephaven.uri.resolver.UriResolver

    • resolve

      public io.deephaven.engine.table.Table resolve(URI uri) throws InterruptedException
      Specified by:
      resolve in interface io.deephaven.uri.resolver.UriResolver
      Throws:
      InterruptedException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(io.deephaven.uri.RemoteUri remoteUri) throws InterruptedException, io.deephaven.client.impl.TableHandle.TableHandleException
      Create a full-subscription to the remote URI. Uses SUB_OPTIONS.
      Parameters:
      remoteUri - the remote URI
      Returns:
      the subscribed table
      Throws:
      InterruptedException
      io.deephaven.client.impl.TableHandle.TableHandleException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(String targetUri, io.deephaven.qst.table.TableSpec table) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • subscribe

      public Future<io.deephaven.engine.table.Table> subscribe(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(io.deephaven.uri.RemoteUri remoteUri) throws InterruptedException, io.deephaven.client.impl.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
      io.deephaven.client.impl.TableHandle.TableHandleException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(String targetUri, io.deephaven.qst.table.TableSpec table) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(String targetUri, io.deephaven.qst.table.TableSpec table, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException

    • snapshot

      public Future<io.deephaven.engine.table.Table> snapshot(io.deephaven.uri.DeephavenTarget target, io.deephaven.qst.table.TableSpec table, io.deephaven.extensions.barrage.BarrageSubscriptionOptions options, io.deephaven.engine.rowset.RowSet viewport, BitSet columns, boolean reverseViewport) throws io.deephaven.client.impl.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:
      io.deephaven.client.impl.TableHandle.TableHandleException
      InterruptedException