org.noorm.jdbc

Interface IBean<T>

public interface IBean<T>

Author:

Ulf Pietruschka / ulf.pietruschka@etenso.com Date: 20.05.11 Time: 14:27

Method Summary

Methods

Modifier and Type	Method and Description
T	getAuxiliaryData() Generic object to enrich the Bean with additional information.
HashMap<String,Object>	getModifiedFieldsInitialValue() Returns all fields and values, which have been changed after this bean has been loaded and populated.
String[]	getPrimaryKeyColumnNames() The name of the primary key columns.
Long	getSequenceIncrement() The increment for the sequence used to generate primary key values.
String	getSequenceName() The sequence name used to generate numeric primary keys for this table or view.
String	getTableName() The database name of this Bean.
String	getVersionColumnName() The table column used for modification checking for optimistic locking.
VersionColumnType	getVersionColumnType() The table column type used for modification checking for optimistic locking.
boolean	isTableNameCaseSensitive() Indicates, whether the table name is case sensitive.
void	setAuxiliaryData(T pAuxiliaryData) Generic object to enrich the Bean with additional information.
boolean	useInlineSequenceValueGeneration() Determines, whether sequence values for primary keys should be generated inline

Method Detail

getAuxiliaryData

T getAuxiliaryData()

Generic object to enrich the Bean with additional information.

Returns:

the generic object.

setAuxiliaryData

void setAuxiliaryData(T pAuxiliaryData)

Generic object to enrich the Bean with additional information.

Parameters:

pAuxiliaryData -

getModifiedFieldsInitialValue

HashMap<String,Object> getModifiedFieldsInitialValue()

Returns all fields and values, which have been changed after this bean has been loaded and populated. This method provides support for optimistic locking, when optimistic locking is realized by comparing the full pre-change image of the row against the current database row. Note that this method returns null, when this kind of optimistic locking is not enabled for the associated table.

Returns:

all fields and values, which have been changed

getTableName

String getTableName()

The database name of this Bean. Can either be a table or an updateable view.

Returns:

the database name

isTableNameCaseSensitive

boolean isTableNameCaseSensitive()

Indicates, whether the table name is case sensitive.

Returns:

true, when the table name is case sensitive

getPrimaryKeyColumnNames

String[] getPrimaryKeyColumnNames()

The name of the primary key columns.

Returns:

the primary key column names.

getSequenceName

String getSequenceName()

The sequence name used to generate numeric primary keys for this table or view.

Returns:

the sequence name.

getSequenceIncrement

Long getSequenceIncrement()

The increment for the sequence used to generate primary key values. Using an increment larger than 1 allows the DataSourceProvider to cache sequence values without the need for a database round-trip.

Returns:

the sequence increment

useInlineSequenceValueGeneration

boolean useInlineSequenceValueGeneration()

Determines, whether sequence values for primary keys should be generated inline

Returns:

true, when the sequence value generation should be inlined with the INSERT statement.

getVersionColumnName

String getVersionColumnName()

The table column used for modification checking for optimistic locking.

Returns:

the version column name.

getVersionColumnType

VersionColumnType getVersionColumnType()

The table column type used for modification checking for optimistic locking.

Returns:

the version column type.