de.uhilger.baselink

Interface Record

All Known Implementing Classes:

BaseRecord, GenericRecord

public interface Record

Classes that map objects to and from database records need to implement this interface.

Author:

Copyright (c) Ulrich Hilger, http://uhilger.de, Published under the terms and conditions of the GNU General Public License

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	WITH_BLOBS indicator to include BLOBS in read / write operations
static boolean	WITHOUT_BLOBS indicator to exclude BLOBS from read / write operations

Method Summary

Modifier and Type	Method and Description
java.sql.PreparedStatement	getDeleteStatment(java.sql.Connection c, java.lang.Object record) Get a statement suitable to delete a given object from the database
java.sql.PreparedStatement	getInsertStatment(java.sql.Connection c, java.lang.Object record) Get a statement suitable to insert a given object to the database
java.sql.PreparedStatement	getInsertStmt(java.sql.Connection c, java.lang.Object record, int autoGeneratedKeys) Get a statement suitable to insert a given object to the database
java.lang.String	getTableName() Get the name of the database table this record references
java.sql.PreparedStatement	getUpdateStatment(java.sql.Connection c, java.lang.Object record) Get a statement suitable to update a given object in the database
java.lang.Object	toObject(java.sql.ResultSet resultSet, boolean includeBlobs) Get contents of this record as an object

Field Detail

WITH_BLOBS

static final boolean WITH_BLOBS

indicator to include BLOBS in read / write operations

See Also:

Constant Field Values

WITHOUT_BLOBS

static final boolean WITHOUT_BLOBS

indicator to exclude BLOBS from read / write operations

See Also:

Constant Field Values

Method Detail

getTableName

java.lang.String getTableName()

Get the name of the database table this record references

Returns:

the table name

toObject

java.lang.Object toObject(java.sql.ResultSet resultSet,
                          boolean includeBlobs)
                   throws java.lang.Exception

Get contents of this record as an object

Parameters:

resultSet - a resultSet that points to the record to get as an object

includeBlobs - indicator whether or not to include BLOBs

Returns:

an object having the data of this record

Throws:

java.lang.Exception

getInsertStmt

java.sql.PreparedStatement getInsertStmt(java.sql.Connection c,
                                         java.lang.Object record,
                                         int autoGeneratedKeys)
                                  throws java.lang.Exception

Get a statement suitable to insert a given object to the database

Parameters:

c - the database connection to use for the insert

record - the object to insert

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

the insert statement

Throws:

java.lang.Exception

getInsertStatment

java.sql.PreparedStatement getInsertStatment(java.sql.Connection c,
                                             java.lang.Object record)
                                      throws java.lang.Exception

Get a statement suitable to insert a given object to the database

Parameters:

c - the database connection to use for the insert

record - the object to insert

Returns:

the insert statement

Throws:

java.lang.Exception

getUpdateStatment

java.sql.PreparedStatement getUpdateStatment(java.sql.Connection c,
                                             java.lang.Object record)
                                      throws java.lang.Exception

Get a statement suitable to update a given object in the database

Parameters:

c - the database connection to use for the update

record - the object to update

Returns:

the update statement

Throws:

java.lang.Exception

getDeleteStatment

java.sql.PreparedStatement getDeleteStatment(java.sql.Connection c,
                                             java.lang.Object record)
                                      throws java.lang.Exception

Get a statement suitable to delete a given object from the database

Parameters:

c - the database connection to use for the delete

record - the object to delete

Returns:

the delete statement

Throws:

java.lang.Exception