org.ddbstoolkit.toolkit.modules.middleware.sqlspaces

Class SqlSpacesSender

java.lang.Object

org.ddbstoolkit.toolkit.modules.middleware.sqlspaces.SqlSpacesSender

All Implemented Interfaces:

DistributableEntityManager, DistributableSenderInterface, UpdatableEntityManager

public class SqlSpacesSender
extends java.lang.Object
implements DistributableSenderInterface

Class to send commands using SQLSpaces User: Cyril GRANDJEAN Date: 21/06/2012 Time: 11:39

Field Summary

Fields

Modifier and Type	Field and Description
protected DDBSEntityManager<DDBSEntity<DDBSEntityProperty>>	ddbsEntityManager DDBS Entity manager

Constructor Summary

Constructors

Constructor and Description
SqlSpacesSender(java.lang.String clusterName, java.lang.String peerName) Create a SqlSpaces Sender using localhost server
SqlSpacesSender(java.lang.String clusterName, java.lang.String peerName, java.lang.String ipAddress, int port) Create a SqlSpaces Sender using an external server

Method Summary

Modifier and Type	Method and Description
boolean	add(IEntity objectToAdd) Add an element to a data source
void	close() Close the data source connection
void	commit(DDBSTransaction transaction) Commit a transaction
boolean	createEntity(IEntity objectToCreate) Create the structure of the entity
boolean	delete(IEntity objectToDelete) Delete an object in a data source
DDBSTransaction	executeTransaction(DDBSTransaction transaction) Execute a list of actions
java.util.List<Peer>	getListPeers() Get the list of peers
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
void	setTimeout(int timeout) Set a timeout
boolean	update(IEntity objectToUpdate) Update an element in a data source

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ddbsEntityManager

protected DDBSEntityManager<DDBSEntity<DDBSEntityProperty>> ddbsEntityManager

DDBS Entity manager

Constructor Detail

SqlSpacesSender

public SqlSpacesSender(java.lang.String clusterName,
                       java.lang.String peerName)

Create a SqlSpaces Sender using localhost server

Parameters:

clusterName - Name of the cluster

peerName - Name of the peer

SqlSpacesSender

public SqlSpacesSender(java.lang.String clusterName,
                       java.lang.String peerName,
                       java.lang.String ipAddress,
                       int port)

Create a SqlSpaces Sender using an external server

Parameters:

clusterName - Name of the cluster

peerName - Name of the peer

ipAddress - Ip address of the SQLSpaces Server

port - Port of the SQLSpaces Server

Method Detail

isOpen

public boolean isOpen()

Description copied from interface: DistributableEntityManager

Check if the connection is open

Specified by:

isOpen in interface DistributableEntityManager

Returns:

State of the connection

setTimeout

public void setTimeout(int timeout)

Description copied from interface: DistributableSenderInterface

Set a timeout

Specified by:

setTimeout in interface DistributableSenderInterface

Parameters:

timeout - Timeout for this interface

open

public void open()
          throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Open the data source connection

Specified by:

open in interface DistributableEntityManager

Throws:

DDBSToolkitException - : Error to open the connection

close

public void close()
           throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Close the data source connection

Specified by:

close in interface DistributableEntityManager

Throws:

DDBSToolkitException - : Error to close the connection

listAllWithQueryString

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

Description copied from interface: DistributableEntityManager

List all entities of a specific object

Specified by:

listAllWithQueryString in interface DistributableEntityManager

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

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

Description copied from interface: DistributableEntityManager

Read details about an object

Specified by:

read in interface DistributableEntityManager

Type Parameters:

T - IEntity extended entity

Parameters:

object - object to read

Returns:

Object with all the details

Throws:

DDBSToolkitException - Error during reading

readLastElement

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

Description copied from interface: DistributableEntityManager

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

Specified by:

readLastElement in interface DistributableEntityManager

Type Parameters:

T - IEntity extended entity

Parameters:

object - object to read

Returns:

Last object added

Throws:

DDBSToolkitException - Error during reading

add

public boolean add(IEntity objectToAdd)
            throws DDBSToolkitException

Description copied from interface: UpdatableEntityManager

Add an element to a data source

Specified by:

add in interface UpdatableEntityManager

Parameters:

objectToAdd - Object to add in a data source

Returns:

boolean if the transaction has succeeded

Throws:

DDBSToolkitException - Problem during operation

update

public boolean update(IEntity objectToUpdate)
               throws DDBSToolkitException

Description copied from interface: UpdatableEntityManager

Update an element in a data source

Specified by:

update in interface UpdatableEntityManager

Parameters:

objectToUpdate - Object to update

Returns:

boolean if the transaction has succeeded

Throws:

DDBSToolkitException - Problem during operation

delete

public boolean delete(IEntity objectToDelete)
               throws DDBSToolkitException

Description copied from interface: UpdatableEntityManager

Delete an object in a data source

Specified by:

delete in interface UpdatableEntityManager

Parameters:

objectToDelete - Object to delete

Returns:

boolean if the transaction has succeeded

Throws:

DDBSToolkitException - Problem during operation

createEntity

public boolean createEntity(IEntity objectToCreate)
                     throws DDBSToolkitException

Description copied from interface: UpdatableEntityManager

Create the structure of the entity

Specified by:

createEntity in interface UpdatableEntityManager

Parameters:

objectToCreate - Object to create

Returns:

boolean if the transaction has succeeded

Throws:

DDBSToolkitException - Problem during operation

loadArray

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

Description copied from interface: DistributableEntityManager

Load a property of the object corresponding to an array

Specified by:

loadArray in interface DistributableEntityManager

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

getListPeers

public java.util.List<Peer> getListPeers()
                                  throws java.lang.Exception

Description copied from interface: DistributableSenderInterface

Get the list of peers

Specified by:

getListPeers in interface DistributableSenderInterface

Returns:

List of peers

Throws:

java.lang.Exception - Error occuring when retrieving the list of peers

listAll

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

Description copied from interface: DistributableEntityManager

List all entities of a specific object

Specified by:

listAll in interface DistributableEntityManager

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

setAutoCommit

public void setAutoCommit(boolean isAutoCommit)
                   throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Set the auto-commit for the data source

Specified by:

setAutoCommit in interface DistributableEntityManager

Parameters:

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

Throws:

DDBSToolkitException - : Error to set the auto-commit value

commit

public void commit(DDBSTransaction transaction)
            throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Commit a transaction

Specified by:

commit in interface DistributableEntityManager

Parameters:

transaction - Transaction

Throws:

DDBSToolkitException - : Error to commit the transaction

rollback

public void rollback(DDBSTransaction transaction)
              throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Rollback the transaction

Specified by:

rollback in interface DistributableEntityManager

Parameters:

transaction - Transaction

Throws:

DDBSToolkitException - : Error to rollback the connection

executeTransaction

public DDBSTransaction executeTransaction(DDBSTransaction transaction)
                                   throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Execute a list of actions

Specified by:

executeTransaction in interface DistributableEntityManager

Parameters:

transaction - List of commands

Returns:

transaction executed

Throws:

DDBSToolkitException - : Error to execute the transaction