Package se.kuseman.payloadbuilder.api.execution

Interface IQuerySession

public interface IQuerySession

Definition of a query session.

Method Summary

Modifier and Type	Method	Description
boolean	abortQuery()	Returns true if the query should be aborted
ValueVector	getCatalogProperty(String alias, String key)	Get catalog property.
default ValueVector	getCatalogProperty(String alias, String key, ValueVector defaultValue)	Get catalog property with default value support
String	getDefaultCatalogAlias()	Get the current default catalog alias
GenericCache	getGenericCache()	Get the generic cache
long	getLastQueryExecutionTime()	Return the execution time in ms.
long	getLastQueryRowCount()	Return the row count for the last executed statement
Writer	getPrintWriter()	Get the print writer used for message outputs
Catalog	getSystemCatalog()	Returns the system catalog
default void	handleKnownException(Exception e)	Handle known exception from catalogs.
void	registerAbortListener(Runnable listener)	Register an abort query listener to session.
default void	setCatalogProperty(String catalogAlias, String key, boolean value)	Set boolean catalog property
default void	setCatalogProperty(String catalogAlias, String key, int value)	Set integer catalog property
default void	setCatalogProperty(String catalogAlias, String key, Object value)	Set object catalog property
default void	setCatalogProperty(String catalogAlias, String key, String value)	Set string catalog property
void	setCatalogProperty(String catalogAlias, String key, ValueVector value)	Set catalog property
void	unregisterAbortListener(Runnable listener)	Unregister provided abort listener

Method Details

getSystemCatalog

Catalog getSystemCatalog()

Returns the system catalog

getDefaultCatalogAlias

String getDefaultCatalogAlias()

Get the current default catalog alias

getCatalogProperty

ValueVector getCatalogProperty(String alias,
 String key)

Get catalog property. If no value is found a null ValueVector is returned

getCatalogProperty

default ValueVector getCatalogProperty(String alias,
 String key,
 ValueVector defaultValue)

Get catalog property with default value support

setCatalogProperty

void setCatalogProperty(String catalogAlias,
 String key,
 ValueVector value)

Set catalog property

setCatalogProperty

default void setCatalogProperty(String catalogAlias,
 String key,
 String value)

Set string catalog property

setCatalogProperty

default void setCatalogProperty(String catalogAlias,
 String key,
 int value)

Set integer catalog property

setCatalogProperty

default void setCatalogProperty(String catalogAlias,
 String key,
 boolean value)

Set boolean catalog property

setCatalogProperty

default void setCatalogProperty(String catalogAlias,
 String key,
 Object value)

Set object catalog property

getGenericCache

GenericCache getGenericCache()

Get the generic cache

abortQuery

boolean abortQuery()

Returns true if the query should be aborted

registerAbortListener

void registerAbortListener(Runnable listener)

Register an abort query listener to session. This is called if the query should be aborted and IDatasource's can register to close connections etc. NOTE! Are called on a separate thread from the thread that executes the query

unregisterAbortListener

void unregisterAbortListener(Runnable listener)

Unregister provided abort listener

getPrintWriter

Writer getPrintWriter()

Get the print writer used for message outputs

handleKnownException

default void handleKnownException(Exception e)

Handle known exception from catalogs. For example a SQLException that is thrown during execution but is not crucial for the whole execution.

getLastQueryExecutionTime

long getLastQueryExecutionTime()

Return the execution time in ms. for the last executed statement

getLastQueryRowCount

long getLastQueryRowCount()

Return the row count for the last executed statement