org.waarp.common.database.data

Class AbstractDbData

java.lang.Object

org.waarp.common.database.data.AbstractDbData

Direct Known Subclasses:

AbstractDbDataDao, DbDataModel, DbTransferLog, DbTransferLog

public abstract class AbstractDbData
extends Object

Abstract database table implementation without explicit COMMIT.

If the connection is in autocommit, this is the right abstract to extend.
If the connection is not in autocommit, one could use this implementation to explicitly commit when needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDbData.UpdatedInfo UpdatedInfo status

Field Summary

Fields

Modifier and Type	Field and Description
protected DbValue[]	allFields
protected DbSession	dbSession The DbSession to use
protected boolean	isSaved
static String	JSON_MODEL
protected DbValue[]	otherFields
protected DbValue[]	primaryKey To be implemented

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDbData() Abstract constructor to set the DbSession to use
protected	AbstractDbData(DbSession dbSession) Abstract constructor to set the DbSession to use

Method Summary

Modifier and Type	Method and Description
String	asJson()
abstract void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
void	delete() Delete object from table
boolean	exist() Test the existence of the current object
DbValue[]	getAllFields()
protected abstract String	getInsertAllValues()
com.fasterxml.jackson.databind.node.ObjectNode	getJson() Create the equivalent object in Json (no database access)
protected abstract String	getSelectAllFields()
protected abstract String	getTable()
static void	getTrueValue(ResultSet rs, DbValue value) Get one value into DbValue from ResultSet
protected abstract String	getUpdateAllFields()
protected void	getValues(DbPreparedStatement preparedStatement, DbValue[] values) Get several values into DbValue from DbPreparedStatement
protected abstract String	getWherePrimaryKey()
protected abstract void	initObject() To setup primaryKey, otherFields, allFields.
void	insert() Insert object into table
void	select() Select object from table
protected abstract void	setFromArray() Internal function to retrieve data from Array to pull data from database
void	setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node, boolean ignorePrimaryKey) Set the values from the Json node to the current object (no database access)
protected abstract void	setPrimaryKey() Set the primary Key as current value
protected abstract void	setToArray() Internal function to set to Array used to push data to database
static void	setTrueValue(PreparedStatement ps, DbValue value, int rank) Set Value into PreparedStatement
protected void	setValues(DbPreparedStatement preparedStatement, DbValue[] values) Set several values to a DbPreparedStatement
void	update() Update object to table
static void	validateLength(byte[]... values) Validate Byte array max length
static void	validateLength(int type, String... values) Validate String max length

Methods inherited from class java.lang.Object

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

Field Detail

JSON_MODEL

public static final String JSON_MODEL

See Also:

Constant Field Values

primaryKey

protected DbValue[] primaryKey

To be implemented

otherFields

protected DbValue[] otherFields

allFields

protected DbValue[] allFields

isSaved

protected boolean isSaved

dbSession

protected final DbSession dbSession

The DbSession to use

Constructor Detail

AbstractDbData

protected AbstractDbData(DbSession dbSession)

Abstract constructor to set the DbSession to use

Parameters:

dbSession - Deprecated for Waarp R66

AbstractDbData

protected AbstractDbData()

Abstract constructor to set the DbSession to use

Method Detail

initObject

protected abstract void initObject()

To setup primaryKey, otherFields, allFields. Note this initObject is called within constructor of AbstractDbData. Be careful that no data is actually initialized at this stage.

getWherePrimaryKey

protected abstract String getWherePrimaryKey()

Returns:

The Where condition on Primary Key

setPrimaryKey

protected abstract void setPrimaryKey()

Set the primary Key as current value

getSelectAllFields

protected abstract String getSelectAllFields()

getTable

protected abstract String getTable()

getInsertAllValues

protected abstract String getInsertAllValues()

getUpdateAllFields

protected abstract String getUpdateAllFields()

exist

public boolean exist()
              throws WaarpDatabaseException

Test the existence of the current object

Returns:

True if the object exists

Throws:

WaarpDatabaseException

select

public void select()
            throws WaarpDatabaseException

Select object from table

Throws:

WaarpDatabaseException

insert

public void insert()
            throws WaarpDatabaseException

Insert object into table

Throws:

WaarpDatabaseException

update

public void update()
            throws WaarpDatabaseException

Update object to table

Throws:

WaarpDatabaseException

getAllFields

public final DbValue[] getAllFields()

delete

public void delete()
            throws WaarpDatabaseException

Delete object from table

Throws:

WaarpDatabaseException

changeUpdatedInfo

public abstract void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Change UpdatedInfo status

Parameters:

info -

setToArray

protected abstract void setToArray()
                            throws WaarpDatabaseSqlException

Internal function to set to Array used to push data to database

Throws:

WaarpDatabaseSqlException

setFromArray

protected abstract void setFromArray()
                              throws WaarpDatabaseSqlException

Internal function to retrieve data from Array to pull data from database

Throws:

WaarpDatabaseSqlException

validateLength

public static void validateLength(byte[]... values)
                           throws WaarpDatabaseSqlException

Validate Byte array max length

Parameters:

values - the values to check against Types.VARBINARY

Throws:

WaarpDatabaseSqlException - if length is not acceptable

validateLength

public static void validateLength(int type,
                                  String... values)
                           throws WaarpDatabaseSqlException

Validate String max length

Parameters:

type - between Types.VARCHAR, NVARCHAR, LONGVARCHAR

values - the values to check against same type

Throws:

WaarpDatabaseSqlException - if length is not acceptable

setTrueValue

public static void setTrueValue(PreparedStatement ps,
                                DbValue value,
                                int rank)
                         throws WaarpDatabaseSqlException

Set Value into PreparedStatement

Parameters:

ps -

value -

rank - >= 1

Throws:

WaarpDatabaseSqlException

setValues

protected final void setValues(DbPreparedStatement preparedStatement,
                               DbValue[] values)
                        throws WaarpDatabaseNoConnectionException,
                               WaarpDatabaseSqlException

Set several values to a DbPreparedStatement

Parameters:

preparedStatement -

values -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

getTrueValue

public static void getTrueValue(ResultSet rs,
                                DbValue value)
                         throws WaarpDatabaseSqlException

Get one value into DbValue from ResultSet

Parameters:

rs -

value -

Throws:

WaarpDatabaseSqlException

getValues

protected void getValues(DbPreparedStatement preparedStatement,
                         DbValue[] values)
                  throws WaarpDatabaseNoConnectionException,
                         WaarpDatabaseSqlException

Get several values into DbValue from DbPreparedStatement

Parameters:

preparedStatement -

values -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

asJson

public String asJson()

Returns:

the object as Json

getJson

public com.fasterxml.jackson.databind.node.ObjectNode getJson()

Create the equivalent object in Json (no database access)

Returns:

The ObjectNode Json equivalent

setFromJson

public void setFromJson(com.fasterxml.jackson.databind.node.ObjectNode node,
                        boolean ignorePrimaryKey)
                 throws WaarpDatabaseSqlException

Set the values from the Json node to the current object (no database access)

Parameters:

node -

ignorePrimaryKey - True will ignore primaryKey from Json

Throws:

WaarpDatabaseSqlException