rs.data.impl

Class AbstractDaoFactory

java.lang.Object

rs.data.impl.AbstractDaoFactory

All Implemented Interfaces:

DaoFactory, rsbaselib.configuration.Configurable

public abstract class AbstractDaoFactory
extends Object
implements DaoFactory, rsbaselib.configuration.Configurable

The basic implementation of a DAO factory.

Author:

ralph

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDaoFactory.MyDaoListener Listener for DAO events.
protected class	AbstractDaoFactory.TransactionContext Keeps track of transaction creation.

Constructor Summary

Constructors

Constructor and Description
AbstractDaoFactory() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDaoFactoryListener(DaoFactoryListener listener) Adds a factory listener.
void	afterConfiguration()
void	beforeConfiguration()
void	begin() Begins a transaction.
void	commit() Commits a transaction.
void	configure(org.apache.commons.configuration.Configuration cfg)
protected GeneralDAO<?,?>	createDAO(org.apache.commons.configuration.Configuration mainCfg, String key) Creates an DAO from the configuration
protected TransactionManager	createTransactionManager() Creates a new transaction manager.
protected void	fireDaoFactoryEvent(DaoFactoryEvent event) Fires a factory event.
DaoMaster	getDaoMaster(String id) Returns the DAO master with given ID.
protected org.slf4j.Logger	getLog() Returns the logger object.
String	getParameter(String name) Returns the factory parameter.
Iterator<String>	getParameterKeys() Returns an iterator of all property keys.
URL	getParameterUrl(String name) Returns the factory parameter as a URL.
Object	getProperty(String name) Returns the factory property.
Transaction	getTransaction() Returns the current active transaction.
TransactionManager	getTransactionManager() Returns the TX manager used.
URLTransformer	getUrlTransformer() Returns the urlTransformer.
DaoMaster	loadDaoMaster(org.apache.commons.configuration.SubnodeConfiguration config) Loads an object from a configuration.
void	modelChanged() Registers the current context that the model changed underneath.
void	removeDaoFactoryListener(DaoFactoryListener listener) Removes a factory listener.
void	rollback() Rolls back a transaction.
void	setDaoMaster(String id, DaoMaster daoMaster) Sets the DAO master.
void	setProperty(String name, Object value) Sets the property.
void	setTransactionManager(TransactionManager txManager) Sets the given TX manager to be used.
void	setUrlTransformer(URLTransformer urlTransformer) Sets the urlTransformer.

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

getDaoFor, getDaoFor

Constructor Detail

AbstractDaoFactory

public AbstractDaoFactory()

Constructor.

Method Detail

getLog

protected org.slf4j.Logger getLog()

Returns the logger object.

Returns:

the logger object

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

loadDaoMaster

public DaoMaster loadDaoMaster(org.apache.commons.configuration.SubnodeConfiguration config)

Loads an object from a configuration. The object is configured if it is an instance of Configurable.

Parameters:

config - configuration

Returns:

the object

setDaoMaster

public void setDaoMaster(String id,
                DaoMaster daoMaster)

Sets the DAO master.

Parameters:

id - id of master

daoMaster - master to bet set

getDaoMaster

public DaoMaster getDaoMaster(String id)

Returns the DAO master with given ID.

Specified by:

getDaoMaster in interface DaoFactory

Parameters:

id - ID of master

Returns:

the master or null

createDAO

protected GeneralDAO<?,?> createDAO(org.apache.commons.configuration.Configuration mainCfg,
                        String key)
                             throws Exception

Creates an DAO from the configuration

Parameters:

mainCfg - main config object

key - key to process

Returns:

DAO created

Throws:

Exception

getProperty

public Object getProperty(String name)

Returns the factory property.

Specified by:

getProperty in interface DaoFactory

Parameters:

name - name of property

Returns:

value or NULL

setProperty

public void setProperty(String name,
               Object value)

Sets the property.

Specified by:

setProperty in interface DaoFactory

Parameters:

name - name of property

value - value of property

getParameter

public String getParameter(String name)

Returns the factory parameter.

Specified by:

getParameter in interface DaoFactory

Parameters:

name - name of parameter

Returns:

value or NULL

getParameterKeys

public Iterator<String> getParameterKeys()

Returns an iterator of all property keys.

Specified by:

getParameterKeys in interface DaoFactory

Returns:

iterator

getParameterUrl

public URL getParameterUrl(String name)
                    throws MalformedURLException

Returns the factory parameter as a URL.

Specified by:

getParameterUrl in interface DaoFactory

Parameters:

name - name of parameter

Returns:

value or NULL

Throws:

MalformedURLException

getUrlTransformer

public URLTransformer getUrlTransformer()

Returns the urlTransformer.

Specified by:

getUrlTransformer in interface DaoFactory

Returns:

the urlTransformer

setUrlTransformer

public void setUrlTransformer(URLTransformer urlTransformer)

Sets the urlTransformer.

Specified by:

setUrlTransformer in interface DaoFactory

Parameters:

urlTransformer - the urlTransformer to set

getTransactionManager

public TransactionManager getTransactionManager()

Returns the TX manager used. If there was no TX manager set before, this method will create a TX manager.

Specified by:

getTransactionManager in interface DaoFactory

Returns:

the transaction manager

createTransactionManager

protected TransactionManager createTransactionManager()

Creates a new transaction manager.

Returns:

a new transaction manager

setTransactionManager

public void setTransactionManager(TransactionManager txManager)

Sets the given TX manager to be used. This method will throw an exception if there is already a TX manager active.

Specified by:

setTransactionManager in interface DaoFactory

Parameters:

txManager - the TX manager.

begin

public void begin()

Begins a transaction. This method does nothing if the thread is already within a transaction.

Specified by:

begin in interface DaoFactory

commit

public void commit()

Commits a transaction. If the last call to DaoFactory.begin() did not start a new TX then this method does nothing.

Specified by:

commit in interface DaoFactory

rollback

public void rollback()

Rolls back a transaction. If the last call to DaoFactory.begin() did not start a new TX then this method does nothing.

Specified by:

rollback in interface DaoFactory

getTransaction

public Transaction getTransaction()
                           throws SystemException

Returns the current active transaction.

Specified by:

getTransaction in interface DaoFactory

Returns:

current transaction

Throws:

SystemException - if there is a problem

addDaoFactoryListener

public void addDaoFactoryListener(DaoFactoryListener listener)

Adds a factory listener.

Specified by:

addDaoFactoryListener in interface DaoFactory

Parameters:

listener - listener

removeDaoFactoryListener

public void removeDaoFactoryListener(DaoFactoryListener listener)

Removes a factory listener.

Specified by:

removeDaoFactoryListener in interface DaoFactory

Parameters:

listener - listener

fireDaoFactoryEvent

protected void fireDaoFactoryEvent(DaoFactoryEvent event)

Fires a factory event.

Parameters:

event - event to be fired

modelChanged

public void modelChanged()

Registers the current context that the model changed underneath.