rs.data.impl.dao

Class AbstractGeneralDAO<K extends Serializable,B extends AbstractGeneralBO<K>,C extends GeneralBO<K>>

java.lang.Object

rs.data.impl.dao.AbstractGeneralDAO<K,B,C>

Type Parameters:

K - type of primary key

B - type of Business Object Implementation

C - type of Business Object Interface

All Implemented Interfaces:

GeneralDAO<K,C>, rsbaselib.configuration.Configurable

Direct Known Subclasses:

AbstractDAO

public abstract class AbstractGeneralDAO<K extends Serializable,B extends AbstractGeneralBO<K>,C extends GeneralBO<K>>
extends Object
implements GeneralDAO<K,C>, rsbaselib.configuration.Configurable

Abstract Implementation for Data Access Objects.

Author:

ralph

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractGeneralDAO() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	_create(B object) Creates the object.
protected abstract void	_delete(B object) Deletes the object.
protected abstract void	_save(B object) Saves the object.
protected void	addCached(B object) Add the given object to the cache.
void	addDaoListener(DaoListener listener) Adds a DAO event listener.
void	afterConfiguration()
protected void	afterCreate(C object) Called immediately after creation.
protected void	afterDelete(C object) Called immediately after deletion.
protected void	afterNewInstance(C object) Called after a new instance was created.
protected void	afterSave(C object) Called immediately after saving.
void	beforeConfiguration()
protected void	beforeCreate(C object) Called immediately before creation.
protected void	beforeDelete(C object) Called immediately before deletion.
protected void	beforeSave(C object) Called immediately before saving.
void	configure(org.apache.commons.configuration.Configuration cfg)
void	create(C object) Inserts the object into the database if it does not exist.
void	create(C object, boolean setCreationDate) Inserts the object into the database if it does not exist.
void	createObject(Object object) Inserts the object into the database if it does not exist.
void	createObject(Object object, boolean setCreationDate) Creates the object.
void	delete(C object) Deletes the object.
void	deleteObject(Object object) DELETING
List<C>	findAll() Returns all domain objects.
List<C>	findDefaultAll() Returns domain objects with default criteria.
protected void	fireAllDefaultDeleted() Fires a DAO all-delete event.
protected void	fireAllDeleted() Fires a DAO all-delete event.
protected void	fireDaoEvent(DaoEvent event) Fires a DAO delete event.
protected void	fireObjectCreated(C object) Fires a DAO create event.
protected void	fireObjectDeleted(C object) Fires a DAO delete event.
protected void	fireObjectUpdated(C object) Fires a DAO update event.
protected Class<B>	getBoImplementationClass() Returns the boImplementationClass.
protected Class<C>	getBoInterfaceClass() Returns the boInterfaceClass.
protected B	getCached(CID cid) Returns an object from the cache.
DaoMaster	getDaoMaster() Returns the DAO master.
DaoFactory	getFactory() Returns the DAO factory.
Class<K>	getKeyClass() Returns the keyClass.
protected org.slf4j.Logger	getLog() Returns the log.
protected void	init() Initializes / called from constructor.
DaoIterator<C>	iterateAll() Returns all domain objects.
DaoIterator<C>	iterateDefaultAll() Returns domain objects with default criteria.
C	newInstance() Create a new domain class instance.
void	removeDaoListener(DaoListener listener) Removes a DAO event listener.
void	save(C object) Saves the object.
void	save(C object, boolean setChangeDate) Saves the object.
void	saveObject(Object object) Saves the object.
void	saveObject(Object object, boolean setChangeDate) Saves the object.
void	setDaoMaster(DaoMaster daoMaster) Sets the DAO master.
void	setFactory(DaoFactory factory) Sets the factory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface rs.data.api.dao.GeneralDAO

deleteAll, deleteDefaultAll, findAll, findById, findDefaultAll, getDefaultObjectCount, getObjectCount, iterateAll, iterateDefaultAll

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

AbstractGeneralDAO

public AbstractGeneralDAO()

Constructor.

Method Detail

init

protected void init()

Initializes / called from constructor.

configure

public void configure(org.apache.commons.configuration.Configuration cfg)
               throws org.apache.commons.configuration.ConfigurationException

Specified by:

configure in interface rsbaselib.configuration.Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

beforeConfiguration

public void beforeConfiguration()

Specified by:

beforeConfiguration in interface rsbaselib.configuration.Configurable

afterConfiguration

public void afterConfiguration()

Specified by:

afterConfiguration in interface rsbaselib.configuration.Configurable

getLog

protected org.slf4j.Logger getLog()

Returns the log.

Returns:

the log

getKeyClass

public Class<K> getKeyClass()

Returns the keyClass.

Returns:

the keyClass

getBoImplementationClass

protected Class<B> getBoImplementationClass()

Returns the boImplementationClass.

Returns:

the boImplementationClass

getBoInterfaceClass

protected Class<C> getBoInterfaceClass()

Returns the boInterfaceClass.

Returns:

the boInterfaceClass

getFactory

public DaoFactory getFactory()

Returns the DAO factory.

Specified by:

getFactory in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

the DAO factory this DAO is assigned to

setFactory

public void setFactory(DaoFactory factory)

Sets the factory.

Specified by:

setFactory in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

getDaoMaster

public DaoMaster getDaoMaster()

Returns the DAO master.

Specified by:

getDaoMaster in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

the DAO master

setDaoMaster

public void setDaoMaster(DaoMaster daoMaster)

Sets the DAO master.

Specified by:

setDaoMaster in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

daoMaster - the master

newInstance

public C newInstance()

Create a new domain class instance. This method will set the creation date.

Specified by:

newInstance in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

new instance

afterNewInstance

protected void afterNewInstance(C object)

Called after a new instance was created.

Parameters:

object - object being created

addCached

protected void addCached(B object)

Add the given object to the cache.

Parameters:

object - object to add

getCached

protected B getCached(CID cid)

Returns an object from the cache.

Parameters:

cid - CID of object

createObject

public void createObject(Object object)

Inserts the object into the database if it does not exist. This method will set the creation date.

Specified by:

createObject in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - domain class instance

createObject

public void createObject(Object object,
                boolean setCreationDate)

Creates the object.

Specified by:

createObject in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

setCreationDate - whether creationDate will be set

See Also:

GeneralDAO.create(GeneralBO, boolean)

create

public void create(C object)

Inserts the object into the database if it does not exist. This method will set the creation date.

Specified by:

create in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - domain class instance

create

public void create(C object,
          boolean setCreationDate)

Inserts the object into the database if it does not exist.

Specified by:

create in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - domain class instance

setCreationDate - whether creation date shall be set

_create

protected abstract void _create(B object)

Creates the object. This method assumes that the object does not exist.

Parameters:

object - BO to be saved

See Also:

createObject(Object)

beforeCreate

protected void beforeCreate(C object)

Called immediately before creation. This method does nothing.

Parameters:

object - object to be created

afterCreate

protected void afterCreate(C object)

Called immediately after creation. This method does nothing.

Parameters:

object - object created

findAll

public List<C> findAll()

Returns all domain objects.

Specified by:

findAll in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

list of all objects

findDefaultAll

public List<C> findDefaultAll()

Returns domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Specified by:

findDefaultAll in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

list of all objects

iterateAll

public DaoIterator<C> iterateAll()

Returns all domain objects.

Specified by:

iterateAll in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

list of all objects

iterateDefaultAll

public DaoIterator<C> iterateDefaultAll()

Returns domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Specified by:

iterateDefaultAll in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Returns:

list of all objects

saveObject

public void saveObject(Object object)

Saves the object. This method assumes that the object already exists. Also, this method will set the change date.

Specified by:

saveObject in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

saveObject

public void saveObject(Object object,
              boolean setChangeDate)

Saves the object. This method assumes that the object already exists.

Specified by:

saveObject in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

setChangeDate - whether changeDate will be set

save

public void save(C object)

Saves the object. This method assumes that the object already exists. Also, this method will set the change date.

Specified by:

save in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

save

public void save(C object,
        boolean setChangeDate)

Saves the object. This method assumes that the object already exists.

Specified by:

save in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

setChangeDate - whether changeDate will be set

beforeSave

protected void beforeSave(C object)

Called immediately before saving. This method does nothing.

Parameters:

object - object to be saved

afterSave

protected void afterSave(C object)

Called immediately after saving. This method does nothing.

Parameters:

object - object saved

_save

protected abstract void _save(B object)

Saves the object. This method assumes that the object already exists.

Parameters:

object - BO to be saved

See Also:

create(GeneralBO, boolean)

deleteObject

public void deleteObject(Object object)

DELETING

Specified by:

deleteObject in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be saved

delete

public void delete(C object)

Deletes the object. This method assumes that the object existed before.

Specified by:

delete in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

object - object to be deleted.

beforeDelete

protected void beforeDelete(C object)

Called immediately before deletion. This method does nothing.

Parameters:

object - object to be deleted

afterDelete

protected void afterDelete(C object)

Called immediately after deletion. This method does nothing.

Parameters:

object - object deleted

_delete

protected abstract void _delete(B object)

Deletes the object. This method assumes that the object existed before.

Parameters:

object - DTO to be deleted.

addDaoListener

public void addDaoListener(DaoListener listener)

Adds a DAO event listener.

Specified by:

addDaoListener in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

listener - listener

removeDaoListener

public void removeDaoListener(DaoListener listener)

Removes a DAO event listener.

Specified by:

removeDaoListener in interface GeneralDAO<K extends Serializable,C extends GeneralBO<K>>

Parameters:

listener - listener

fireObjectCreated

protected void fireObjectCreated(C object)

Fires a DAO create event.

Parameters:

object - object created

fireObjectUpdated

protected void fireObjectUpdated(C object)

Fires a DAO update event.

Parameters:

object - object created

fireObjectDeleted

protected void fireObjectDeleted(C object)

Fires a DAO delete event.

Parameters:

object - object created

fireAllDeleted

protected void fireAllDeleted()

Fires a DAO all-delete event.

fireAllDefaultDeleted

protected void fireAllDefaultDeleted()

Fires a DAO all-delete event.

fireDaoEvent

protected void fireDaoEvent(DaoEvent event)

Fires a DAO delete event.

Parameters:

event - event to be fired