com.apama.config
Event ConfigurationTableInterface


Abstract interface to a configuration table within a configuration store.

An instance of the table interface is obtained from a #ConfigurationStoreInterface by calling an action such as #ConfigurationStoreInterface.getTable() or #ConfigurationStoreInterface.createTable().

Some actions on the table interface (#updateRow(), #deleteRow()) are asynchronous and signal their success or failure through callback actions. All such actions take an integer request id as their first parameter. This id will be passed back as the first argument to the callback, to allow the callback to distinguish between multiple overlapping requests. Request ids must be unique across all possible invocations of the callback, in the current context. Ids returned by the integer.getUnique() method will always be sufficiently unique, although it may be possible to use a less unique id that is cheaper to generate, depending on the application.

Default callback implementations are provided for applications that do not need to implement custom success/failure handling or that prefer to listen for success/failure notifications rather than using callbacks directly. The default callbacks simply route an event containing the parameters that were passed to the callback.

Calling any action except on a table interface that has not been obtained from a properly initialised #ConfigurationStoreInterface will lead to undefined behaviour.
Member summary
 action<> returns com.apama.config.SchemagetSchema

Get the schema for the table.
 action<sequence<string>> returns stringmakeKey

Create a composite key for a row. This operation may be relatively expensive so it it recommended that the result is cached in a 'wrapper' object for the row if it is needed more than once.
 action<string> returns booleanhasRow

Check if the table contains the given row.
 action<string> returns com.apama.memorystore.RowgetRow

Get the contents of the given row. The result is undefined if the row does not exist.
 action<> returns com.apama.memorystore.Iteratorbegin

Get an iterator pointing to the first row in the table.
 action<integer, string, com.apama.memorystore.Row, action<integer>, action<integer, string>>updateRow

Add or update a row in the table.
 action<integer, string, action<integer>, action<integer, string>>deleteRow

Delete a row from the table. If the row does not exist this action will act as thought the row was successfully deleted.
 action<integer>updateRowSuccess

Default onSuccess callback for the #updateRow() action, if the application does not want to provide a custom callback.
 action<integer>deleteRowSuccess

Default onSuccess callback for the #deleteRow() action, if the application does not want to provide a custom callback.
 action<integer, string>defaultError

Default onError callback for all asynchronous actions provided by the #ConfigurationTableInterface, if the application does not want to provide a custom callback.
 
Member detail

begin

action<> returns com.apama.memorystore.Iterator begin
Get an iterator pointing to the first row in the table.

defaultError

action<integer, string> defaultError
Default onError callback for all asynchronous actions provided by the #ConfigurationTableInterface, if the application does not want to provide a custom callback.

The default callback simply routes a #TableRequestFailure event. To use the default callback, pass tableInterface.defaultError as the onError parameter to the request.
See Also:
#updateRow - 
#deleteRow - 

deleteRow

action<integer, string, action<integer>, action<integer, string>> deleteRow
Delete a row from the table. If the row does not exist this action will act as thought the row was successfully deleted.

deleteRowSuccess

action<integer> deleteRowSuccess
Default onSuccess callback for the #deleteRow() action, if the application does not want to provide a custom callback.

The default action simply routes a #TableDeleteRowSuccess event. To use the default callback, pass tableInterface.updateRowSuccess as the onSuccess parameter to the #deleteRow() action.
See Also:
#deleteRow - 

getRow

action<string> returns com.apama.memorystore.Row getRow
Get the contents of the given row. The result is undefined if the row does not exist.

getSchema

action<> returns com.apama.config.Schema getSchema
Get the schema for the table.

hasRow

action<string> returns boolean hasRow
Check if the table contains the given row.

makeKey

action<sequence<string>> returns string makeKey
Create a composite key for a row. This operation may be relatively expensive so it it recommended that the result is cached in a 'wrapper' object for the row if it is needed more than once.

updateRow

action<integer, string, com.apama.memorystore.Row, action<integer>, action<integer, string>> updateRow
Add or update a row in the table.

updateRowSuccess

action<integer> updateRowSuccess
Default onSuccess callback for the #updateRow() action, if the application does not want to provide a custom callback.

The default action simply routes a #TableUpdateRowSuccess event. To use the default callback, pass tableInterface.updateRowSuccess as the onSuccess parameter to the #updateRow() action.
See Also:
#updateRow -