org.ddbstoolkit.toolkit.core

Interface DistributableEntityManager

All Superinterfaces:

UpdatableEntityManager

All Known Subinterfaces:

DistributableSenderInterface

All Known Implementing Classes:

DistributedMySQLTableManager, DistributedSPARQLManager, DistributedSQLitePoolTableManager, DistributedSQLiteTableManager, JDBCEntityManager, JDBCPoolManager, JGroupSender, SqlSpacesSender

public interface DistributableEntityManager
extends UpdatableEntityManager

Interface to access to distributed data sources

Method Summary

Modifier and Type	Method and Description
void	close() Close the data source connection
void	commit(DDBSTransaction transaction) Commit a transaction
DDBSTransaction	executeTransaction(DDBSTransaction transaction) Execute a list of actions
boolean	isOpen() Check if the connection is open
<T extends IEntity> java.util.List<T>	listAll(T object, Conditions conditions, OrderBy orderBy) List all entities of a specific object
<T extends IEntity> java.util.List<T>	listAllWithQueryString(T object, java.lang.String conditionQueryString, OrderBy orderBy) List all entities of a specific object
<T extends IEntity> T	loadArray(T objectToLoad, java.lang.String field, OrderBy orderBy) Load a property of the object corresponding to an array
void	open() Open the data source connection
<T extends IEntity> T	read(T object) Read details about an object
<T extends IEntity> T	readLastElement(T object) Read the last element added of a table or a type of data source (Id annotation has to be used)
void	rollback(DDBSTransaction transaction) Rollback the transaction
void	setAutoCommit(boolean isAutoCommit) Set the auto-commit for the data source

Methods inherited from interface org.ddbstoolkit.toolkit.core.UpdatableEntityManager

add, createEntity, delete, update

Method Detail

isOpen

boolean isOpen()
        throws DDBSToolkitException

Check if the connection is open

Returns:

State of the connection

Throws:

DDBSToolkitException - Error to check the state of the connection

open

void open()
   throws DDBSToolkitException

Open the data source connection

Throws:

DDBSToolkitException - : Error to open the connection

close

void close()
    throws DDBSToolkitException

Close the data source connection

Throws:

DDBSToolkitException - : Error to close the connection

setAutoCommit

void setAutoCommit(boolean isAutoCommit)
            throws DDBSToolkitException

Set the auto-commit for the data source

Parameters:

isAutoCommit - Boolean returning if there is auto-commit in the transaction

Throws:

DDBSToolkitException - : Error to set the auto-commit value

executeTransaction

DDBSTransaction executeTransaction(DDBSTransaction transaction)
                            throws DDBSToolkitException

Execute a list of actions

Parameters:

transaction - List of commands

Returns:

transaction executed

Throws:

DDBSToolkitException - : Error to execute the transaction

commit

void commit(DDBSTransaction transaction)
     throws DDBSToolkitException

Commit a transaction

Parameters:

transaction - Transaction

Throws:

DDBSToolkitException - : Error to commit the transaction

rollback

void rollback(DDBSTransaction transaction)
       throws DDBSToolkitException

Rollback the transaction

Parameters:

transaction - Transaction

Throws:

DDBSToolkitException - : Error to rollback the connection

listAll

<T extends IEntity> java.util.List<T> listAll(T object,
                                              Conditions conditions,
                                              OrderBy orderBy)
                                       throws DDBSToolkitException

List all entities of a specific object

Type Parameters:

T - IEntity extended entity

Parameters:

object - Object to search

conditions - Conditions to filter the results

orderBy - Order By Object

Returns:

list of entities that match the request

Throws:

DDBSToolkitException - Error during the process

listAllWithQueryString

<T extends IEntity> java.util.List<T> listAllWithQueryString(T object,
                                                             java.lang.String conditionQueryString,
                                                             OrderBy orderBy)
                                                      throws DDBSToolkitException

List all entities of a specific object

Type Parameters:

T - IEntity extended entity

Parameters:

object - Object to search

conditionQueryString - Condition query string to filter the results

orderBy - Order By Object

Returns:

list of entities that match the request

Throws:

DDBSToolkitException - Error during the process

read

<T extends IEntity> T read(T object)
                    throws DDBSToolkitException

Read details about an object

Type Parameters:

T - IEntity extended entity

Parameters:

object - object to read

Returns:

Object with all the details

Throws:

DDBSToolkitException - Error during reading

readLastElement

<T extends IEntity> T readLastElement(T object)
                               throws DDBSToolkitException

Read the last element added of a table or a type of data source (Id annotation has to be used)

Type Parameters:

T - IEntity extended entity

Parameters:

object - object to read

Returns:

Last object added

Throws:

DDBSToolkitException - Error during reading

loadArray

<T extends IEntity> T loadArray(T objectToLoad,
                                java.lang.String field,
                                OrderBy orderBy)
                         throws DDBSToolkitException

Load a property of the object corresponding to an array

Type Parameters:

T - IEntity extended entity

Parameters:

objectToLoad - Object to load

field - Array to load

orderBy - Order By Object

Returns:

the entity with the new field loaded

Throws:

DDBSToolkitException - Problem during operation