Package io.deephaven.client.impl

Class TableHandle

java.lang.Object
io.deephaven.api.TableOperationsAdapter<TOPS,TABLE,io.deephaven.qst.table.TableSpec,io.deephaven.qst.table.TableSpec>
io.deephaven.qst.table.TableSpecAdapter<TableHandle,TableHandle>
io.deephaven.client.impl.TableHandle
All Implemented Interfaces:
io.deephaven.api.TableOperations<TableHandle,TableHandle>, io.deephaven.api.TableOperationsDefaults<TableHandle,TableHandle>, HasExportId, HasPathId, HasTicketId, HasTypedTicket, Closeable, AutoCloseable
public final class TableHandle extends io.deephaven.qst.table.TableSpecAdapter<TableHandle,TableHandle> implements HasExportId, Closeable
A table handle implements TableOperations such that each the initial table handle and derived table handles are managed as exports.

A table handle may only be combined with other table handles from the same session.

A table handle throws TableHandle.UncheckedInterruptedException and TableHandle.UncheckedTableHandleException on further TableOperations.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    final class 
    TableHandle.TableHandleException
     
    final class 
    TableHandle.UncheckedInterruptedException
     
    final class 
    TableHandle.UncheckedTableHandleException
     

  • Field Summary

    Fields inherited from interface io.deephaven.api.TableOperations

    AGG_BY_PRESERVE_EMPTY_DEFAULT

    Fields inherited from interface io.deephaven.api.TableOperationsDefaults

    ZERO_LENGTH_COLUMNNAME_ARRAY, ZERO_LENGTH_FILTER_ARRAY

  • Method Summary

    Modifier and Type
    Method
    Description
    protected io.deephaven.qst.table.TableSpec
    adapt(TableHandle rhs)
     
    protected TableHandle
    adapt(io.deephaven.qst.table.TableSpec table)
     
    void
    await()
    Causes the current thread to wait until this is done, unless the thread is interrupted.
    boolean
    await(Duration timeout)
    Causes the current thread to wait until this is done, unless the thread is interrupted, or timeout elapses.
    void
    awaitUnchecked()
     
    void
    close()
    Closes the underlying export.
    Optional<TableHandle.TableHandleException>
    error()
    The table handle has an error when the response from the server indicates an error.
    Export
    export()
     
    ExportId
    exportId()
    Get the export ID.
    boolean
    isDone()
    The table proxy is done when the response from the server is done, which yields either a successful response or an error.
    boolean
    isSuccessful()
    The table proxy is successful when the response from the server indicates success.
    TableHandle
    newRef()
     
    PathId
    pathId()
    Get the path ID.
    io.deephaven.proto.backplane.grpc.ExportedTableCreationResponse
    response()
     
    void
    throwOnError()
     
    void
    throwOnErrorUnchecked()
     
    TicketId
    ticketId()
    Get the ticket ID.
    TypedTicket
    typedTicket()
    Get the typed ticket.

    Methods inherited from class io.deephaven.qst.table.TableSpecAdapter

    table

    Methods inherited from class io.deephaven.api.TableOperationsAdapter

    aggAllBy, aggBy, asOfJoin, delegate, dropColumns, exactJoin, head, join, join, lazyUpdate, naturalJoin, rangeJoin, reverse, select, selectDistinct, selectDistinct, snapshot, snapshotWhen, snapshotWhen, snapshotWhen, sort, tail, ungroup, update, updateBy, updateView, view, where, whereIn, whereNotIn

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.deephaven.api.TableOperationsDefaults

    absSumBy, absSumBy, absSumBy, absSumBy, aggAllBy, aggAllBy, aggAllBy, aggBy, aggBy, aggBy, aggBy, aggBy, aggBy, aggBy, aj, aj, avgBy, avgBy, avgBy, avgBy, countBy, countBy, countBy, countBy, dropColumns, dropColumns, exactJoin, exactJoin, firstBy, firstBy, firstBy, firstBy, groupBy, groupBy, groupBy, join, join, join, lastBy, lastBy, lastBy, lastBy, lazyUpdate, maxBy, maxBy, maxBy, maxBy, medianBy, medianBy, medianBy, medianBy, minBy, minBy, minBy, minBy, naturalJoin, naturalJoin, raj, raj, rangeJoin, select, select, selectDistinct, sort, sortDescending, stdBy, stdBy, stdBy, stdBy, sumBy, sumBy, sumBy, sumBy, ungroup, ungroup, ungroup, ungroup, update, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateBy, updateView, varBy, varBy, varBy, varBy, view, wavgBy, wavgBy, wavgBy, wavgBy, where, whereIn, whereNotIn, wsumBy, wsumBy, wsumBy, wsumBy

  • Method Details

    • exportId

      public ExportId exportId()
      Description copied from interface: HasExportId
      Get the export ID.
      Specified by:
      exportId in interface HasExportId
      Returns:
      the export ID

    • ticketId

      public TicketId ticketId()
      Description copied from interface: HasTicketId
      Get the ticket ID.
      Specified by:
      ticketId in interface HasTicketId
      Returns:
      the ticket ID

    • typedTicket

      public TypedTicket typedTicket()
      Description copied from interface: HasTypedTicket
      Get the typed ticket.
      Specified by:
      typedTicket in interface HasTypedTicket
      Returns:
      the typed ticket

    • pathId

      public PathId pathId()
      Description copied from interface: HasPathId
      Get the path ID.
      Specified by:
      pathId in interface HasPathId
      Returns:
      the path ID

    • newRef

      public TableHandle newRef()

    • export

      public Export export()

    • await

      public void await() throws InterruptedException
      Causes the current thread to wait until this is done, unless the thread is interrupted.
      Throws:
      InterruptedException - if the current thread is interrupted while waiting

    • awaitUnchecked

      public void awaitUnchecked()

    • await

      public boolean await(Duration timeout) throws InterruptedException
      Causes the current thread to wait until this is done, unless the thread is interrupted, or timeout elapses.
      Parameters:
      timeout - the timeout
      Returns:
      true if this has become is done and false if the timeout has elapsed
      Throws:
      InterruptedException - if the current thread is interrupted while waiting

    • isDone

      public boolean isDone()
      The table proxy is done when the response from the server is done, which yields either a successful response or an error.

      Note: the table proxy can create further derived table proxies before being done.

      Returns:
      true if this is done
      See Also:

    • isSuccessful

      public boolean isSuccessful()
      The table proxy is successful when the response from the server indicates success.
      Returns:
      true if the response from the server indicates success and false if the response indicates it was not successful or there has been no response yet
      See Also:

    • response

      public io.deephaven.proto.backplane.grpc.ExportedTableCreationResponse response()

    • error

      public Optional<TableHandle.TableHandleException> error()
      The table handle has an error when the response from the server indicates an error.
      Returns:
      the error, if any
      See Also:

    • throwOnError

      public void throwOnError() throws TableHandle.TableHandleException
      Throws:
      TableHandle.TableHandleException

    • throwOnErrorUnchecked

      public void throwOnErrorUnchecked()

    • adapt

      protected TableHandle adapt(io.deephaven.qst.table.TableSpec table)
      Specified by:
      adapt in class io.deephaven.api.TableOperationsAdapter<TableHandle,TableHandle,io.deephaven.qst.table.TableSpec,io.deephaven.qst.table.TableSpec>

    • adapt

      protected io.deephaven.qst.table.TableSpec adapt(TableHandle rhs)
      Specified by:
      adapt in class io.deephaven.api.TableOperationsAdapter<TableHandle,TableHandle,io.deephaven.qst.table.TableSpec,io.deephaven.qst.table.TableSpec>

    • close

      public void close()
      Closes the underlying export.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable