com.caplin.transformer.persistence

Interface Persistor

All Known Implementing Classes:

JdbcPersistorImpl

public interface Persistor

A Persistor is a class that handles callbacks from the Transformers persistence module and acts as a Bridge between Transformer and any Database

When an implementation of PersistedValue is loaded by Transformer, transformer looks for a constructor that takes exactly one Argument of type PersistorConfiguration. If this constructor is not available, the default constructor gets called

Method Summary

Methods

Modifier and Type	Method and Description
void	onDelete(String key) Delete a row with the provided key from the Database
PersistedValue	onGet(String key) Retrieve a row from the Database
void	onInsert(PersistedValue persistedValue) Implement this method to handle Insert/Put callbacks.
PersistedValue[]	onQuery(String query) A Query is a prefix match for all keys in the database.
void	onShutdown() When transformer unloads the module, usually a shutdown.

Method Detail

onInsert

void onInsert(PersistedValue persistedValue)

Implement this method to handle Insert/Put callbacks. An insert is expected to overwrite the previously stored value associated with the provided key

Parameters:

persistedValue - The PersistedValue to be stored

onGet

PersistedValue onGet(String key)

Retrieve a row from the Database

Parameters:

key - The key associated with the row

Returns:

A PersistedValue representing the row

onQuery

PersistedValue[] onQuery(String query)

A Query is a prefix match for all keys in the database.

Parameters:

query - an arbitrary String, can be empty too

Returns:

An array PersistedValue representing all rows whose key starts with the query

onDelete

void onDelete(String key)

Delete a row with the provided key from the Database

Parameters:

key - the key of the row to be deleted

onShutdown

void onShutdown()

When transformer unloads the module, usually a shutdown. This callback is being called, so that open connections can be closed