org.waarp.openr66.database.data

Class AbstractDbDataDao<E>

java.lang.Object

org.waarp.common.database.data.AbstractDbData

org.waarp.openr66.database.data.AbstractDbDataDao<E>

Direct Known Subclasses:

DbConfiguration, DbHostAuth, DbHostConfiguration, DbMultipleMonitor, DbRule, DbTaskRunner

public abstract class AbstractDbDataDao<E>
extends AbstractDbData

Abstract database table implementation

Nested Class Summary

Nested classes/interfaces inherited from class org.waarp.common.database.data.AbstractDbData

AbstractDbData.UpdatedInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_MODEL
protected E	pojo
protected static String	SHOULD_NOT_BE_CALLED

Fields inherited from class org.waarp.common.database.data.AbstractDbData

allFields, dbSession, isSaved, otherFields, primaryKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDbDataDao() Abstract constructor

Method Summary

Modifier and Type	Method and Description
String	asJson()
abstract void	changeUpdatedInfo(AbstractDbData.UpdatedInfo info) Change UpdatedInfo status
protected abstract void	checkValues()
void	delete() Delete object from table
boolean	exist() Test the existence of the current object
protected abstract AbstractDAO<E>	getDao(boolean isCacheable)
protected String	getInsertAllValues() UnsupportedOperationException
com.fasterxml.jackson.databind.node.ObjectNode	getJson() Create the equivalent object in Json (no database access)
protected abstract String	getPrimaryField()
protected abstract String	getPrimaryKey()
protected String	getSelectAllFields() UnsupportedOperationException
protected abstract String	getTable()
protected String	getUpdateAllFields() UnsupportedOperationException
protected void	getValues(DbPreparedStatement preparedStatement, DbValue[] values) UnsupportedOperationException
protected String	getWherePrimaryKey() UnsupportedOperationException
protected void	initObject() To setup primaryKey, otherFields, allFields.
void	insert() Insert object into table
void	select() Select object from table
protected void	setFromArray() UnsupportedOperationException
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	setFromJson(String field, com.fasterxml.jackson.databind.JsonNode value)
protected void	setPrimaryKey() UnsupportedOperationException
protected void	setToArray() UnsupportedOperationException
String	toJson()
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 org.waarp.common.database.data.AbstractDbData

getAllFields, getTrueValue, setTrueValue, setValues

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

SHOULD_NOT_BE_CALLED

protected static final String SHOULD_NOT_BE_CALLED

See Also:

Constant Field Values

pojo

protected E pojo

Constructor Detail

AbstractDbDataDao

protected AbstractDbDataDao()

Abstract constructor

Method Detail

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

getTable

protected abstract String getTable()

Specified by:

getTable in class AbstractDbData

checkValues

protected abstract void checkValues()
                             throws WaarpDatabaseSqlException

Throws:

WaarpDatabaseSqlException

getDao

protected abstract AbstractDAO<E> getDao(boolean isCacheable)
                                  throws DAOConnectionException

Throws:

DAOConnectionException

getPrimaryKey

protected abstract String getPrimaryKey()

getPrimaryField

protected abstract String getPrimaryField()

changeUpdatedInfo

public abstract void changeUpdatedInfo(AbstractDbData.UpdatedInfo info)

Change UpdatedInfo status

Specified by:

changeUpdatedInfo in class AbstractDbData

Parameters:

info -

exist

public boolean exist()
              throws WaarpDatabaseException

Test the existence of the current object

Overrides:

exist in class AbstractDbData

Returns:

True if the object exists

Throws:

WaarpDatabaseException

select

public void select()
            throws WaarpDatabaseException

Select object from table

Overrides:

select in class AbstractDbData

Throws:

WaarpDatabaseException

insert

public void insert()
            throws WaarpDatabaseException

Insert object into table

Overrides:

insert in class AbstractDbData

Throws:

WaarpDatabaseException

update

public void update()
            throws WaarpDatabaseException

Update object to table

Overrides:

update in class AbstractDbData

Throws:

WaarpDatabaseException

delete

public void delete()
            throws WaarpDatabaseException

Delete object from table

Overrides:

delete in class AbstractDbData

Throws:

WaarpDatabaseException

asJson

public final String asJson()

Overrides:

asJson in class AbstractDbData

Returns:

the PoJo as Json

toJson

public String toJson()

Returns:

the PoJo as Json (shall not be used except for native Json but possibly incorrect

getJson

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

Create the equivalent object in Json (no database access)

Overrides:

getJson in class AbstractDbData

Returns:

The ObjectNode Json equivalent

setFromJson

protected abstract void setFromJson(String field,
                                    com.fasterxml.jackson.databind.JsonNode value)
                             throws WaarpDatabaseSqlException

Throws:

WaarpDatabaseSqlException

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)

Overrides:

setFromJson in class AbstractDbData

Parameters:

node -

ignorePrimaryKey - True will ignore primaryKey from Json

Throws:

WaarpDatabaseSqlException

initObject

protected void initObject()

Description copied from class: AbstractDbData

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.

Specified by:

initObject in class AbstractDbData

getWherePrimaryKey

protected String getWherePrimaryKey()

UnsupportedOperationException

Specified by:

getWherePrimaryKey in class AbstractDbData

Returns:

never

setPrimaryKey

protected void setPrimaryKey()

UnsupportedOperationException

Specified by:

setPrimaryKey in class AbstractDbData

getSelectAllFields

protected String getSelectAllFields()

UnsupportedOperationException

Specified by:

getSelectAllFields in class AbstractDbData

Returns:

never

getInsertAllValues

protected String getInsertAllValues()

UnsupportedOperationException

Specified by:

getInsertAllValues in class AbstractDbData

Returns:

never

getUpdateAllFields

protected String getUpdateAllFields()

UnsupportedOperationException

Specified by:

getUpdateAllFields in class AbstractDbData

Returns:

never

setToArray

protected void setToArray()

UnsupportedOperationException

Specified by:

setToArray in class AbstractDbData

setFromArray

protected void setFromArray()

UnsupportedOperationException

Specified by:

setFromArray in class AbstractDbData

getValues

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

UnsupportedOperationException

Overrides:

getValues in class AbstractDbData