|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.empire.commons.ErrorObject
org.apache.empire.db.DBObject
org.apache.empire.db.DBExpr
org.apache.empire.db.DBRowSet
public abstract class DBRowSet
This class is the base class for all the DBTable, CBView and DBQuery classes this class contains all the columns of the tables, views or querys
Field Summary |
---|
Fields inherited from class org.apache.empire.db.DBExpr |
---|
CTX_ALIAS, CTX_ALL, CTX_DEFAULT, CTX_FULLNAME, CTX_NAME, CTX_NOPARENTHESES, CTX_VALUE |
Constructor Summary | |
---|---|
DBRowSet(DBDatabase db)
Constructs a DBRecord object set the current database object. |
Method Summary | |
---|---|
void |
addReferencedColumns(java.util.Set<DBColumn> list)
Internal function to obtain all DBColumnExpr-objects used by this expression. |
DBColumnExpr |
count()
Returns a new DBCountExpr object. |
abstract boolean |
createRecord(DBRecord rec,
java.sql.Connection conn)
|
abstract boolean |
deleteRecord(java.lang.Object[] keys,
java.sql.Connection conn)
|
boolean |
deleteRecord(java.lang.Object id,
java.sql.Connection conn)
Deletes a single record from the database. |
abstract java.lang.String |
getAlias()
|
DBColumn |
getColumn(int iColumn)
Returns a DBColumn object by a specified index value. |
DBColumn |
getColumn(java.lang.String name)
Gets the column Expression with a particular name. |
int |
getColumnIndex(Column column)
Gets the index of a particular column expression. |
int |
getColumnIndex(DBColumn column)
Gets the index of a particular column expression. |
java.util.Map<DBColumn,DBColumn> |
getColumnReferences()
Returns the a list of column references. |
java.util.List<DBColumn> |
getColumns()
Gets all columns of this rowset (e.g. for cmd.select()). |
java.lang.String |
getComment()
|
DBDatabase |
getDatabase()
Returns the current DBDatabase object. |
java.lang.String |
getFullName()
Returns the full qualified name of the rowset. |
DBColumn[] |
getKeyColumns()
Returns an array of all primary key columns. |
abstract java.lang.String |
getName()
|
java.lang.Object[] |
getRecordKey(DBRecord rec)
Returns a array of primary key columns by a specified DBRecord object. |
DBColumn |
getTimestampColumn()
|
boolean |
initRecord(DBRecord rec,
DBRecordData recData)
Initializes a DBRecord for this rowset using the record data provided (i.e. from a DBReader) The record may then be modified and updated. |
boolean |
initRecord(DBRecord rec,
java.lang.Object[] keyValues)
Initializes a DBRecord for this RowSet and sets primary key values (the Object[] keyValues). |
boolean |
isColumnReadOnly(DBColumn col)
Checks whether a column is read only or writable. |
boolean |
isKeyColumn(DBColumn column)
Checks whether a given column is part of the primary key for this RowSet |
boolean |
readRecord(DBRecord rec,
java.lang.Object[] key,
java.sql.Connection conn)
Reads the record with the given primary key from the database. |
boolean |
recordExists(java.lang.Object[] key,
java.sql.Connection conn)
Returns true if the record exists in the database or false otherwise. |
boolean |
recordExists(java.lang.Object id,
java.sql.Connection conn)
Returns true if the record exists in the database or false otherwise. |
void |
setComment(java.lang.String comment)
|
void |
setTimestampColumn(DBColumn timestampColumn)
|
boolean |
updateRecord(DBRecord rec,
java.sql.Connection conn)
Updates or Inserts a record in the database. |
Methods inherited from class org.apache.empire.db.DBExpr |
---|
addSQL, getValueClass |
Methods inherited from class org.apache.empire.commons.ErrorObject |
---|
clearError, getErrorMessage, getErrorParams, getErrorSource, getErrorType, getMessage, hasError, isExceptionsEnabled, setExceptionsEnabled |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DBRowSet(DBDatabase db)
Method Detail |
---|
public abstract java.lang.String getName()
public abstract java.lang.String getAlias()
public abstract boolean createRecord(DBRecord rec, java.sql.Connection conn)
public abstract boolean deleteRecord(java.lang.Object[] keys, java.sql.Connection conn)
public java.lang.String getFullName()
public void addReferencedColumns(java.util.Set<DBColumn> list)
DBExpr
addReferencedColumns
in class DBExpr
list
- list to which all used column expressions must be addedDBExpr.addReferencedColumns(Set)
public final DBDatabase getDatabase()
getDatabase
in class DBObject
public java.util.List<DBColumn> getColumns()
public int getColumnIndex(DBColumn column)
public final int getColumnIndex(Column column)
public DBColumn getColumn(int iColumn)
public DBColumn getColumn(java.lang.String name)
public boolean isColumnReadOnly(DBColumn col)
public DBColumn[] getKeyColumns()
public boolean isKeyColumn(DBColumn column)
column
- the column to check
public java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- The comment to set.public DBColumn getTimestampColumn()
public void setTimestampColumn(DBColumn timestampColumn)
timestampColumn
- The timestampColumn to set.public java.util.Map<DBColumn,DBColumn> getColumnReferences()
public DBColumnExpr count()
public java.lang.Object[] getRecordKey(DBRecord rec)
rec
- the DBRecord object, contains all fields and the field properties
public boolean initRecord(DBRecord rec, java.lang.Object[] keyValues)
rec
- the Record objectkeyValues
- an array of the primary key columns
public boolean initRecord(DBRecord rec, DBRecordData recData)
rec
- the record objectrecData
- the record data from which to initialized the record
public boolean readRecord(DBRecord rec, java.lang.Object[] key, java.sql.Connection conn)
rec
- the DBRecord object which will hold the record datakey
- the primary key valuesconn
- a valid JDBC connection.
public boolean recordExists(java.lang.Object[] key, java.sql.Connection conn)
key
- an array of the primary key columnsconn
- a valid JDBC connection.
public final boolean recordExists(java.lang.Object id, java.sql.Connection conn)
id
- id of the recordconn
- a valid JDBC connection.
public boolean updateRecord(DBRecord rec, java.sql.Connection conn)
If a timestamp-column is set for this RowSet then a constraint will be added in the
update statement in order to detect concurrent changes.
If the record has been modified by another user, an error of type
DBErrors.RecordUpdateFailed will be set.
rec
- the DBRecord object. contains all fields and the field propertiesconn
- a valid JDBC connection.
public final boolean deleteRecord(java.lang.Object id, java.sql.Connection conn)
id
- the record's primary keyconn
- a valid JDBC connection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |