de.esprit.appsuite.database.dbase

Class DBRecordWrapper<R extends DBRecord>

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.common.util.TransferableObject

de.esprit.appsuite.database.dbase.DBRecordContainer<R>

de.esprit.appsuite.database.dbase.DBRecordWrapper<R>

All Implemented Interfaces:

DBPersistent, DBRecord, Renderable, DeepCloneable, Dumpable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

AbstractDatabaseGroup, AbstractDatabaseUser

public abstract class DBRecordWrapper<R extends DBRecord>
extends DBRecordContainer<R>
implements DBRecord

This class is used typically for wrapping a DBObject instance which implements the DBRecord interface and thus can be handled by DBRecordTable, DBRecordList and other DBRecord capable classes. All methods just delegate to the internally kept DBObject instance. This class is very useful if you want to extend your database objects with non persistent fields.

Author:

Rainer Buesch

See Also:

DBObject, DBRecord, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DBRecordWrapper(R dbo)

Method Summary

Methods

Modifier and Type	Method and Description
DBRecordWrapper	clone()
int	compareTo(java.lang.Object arg)
void	copyRecordValues(DBRecord otherRecord, boolean isIncludePK)
void	dbDelete() Deletes the representing record from the database.
void	dbInsert() Inserts the object as a record into the database.
void	dbLoad(DBLoadMonitor monitor, SqlCondition condition) Reads a set of objects from from the database according to the given condition.
void	dbLoad(DBLoadMonitor monitor, SqlCondition condition, SqlOrder order) Reads a set of objects from from the database according to the given condition and order.
void	dbRehash() Re-reads the object state from the database.
void	dbSearch(DBLoadMonitor monitor, SqlCondition condition) Reads a set of objects from from the database according to the given condition.
void	dbSearch(DBLoadMonitor monitor, SqlCondition condition, SqlOrder order) Reads a set of objects from from the database according to the given condition and order.
R[]	dbSearch(SqlCondition condition) Reads a set of objects from from the database according to the given condition.
R[]	dbSearch(SqlCondition condition, SqlOrder order) Reads a set of objects from from the database according to the given condition and order.
R[]	dbSelect(SqlCondition condition) Reads a set of objects from from the database according to the given condition.
R[]	dbSelect(SqlCondition condition, SqlOrder order) Reads a set of objects from from the database according to the given condition and order.
void	dbUpdate() Writes the object's current state to the database.
DBRecordWrapper	deepClone() Returns a deep clone of this object
boolean	exists() Checks whether a matching object can be found in the database by performing a primary key lookup in the according table(s).
boolean	existsField(java.lang.String fieldName) Tells wasCancelled this field exists in this DBObject.
int	getFieldCount() Returns the number columns of this DBObject including primary key columns
java.lang.String[]	getFieldFullNames() Returns the full names of all columns in the format table.column
java.lang.String	getFieldIcon(java.lang.String fieldName) Returns the name for an icon that should be used to render this column.
int	getFieldLength(java.lang.String fieldName) Returns the length (in number or characters) of the given fieldname.
java.lang.String[]	getFieldNames() Returns the names of all columns without the table prefix
java.lang.String	getForeignKeyRef(java.lang.String fieldName) If the given field is a foreign key field then the referenced fieldname is returned in the format table.column.
java.lang.Class	getJavaType(java.lang.String fieldName) Returns the java variable type of the given fieldname.
int	getJdbcType(java.lang.String fieldName) Returns the jdbc-type of the given fieldname.
DBObject[]	getManagedDBObjects() If the instance is a DBObject then the DBObject itself is returned.
R	getMasterRecord()
int	getPrimaryKeyCount() Returns the number of fields that compose the primary key
java.lang.String[]	getPrimaryKeyValues() Returns the values of the primary key as a String array.
java.lang.String	getRecordName() Returns a unique name for this record, which is usually the tablename.
java.awt.Color	getRenderColor()
javax.swing.Icon	getRenderIcon()
java.lang.String	getRenderText()
java.lang.String	getTranslationAppKey() Returns the main translation key for this record.
java.lang.Object	getValue(java.lang.String fieldName) Returns the current value of the given fieldname.
boolean	hasPrimaryKey() Tells whether this object has a primary key at all
boolean	isDirty() Tells whether this object is in sync with the database.
boolean	isFieldVirtual(java.lang.String fieldName) Tells wasCancelled this field is supposed to be editable.
boolean	isForeignKey(java.lang.String fieldName) Tells wasCancelled this field is a foreign key field.
boolean	isNotNullField(java.lang.String fieldName) Tells wasCancelled this field is a not null field.
boolean	isPrimaryKey(java.lang.String fieldName) Tells wasCancelled this field is or is part of the primary key.
void	setPrimaryKeyValues(java.lang.String... pkValues) Sets the values of the primary key.

Methods inherited from class de.esprit.appsuite.database.dbase.DBRecordContainer

equals, getRecord, hashCode, toDumpString, toString

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.esprit.common.type.Dumpable

toDumpString, toDumpString, toString, toString

Constructor Detail

DBRecordWrapper

public DBRecordWrapper(R dbo)

Method Detail

getTranslationAppKey

public java.lang.String getTranslationAppKey()

Description copied from interface: DBRecord

Returns the main translation key for this record. This key is used as a prefix for all translations of this record.

Specified by:

getTranslationAppKey in interface DBRecord

getRenderText

public java.lang.String getRenderText()

Specified by:

getRenderText in interface Renderable

getRenderIcon

public javax.swing.Icon getRenderIcon()

Specified by:

getRenderIcon in interface Renderable

getRenderColor

public java.awt.Color getRenderColor()

Specified by:

getRenderColor in interface Renderable

getFieldCount

public int getFieldCount()

Description copied from interface: DBRecord

Returns the number columns of this DBObject including primary key columns

Specified by:

getFieldCount in interface DBRecord

getFieldFullNames

public java.lang.String[] getFieldFullNames()

Description copied from interface: DBRecord

Returns the full names of all columns in the format table.column

Specified by:

getFieldFullNames in interface DBRecord

getFieldNames

public java.lang.String[] getFieldNames()

Description copied from interface: DBRecord

Returns the names of all columns without the table prefix

Specified by:

getFieldNames in interface DBRecord

isPrimaryKey

public boolean isPrimaryKey(java.lang.String fieldName)

Description copied from interface: DBRecord

Tells wasCancelled this field is or is part of the primary key.

Specified by:

isPrimaryKey in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

isForeignKey

public boolean isForeignKey(java.lang.String fieldName)

Description copied from interface: DBRecord

Tells wasCancelled this field is a foreign key field.

Specified by:

isForeignKey in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

See Also:

DBRecord.getForeignKeyRef(String)

isNotNullField

public boolean isNotNullField(java.lang.String fieldName)

Description copied from interface: DBRecord

Tells wasCancelled this field is a not null field.

Specified by:

isNotNullField in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

existsField

public boolean existsField(java.lang.String fieldName)

Description copied from interface: DBRecord

Tells wasCancelled this field exists in this DBObject.

Specified by:

existsField in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

isFieldVirtual

public boolean isFieldVirtual(java.lang.String fieldName)

Description copied from interface: DBRecord

Tells wasCancelled this field is supposed to be editable. Composed objects might have fields that have no representation in the database (because they are calculated fields) and thus cannot be edited.

Specified by:

isFieldVirtual in interface DBRecord

Parameters:

fieldName - can be the pure column name or in the format table.column - only the column name is checked!

getForeignKeyRef

public java.lang.String getForeignKeyRef(java.lang.String fieldName)

Description copied from interface: DBRecord

If the given field is a foreign key field then the referenced fieldname is returned in the format table.column.

Specified by:

getForeignKeyRef in interface DBRecord

Parameters:

fieldName - The name of the field in the format table.column - only the column name is checked!

getValue

public java.lang.Object getValue(java.lang.String fieldName)

Description copied from interface: DBRecord

Returns the current value of the given fieldname.

Specified by:

getValue in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

getJdbcType

public int getJdbcType(java.lang.String fieldName)

Description copied from interface: DBRecord

Returns the jdbc-type of the given fieldname.

Specified by:

getJdbcType in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

See Also:

Types

getFieldLength

public int getFieldLength(java.lang.String fieldName)

Description copied from interface: DBRecord

Returns the length (in number or characters) of the given fieldname.

Specified by:

getFieldLength in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

getJavaType

public java.lang.Class getJavaType(java.lang.String fieldName)

Description copied from interface: DBRecord

Returns the java variable type of the given fieldname.

Specified by:

getJavaType in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

getFieldIcon

public java.lang.String getFieldIcon(java.lang.String fieldName)

Description copied from interface: DBRecord

Returns the name for an icon that should be used to render this column. The icon-name must be a pathname relative to the 'images/' base-directory and must not have any extension ('.gif' is supposed automatically).

Specified by:

getFieldIcon in interface DBRecord

Parameters:

fieldName - might be a pure column name or in the format table.column - only the column name is checked!

getManagedDBObjects

public DBObject[] getManagedDBObjects()

Description copied from interface: DBRecord

If the instance is a DBObject then the DBObject itself is returned. But if the object is composed of other DBObjects then a list of of all those building pieces must be returned (all who have the same primary key).

Example

For instance a 'Poti' object may consist of three DBObjects called 'DBO_part', 'DBO_resistor' and 'DBO_poti' - in the order of their inheritance hierarchy. All these objects have got the same primary key 'part_id'. Thus a 'Poti' object must return an array of the master instances of all comprising DBObjects which are 'DBO_part', 'DBO_resistor' and 'DBO_poti'.

Specified by:

getManagedDBObjects in interface DBRecord

getMasterRecord

public R getMasterRecord()

Specified by:

getMasterRecord in interface DBRecord

hasPrimaryKey

public boolean hasPrimaryKey()

Description copied from interface: DBPersistent

Tells whether this object has a primary key at all

Specified by:

hasPrimaryKey in interface DBPersistent

getPrimaryKeyCount

public int getPrimaryKeyCount()

Description copied from interface: DBPersistent

Returns the number of fields that compose the primary key

Specified by:

getPrimaryKeyCount in interface DBPersistent

getPrimaryKeyValues

public java.lang.String[] getPrimaryKeyValues()

Description copied from interface: DBPersistent

Returns the values of the primary key as a String array. Note that the primary key must consist of data types that are representable by a String!

Specified by:

getPrimaryKeyValues in interface DBPersistent

setPrimaryKeyValues

public void setPrimaryKeyValues(java.lang.String... pkValues)

Description copied from interface: DBPersistent

Sets the values of the primary key. Note that the order of the array elements must match the primary key definition in the table.

Specified by:

setPrimaryKeyValues in interface DBPersistent

dbUpdate

public void dbUpdate()
              throws java.lang.Exception

Description copied from interface: DBPersistent

Writes the object's current state to the database. After this action the state of the object will be valid.

Specified by:

dbUpdate in interface DBPersistent

Throws:

java.lang.Exception

See Also:

DBPersistent.isDirty()

dbInsert

public void dbInsert()
              throws java.lang.Exception

Description copied from interface: DBPersistent

Inserts the object as a record into the database.

Specified by:

dbInsert in interface DBPersistent

Throws:

java.lang.Exception

dbDelete

public void dbDelete()
              throws java.lang.Exception

Description copied from interface: DBPersistent

Deletes the representing record from the database. After this action the state of the object will be invalid.

Specified by:

dbDelete in interface DBPersistent

Throws:

java.lang.Exception

See Also:

DBPersistent.isDirty()

dbRehash

public void dbRehash()
              throws java.lang.Exception

Description copied from interface: DBPersistent

Re-reads the object state from the database. After this action the state of the object will be valid.

Specified by:

dbRehash in interface DBPersistent

Throws:

java.lang.Exception

See Also:

DBPersistent.isDirty()

dbSelect

public R[] dbSelect(SqlCondition condition)
                              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition. The default ordering is by primary key.

Specified by:

dbSelect in interface DBPersistent

Throws:

java.lang.Exception

dbSelect

public R[] dbSelect(SqlCondition condition,
           SqlOrder order)
                              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition and order.

Specified by:

dbSelect in interface DBPersistent

Throws:

java.lang.Exception

dbLoad

public void dbLoad(DBLoadMonitor monitor,
          SqlCondition condition)
            throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition. The default ordering is by primary key.

Specified by:

dbLoad in interface DBPersistent

Throws:

java.lang.Exception

dbLoad

public void dbLoad(DBLoadMonitor monitor,
          SqlCondition condition,
          SqlOrder order)
            throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition and order.

Specified by:

dbLoad in interface DBPersistent

Throws:

java.lang.Exception

dbSearch

public R[] dbSearch(SqlCondition condition)
                              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition. The default ordering is by primary key.

Specified by:

dbSearch in interface DBPersistent

Throws:

java.lang.Exception

dbSearch

public R[] dbSearch(SqlCondition condition,
           SqlOrder order)
                              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition and order.

Specified by:

dbSearch in interface DBPersistent

Throws:

java.lang.Exception

dbSearch

public void dbSearch(DBLoadMonitor monitor,
            SqlCondition condition)
              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition. The default ordering is by primary key.

Specified by:

dbSearch in interface DBPersistent

Throws:

java.lang.Exception

dbSearch

public void dbSearch(DBLoadMonitor monitor,
            SqlCondition condition,
            SqlOrder order)
              throws java.lang.Exception

Description copied from interface: DBPersistent

Reads a set of objects from from the database according to the given condition and order.

Specified by:

dbSearch in interface DBPersistent

Throws:

java.lang.Exception

exists

public boolean exists()

Description copied from interface: DBPersistent

Checks whether a matching object can be found in the database by performing a primary key lookup in the according table(s). Does not change the object itself in any way.

Specified by:

exists in interface DBPersistent

isDirty

public boolean isDirty()

Description copied from interface: DBPersistent

Tells whether this object is in sync with the database. If it has been modified since the last rehash it will be in a dirty state.

Specified by:

isDirty in interface DBPersistent

getRecordName

public java.lang.String getRecordName()

Description copied from interface: DBPersistent

Returns a unique name for this record, which is usually the tablename. On more complex composed persistent objects this may be any other identifying name.

Specified by:

getRecordName in interface DBPersistent

compareTo

public int compareTo(java.lang.Object arg)

Specified by:

compareTo in interface java.lang.Comparable

clone

public DBRecordWrapper clone()

Overrides:

clone in class DBRecordContainer<R extends DBRecord>

deepClone

public DBRecordWrapper deepClone()

Description copied from interface: DeepCloneable

Returns a deep clone of this object

Specified by:

deepClone in interface DeepCloneable

Overrides:

deepClone in class DBRecordContainer<R extends DBRecord>

copyRecordValues

public void copyRecordValues(DBRecord otherRecord,
                    boolean isIncludePK)
                      throws java.lang.Exception

Specified by:

copyRecordValues in interface DBRecord

Throws:

java.lang.Exception