de.esprit.appsuite.database.dbase

Interface DBRecord

All Superinterfaces:

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

All Known Implementing Classes:

AbstractDatabaseGroup, AbstractDatabaseUser, AbstractDBRecordABO, ComposedRecord, DatabaseUser, DBGroup, DBO_esprit_group, DBO_esprit_user, DBO_esprit_userlist_view, DBO_insert_def, DBO_tnt_alltype, DBO_tnt_logmsg, DBO_tnt_nopk, DBO_tnt_persistent_type, DBO_tnt_pk_composed, DBO_tnt_pktype, DBO_tnt_route, DBO_tnt_route_vertex, DBO_tnt_stdtype, DBO_tnt_tank, DBObject, DBRecordWrapper

public interface DBRecord
extends DBPersistent, java.lang.Comparable, Renderable

This interface ensures a consistent view to objects that are database persistent. Objects implementing this interface can be used within DBRecordTables, DBRecordLists and other DBObject related tool classes.

Author:

Rainer Buesch

Method Summary

Methods

Modifier and Type	Method and Description
void	copyRecordValues(DBRecord otherRecord, boolean isIncludePK)
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 extends DBRecord> R	getMasterRecord()
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	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.

Methods inherited from interface de.esprit.appsuite.database.dbase.DBPersistent

dbDelete, dbInsert, dbLoad, dbLoad, dbRehash, dbSearch, dbSearch, dbSearch, dbSearch, dbSelect, dbSelect, dbUpdate, exists, getPrimaryKeyCount, getPrimaryKeyValues, getRecordName, hasPrimaryKey, isDirty, setPrimaryKeyValues

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

deepClone

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

toDumpString, toDumpString, toString, toString

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.esprit.common.gui.Renderable

getRenderColor, getRenderIcon, getRenderText

Method Detail

getTranslationAppKey

java.lang.String getTranslationAppKey()

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

getFieldCount

int getFieldCount()

Returns the number columns of this DBObject including primary key columns

getFieldFullNames

java.lang.String[] getFieldFullNames()

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

getFieldNames

java.lang.String[] getFieldNames()

Returns the names of all columns without the table prefix

isPrimaryKey

boolean isPrimaryKey(java.lang.String fieldName)

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

Parameters:

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

isForeignKey

boolean isForeignKey(java.lang.String fieldName)

Tells wasCancelled this field is a foreign key field.

Parameters:

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

See Also:

getForeignKeyRef(String)

isNotNullField

boolean isNotNullField(java.lang.String fieldName)

Tells wasCancelled this field is a not null field.

Parameters:

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

existsField

boolean existsField(java.lang.String fieldName)

Tells wasCancelled this field exists in this DBObject.

Parameters:

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

isFieldVirtual

boolean isFieldVirtual(java.lang.String fieldName)

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.

Parameters:

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

getForeignKeyRef

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.

Parameters:

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

getValue

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

Returns the current value of the given fieldname.

Parameters:

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

getJdbcType

int getJdbcType(java.lang.String fieldName)

Returns the jdbc-type of the given fieldname.

Parameters:

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

See Also:

Types

getFieldLength

int getFieldLength(java.lang.String fieldName)

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

Parameters:

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

getJavaType

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

Returns the java variable type of the given fieldname.

Parameters:

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

getFieldIcon

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

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).

Parameters:

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

getManagedDBObjects

DBObject[] getManagedDBObjects()

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'.

getMasterRecord

<R extends DBRecord> R getMasterRecord()

copyRecordValues

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

Throws:

java.lang.Exception