Package com.illumon.iris.db.tables.remote

Class RemoteTableHandle

java.lang.Object

com.illumon.iris.db.tables.remote.RemoteTableHandle

All Implemented Interfaces:

LongSizedDataStructure, Closeable, AutoCloseable, InvocationHandler

public class RemoteTableHandle
extends Object
implements InvocationHandler, Closeable, LongSizedDataStructure

Client-side handle for a remote table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteTableHandle.Descriptor	Descriptor object for serialization surrogate.
static class	RemoteTableHandle.DisconnectedException
static class	RemoteTableHandle.FlatIndexInvocationHandler
static interface	RemoteTableHandle.TableProxy	TableProxy interface, hijacked below.
static class	RemoteTableHandle.ViewportAndClient

Field Summary

Fields

Modifier and Type	Field	Description
static final io.deephaven.hash.KeyedIntObjectKey<RemoteTableHandle>	KEY

Constructor Summary

Constructors

Constructor	Description
RemoteTableHandle(RemoteTableHandleManager tableManager, com.fishlib.io.logger.Logger log, ExportedTableCreationMessage creationMessage)

Method Summary

Modifier and Type	Method	Description
void	addReferent(Object referent)
void	close()
Object	getAttribute(String name)	Get the value for the specified attribute.
Set<String>	getAttributeNames()
DataColumn[]	getColumns()
TableDefinition	getDefinition()
Object	getDirect(int columnIndex)	Retrieve the entire column specified from the underlying table.
InitialSnapshot	getDirect(BitSet columns)	Retrieve the data for all of the specified columns.
InitialSnapshot	getDirect(BitSet columns, Index positions)	Retrieve the specified rows (by position) for the specified columns
int	getId()
MutableInputTable	getInputTable()
RemoteTableHandleManager	getTableManager()
ReplicatedTable	getViewport(RemoteTableHandle.TableProxy tableProxy)
RemoteTableHandle.ViewportAndClient	getViewportWithClient(RemoteTableHandle.TableProxy tableProxy, boolean allocateClient)
boolean	hasAttribute(String name)	See if the table has the specified attribute.
Object	invoke(Object proxy, Method method, Object[] args)
boolean	isFlat()	Does this RemoteTableHandle represent a flat table?
boolean	isLive()
void	listenToTableErrors(ListenerBase listener)
void	listenToTableSizeUpdates(LongConsumer longConsumer)
Map<String,Object>	preFetchAttributesForProxy(Collection<String> preFetch, Object proxy)
void	removeErrorListener(ListenerBase errorListener)
void	removeErrorListeners()
void	removeSizeUpdateListener(LongConsumer longConsumer)
void	removeViewPort(ReplicatedTable viewport)
RemoteTableHandle.TableProxy	resolve()
void	setViewportTableProxy(RemoteTableHandle.TableProxy viewportTableProxy)	Set this client's viewport to the provided handle.
long	size()	The size of this data structure.
ReplicatedTable	subscribeToPreemptiveUpdates(RemoteTableHandle.TableProxy tableProxy, boolean isViewPort)
String	toString()
void	unsubscribeFromPreemptiveUpdates()
Future<Boolean>	updatePreemptiveSubscriptionAsync(BitSet newColumns)
Future<Boolean>	updatePreemptiveViewportAndColumnsAsync(Index newViewPort, BitSet columns)
Future<Boolean>	updatePreemptiveViewportAsync(Index newViewPort)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.util.LongSizedDataStructure

intSize, intSize

Field Details

KEY

public static final io.deephaven.hash.KeyedIntObjectKey<RemoteTableHandle> KEY

Constructor Details

RemoteTableHandle

public RemoteTableHandle(RemoteTableHandleManager tableManager,
 com.fishlib.io.logger.Logger log,
 ExportedTableCreationMessage creationMessage)

Method Details

getTableManager

public RemoteTableHandleManager getTableManager()

addReferent

public void addReferent(@NotNull
 Object referent)

getId

public int getId()

isLive

public boolean isLive()

resolve

public RemoteTableHandle.TableProxy resolve()

hasAttribute

public boolean hasAttribute(String name)

See if the table has the specified attribute.

getAttribute

public Object getAttribute(String name)

Get the value for the specified attribute. If the attribute was not cached locally it will attempt to retrieve it.

preFetchAttributesForProxy

public Map<String,Object> preFetchAttributesForProxy(@NotNull
 Collection<String> preFetch,
 @Nullable
 Object proxy)

getAttributeNames

public Set<String> getAttributeNames()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isFlat

public boolean isFlat()

Does this RemoteTableHandle represent a flat table?

subscribeToPreemptiveUpdates

@VisibleForTesting
public ReplicatedTable subscribeToPreemptiveUpdates(@NotNull
 RemoteTableHandle.TableProxy tableProxy,
 boolean isViewPort)

unsubscribeFromPreemptiveUpdates

public void unsubscribeFromPreemptiveUpdates()

removeViewPort

public void removeViewPort(ReplicatedTable viewport)

updatePreemptiveSubscriptionAsync

public Future<Boolean> updatePreemptiveSubscriptionAsync(BitSet newColumns)

updatePreemptiveViewportAsync

public Future<Boolean> updatePreemptiveViewportAsync(Index newViewPort)

updatePreemptiveViewportAndColumnsAsync

public Future<Boolean> updatePreemptiveViewportAndColumnsAsync(Index newViewPort,
 BitSet columns)

invoke

public Object invoke(Object proxy,
 Method method,
 Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

getInputTable

@Nullable
public MutableInputTable getInputTable()

getColumns

public DataColumn[] getColumns()

listenToTableErrors

public void listenToTableErrors(ListenerBase listener)

removeErrorListener

public void removeErrorListener(ListenerBase errorListener)

removeErrorListeners

public void removeErrorListeners()

listenToTableSizeUpdates

public void listenToTableSizeUpdates(LongConsumer longConsumer)

removeSizeUpdateListener

public void removeSizeUpdateListener(LongConsumer longConsumer)

getDirect

public Object getDirect(int columnIndex)

Retrieve the entire column specified from the underlying table.

Parameters:

columnIndex - the index of the column

Returns:

an array containing the data of the column.

getDirect

public InitialSnapshot getDirect(BitSet columns)

Retrieve the data for all of the specified columns.

Parameters:

columns - the columns to retrieve.

Returns:

an InitialSnapshot containing the data. Users may use InitialSnapshotTable.setupInitialSnapshotTable(Table, InitialSnapshot) to convert it into a QueryTable

getDirect

public InitialSnapshot getDirect(BitSet columns,
 Index positions)

Retrieve the specified rows (by position) for the specified columns

Parameters:

columns - the columns to get data for

positions - an index of positions to retrieve.

Returns:

an InitialSnapshot containing the data. Users may use InitialSnapshotTable.setupInitialSnapshotTable(Table, InitialSnapshot) to convert it into a QueryTable

getViewport

public ReplicatedTable getViewport(@NotNull
 RemoteTableHandle.TableProxy tableProxy)

getViewportWithClient

public RemoteTableHandle.ViewportAndClient getViewportWithClient(@NotNull
 RemoteTableHandle.TableProxy tableProxy,
 boolean allocateClient)

setViewportTableProxy

public void setViewportTableProxy(RemoteTableHandle.TableProxy viewportTableProxy)

Set this client's viewport to the provided handle. It is up to the caller to ensure that the viewport actually matches this table, or undefined results occur. The handle must be flat and preemptive.

Parameters:

viewportTableProxy - the handle to use for our viewport

getDefinition

public TableDefinition getDefinition()

size

public long size()

Description copied from interface: LongSizedDataStructure

The size of this data structure.

Specified by:

size in interface LongSizedDataStructure

Returns:

The size

toString

public String toString()

Overrides:

toString in class Object