de.uhilger.baselink

Class BaseRecord

java.lang.Object

de.uhilger.baselink.BaseRecord

All Implemented Interfaces:

Record

public abstract class BaseRecord
extends java.lang.Object
implements Record

Abstract base class for objects that like to implement the Record interface. This class is meant as a convenience so that not all methods need to be implmented. Simply implement those needed by overriding the necessary ones.

Author:

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

Field Summary

Fields inherited from interface de.uhilger.baselink.Record

WITH_BLOBS, WITHOUT_BLOBS

Constructor Summary

Constructors

Constructor and Description
BaseRecord()

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 Override this method in subclasses as required
java.sql.PreparedStatement	getInsertStatment(java.sql.Connection c, java.lang.Object record) Get a statement suitable to insert a given object to the database Override this method in subclasses as required
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 Override this method in subclasses as required
java.sql.PreparedStatement	getUpdateStatment(java.sql.Connection c, java.lang.Object record) Get a statement suitable to update a given object in the database Override this method in subclasses as required
java.lang.Object	toObject(java.sql.ResultSet resultSet, boolean includeBlobs) Get contents of this record as an object Override this method in subclasses as required

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseRecord

public BaseRecord()

Method Detail

getDeleteStatment

public 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

Override this method in subclasses as required

Specified by:

getDeleteStatment in interface Record

Parameters:

c - the database connection to use for the delete

record - the object to delete

Returns:

the delete statement

Throws:

java.lang.Exception

getInsertStatment

public 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

Override this method in subclasses as required

Specified by:

getInsertStatment in interface Record

Parameters:

c - the database connection to use for the insert

record - the object to insert

Returns:

the insert statement

Throws:

java.lang.Exception

getInsertStmt

public 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

Specified by:

getInsertStmt in interface Record

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

getTableName

public java.lang.String getTableName()

Get the name of the database table this record references

Override this method in subclasses as required

Specified by:

getTableName in interface Record

Returns:

the table name

getUpdateStatment

public 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

Override this method in subclasses as required

Specified by:

getUpdateStatment in interface Record

Parameters:

c - the database connection to use for the update

record - the object to update

Returns:

the update statement

Throws:

java.lang.Exception

toObject

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

Get contents of this record as an object

Override this method in subclasses as required

Specified by:

toObject in interface Record

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