org.resoa.persistence

Interface DatabaseTransition

All Known Implementing Classes:

BTreeTransition, SQLTransition

public interface DatabaseTransition

Interface for Persistor to Database Transition

Method Summary

Methods

Modifier and Type	Method and Description
void	backup(PersistentDomain domain) Backup a persistent domain
void	closePersistenceDomain(java.lang.String domain) Stop persistence service for a domain
void	deleteRecord(TransactionContext context, PersistentType<?> peristentType, java.lang.String taskID, Instruction instruction) Execute an instruction delete
boolean	exists(TransactionContext context, PersistentType<?> persistentType, java.lang.Object key) Indicate, if an object exists within persistence
org.resoa.json.JSONObject	finalizeRelations(TransactionContext context, PersistentType<?> persistentType, org.resoa.json.JSONObject json) Finalize persistent relations
java.lang.Object	getDatabase()
<T> T	getInstance(TransactionContext context, PersistentType<T> persistentType, java.lang.Object key) Return an object instance
java.lang.String	getJSONFromDB(TransactionContext context, PersistentType<?> persistentType, java.lang.Object key) return the unresolved JSON representation of an object, before the transaction starts
void	init(PersistentDomain persistDomain) Initialize the database
void	newPersistenceType(PersistentType<?> persistentType) Activate persistence for a new type
org.resoa.grid.RecordSet	readRecords(TransactionContext context, PersistentType<?> peristentType, org.resoa.grid.RecordSet result, boolean keysOnly) Read a set of records from database
TransactionContext	startTransaction(java.lang.String domain, TransactionContext.TransactionType type) Start a transaction for a persistent service domain
void	stop() Stop all services
void	storeRecord(TransactionContext context, PersistentType<?> peristentType, java.lang.String taskID, Instruction instruction) Store a single instruction

Method Detail

startTransaction

TransactionContext startTransaction(java.lang.String domain,
                                  TransactionContext.TransactionType type)
                                    throws org.resoa.exception.PersistenceException

Start a transaction for a persistent service domain

Parameters:

domain -

type -

Throws:

org.resoa.exception.PersistenceException

init

void init(PersistentDomain persistDomain)
          throws org.resoa.exception.PersistenceException

Initialize the database

Parameters:

persistDomain -

Throws:

org.resoa.exception.PersistenceException

newPersistenceType

void newPersistenceType(PersistentType<?> persistentType)
                        throws org.resoa.exception.PersistenceException

Activate persistence for a new type

Parameters:

persistentType -

Throws:

org.resoa.exception.PersistenceException

closePersistenceDomain

void closePersistenceDomain(java.lang.String domain)

Stop persistence service for a domain

Parameters:

domain -

stop

void stop()

Stop all services

getJSONFromDB

java.lang.String getJSONFromDB(TransactionContext context,
                             PersistentType<?> persistentType,
                             java.lang.Object key)

return the unresolved JSON representation of an object, before the transaction starts

Parameters:

persistentType -

key -

context -

getInstance

<T> T getInstance(TransactionContext context,
                PersistentType<T> persistentType,
                java.lang.Object key)

Return an object instance

Parameters:

persistentType -

key -

exists

boolean exists(TransactionContext context,
             PersistentType<?> persistentType,
             java.lang.Object key)

Indicate, if an object exists within persistence

Parameters:

persistentType -

key -

context -

storeRecord

void storeRecord(TransactionContext context,
               PersistentType<?> peristentType,
               java.lang.String taskID,
               Instruction instruction)
                 throws org.resoa.exception.PersistenceException

Store a single instruction

Parameters:

context -

peristentType -

taskID -

instruction -

Throws:

org.resoa.exception.PersistenceException

deleteRecord

void deleteRecord(TransactionContext context,
                PersistentType<?> peristentType,
                java.lang.String taskID,
                Instruction instruction)
                  throws org.resoa.exception.PersistenceException

Execute an instruction delete

Parameters:

context -

peristentType -

taskID -

instruction -

Throws:

org.resoa.exception.PersistenceException

readRecords

org.resoa.grid.RecordSet readRecords(TransactionContext context,
                                   PersistentType<?> peristentType,
                                   org.resoa.grid.RecordSet result,
                                   boolean keysOnly)

Read a set of records from database

Parameters:

peristentType -

result -

keysOnly -

context -

finalizeRelations

org.resoa.json.JSONObject finalizeRelations(TransactionContext context,
                                          PersistentType<?> persistentType,
                                          org.resoa.json.JSONObject json)

Finalize persistent relations

Parameters:

persistentType -

json -

context -

backup

void backup(PersistentDomain domain)
            throws org.resoa.exception.PersistenceException

Backup a persistent domain

Parameters:

domain -

Throws:

org.resoa.exception.PersistenceException

getDatabase

java.lang.Object getDatabase()

Returns:

the underlying database. Within SQLTransition it is the SQL DatabaseManager, within BTREE the Storage implementation instance