Package com.illumon.iris.controller

Class PersistentQueryClient

java.lang.Object

com.illumon.iris.controller.PersistentQueryClient

All Implemented Interfaces:

IPersistentQueryClient, QueryProcessorConnection.DisconnectHandler

public class PersistentQueryClient
extends Object
implements IPersistentQueryClient

Note:: {PersistentQueryConfiguration, PersistentQueryState, PersistentQueryInfo, PersistentQuery, PersistentQueryClient} replace TableConfiguration.

Constructor Summary

Constructors

Constructor	Description
PersistentQueryClient(PersistentQueryInfo queryInfo, com.fishlib.io.logger.Logger log)
PersistentQueryClient(PersistentQueryInfo queryInfo, com.fishlib.io.logger.Logger log, QueryProcessorConnection.DisconnectHandler disconnectHandler)

Method Summary

Modifier and Type	Method	Description
void	addDisconnectHandler(QueryProcessorConnection.DisconnectHandler disconnectListener)	Add a new handler that knows what to do when this client becomes disconnected.
<T> T	executeConcurrentQuery(RemoteQuery<T> remoteQuery, Class<?>... additionalClasses)
<T> T	executeQuery(RemoteQuery<T> remoteQuery, Class<?>... additionalClasses)
Table	getDbTable(String tableName)	Deprecated.
FetchQuery.ViewportPair	getDbTableViewport(String tableName)
RemoteDatabase	getRemoteDatabase()
Table	getTable(String tableName)	Return a known table specified by its name from this persistent query client's data source.
TableMap	getTableMap(String tableMapName)
FetchQuery.ViewportPair	getTableViewport(String tableName)
LiveWidget	getWidget(String widgetName)
void	onDisconnect()	What to do when this client becomes disconnected from its data source.
IPersistentQueryClient	onTestConnection()	Only used when we have a test client, in which case this provides a method to intercept the typical construction.
void	release()	Close the underlying connection.
void	removeDisconnectHandler(QueryProcessorConnection.DisconnectHandler listenerToRemove)	Remove a known handler for disconnect events.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentQueryClient

public PersistentQueryClient(PersistentQueryInfo queryInfo,
 com.fishlib.io.logger.Logger log)

PersistentQueryClient

public PersistentQueryClient(PersistentQueryInfo queryInfo,
 com.fishlib.io.logger.Logger log,
 @Nullable
 QueryProcessorConnection.DisconnectHandler disconnectHandler)

Method Details

getTable

public Table getTable(String tableName)

Description copied from interface: IPersistentQueryClient

Return a known table specified by its name from this persistent query client's data source.

Specified by:

getTable in interface IPersistentQueryClient

Parameters:

tableName - The name of the table to return.

Returns:

A table by the specified name.

getTableViewport

public FetchQuery.ViewportPair getTableViewport(String tableName)

getWidget

public LiveWidget getWidget(String widgetName)

getTableMap

public TableMap getTableMap(String tableMapName)

getDbTable

@Deprecated
public Table getDbTable(String tableName)

Deprecated.

getDbTableViewport

public FetchQuery.ViewportPair getDbTableViewport(String tableName)

release

public void release()

Description copied from interface: IPersistentQueryClient

Close the underlying connection.

Specified by:

release in interface IPersistentQueryClient

getRemoteDatabase

public RemoteDatabase getRemoteDatabase()

executeQuery

public <T> T executeQuery(RemoteQuery<T> remoteQuery,
 Class<?>... additionalClasses)
                   throws IOException

Throws:

IOException

executeConcurrentQuery

public <T> T executeConcurrentQuery(RemoteQuery<T> remoteQuery,
 Class<?>... additionalClasses)
                             throws Exception

Throws:

Exception

onDisconnect

public void onDisconnect()

Description copied from interface: IPersistentQueryClient

What to do when this client becomes disconnected from its data source.

Specified by:

onDisconnect in interface IPersistentQueryClient

Specified by:

onDisconnect in interface QueryProcessorConnection.DisconnectHandler

See Also:

• QueryProcessorConnection.DisconnectHandler

addDisconnectHandler

public void addDisconnectHandler(QueryProcessorConnection.DisconnectHandler disconnectListener)

Description copied from interface: IPersistentQueryClient

Add a new handler that knows what to do when this client becomes disconnected.

Specified by:

addDisconnectHandler in interface IPersistentQueryClient

Parameters:

disconnectListener - The listener for disconnect events.

removeDisconnectHandler

public void removeDisconnectHandler(QueryProcessorConnection.DisconnectHandler listenerToRemove)

Description copied from interface: IPersistentQueryClient

Remove a known handler for disconnect events.

Specified by:

removeDisconnectHandler in interface IPersistentQueryClient

Parameters:

listenerToRemove - The listener that should be removed.

onTestConnection

public IPersistentQueryClient onTestConnection()

Description copied from interface: IPersistentQueryClient

Only used when we have a test client, in which case this provides a method to intercept the typical construction.

Specified by:

onTestConnection in interface IPersistentQueryClient