org.ddbstoolkit.toolkit.jdbc

Class JDBCEntityManager

java.lang.Object

org.ddbstoolkit.toolkit.jdbc.JDBCEntityManager

All Implemented Interfaces:

DistributableEntityManager, UpdatableEntityManager

Direct Known Subclasses:

DistributedMySQLTableManager, DistributedSQLiteTableManager, JDBCPoolManager

public abstract class JDBCEntityManager
extends java.lang.Object
implements DistributableEntityManager

JDBC Entity manager

Field Summary

Fields

Modifier and Type	Field and Description
protected DDBSEntityManager<DDBSEntity<DDBSEntityProperty>>	ddbsEntityManager DDBS Entity manager
protected JDBCConditionConverter	jdbcConditionConverter JDBC Condition converter
protected JDBCConnector	jdbcConnector JDBC connector
protected JDBCPreparedStatementManager	jdbcPreparedStatementManager JDBC Prepared Statement Manager

Constructor Summary

Constructors

Constructor and Description
JDBCEntityManager(JDBCConnector jdbcConnector) JDBC Entity manager with a single connection

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
protected <T extends IEntity> java.util.List<T>	conversionResultSet(java.sql.ResultSet results, T myObject)
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
protected java.lang.String	getDeleteSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity) Create Delete SQL Query
protected java.lang.String	getInsertSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity) Create Insert SQL Query
protected java.lang.String	getUpdateSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity) Create Update SQL Query
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
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

jdbcConnector

protected JDBCConnector jdbcConnector

JDBC connector

jdbcPreparedStatementManager

protected JDBCPreparedStatementManager jdbcPreparedStatementManager

JDBC Prepared Statement Manager

ddbsEntityManager

protected DDBSEntityManager<DDBSEntity<DDBSEntityProperty>> ddbsEntityManager

DDBS Entity manager

jdbcConditionConverter

protected JDBCConditionConverter jdbcConditionConverter

JDBC Condition converter

Constructor Detail

JDBCEntityManager

public JDBCEntityManager(JDBCConnector jdbcConnector)

JDBC Entity manager with a single connection

Parameters:

jdbcConnector - JDBC Connector

Method Detail

isOpen

public boolean isOpen()
               throws DDBSToolkitException

Description copied from interface: DistributableEntityManager

Check if the connection is open

Specified by:

isOpen in interface DistributableEntityManager

Returns:

State of the connection

Throws:

DDBSToolkitException - Error to check the state of the connection

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

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

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

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

getInsertSQLString

protected java.lang.String getInsertSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity)

Create Insert SQL Query

Parameters:

ddbsEntity - DDBSEntity

Returns:

INSERT SQL Query

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

getUpdateSQLString

protected java.lang.String getUpdateSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity)

Create Update SQL Query

Parameters:

ddbsEntity - DDBSEntity

Returns:

UPDATE SQL Query

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

getDeleteSQLString

protected java.lang.String getDeleteSQLString(DDBSEntity<DDBSEntityProperty> ddbsEntity)

Create Delete SQL Query

Parameters:

ddbsEntity - DDBSEntity

Returns:

DELETE SQL Query

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

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

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

conversionResultSet

protected <T extends IEntity> java.util.List<T> conversionResultSet(java.sql.ResultSet results,
                                                                    T myObject)
                                                             throws DDBSToolkitException

Throws:

DDBSToolkitException