com.communote.server.persistence.config

Class SettingDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.config.SettingDaoBase

All Implemented Interfaces:

SettingDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SettingDaoImpl

public abstract class SettingDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements SettingDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type com.communote.server.persistence.config.Setting.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Setting

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface com.communote.server.persistence.config.SettingDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
SettingDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<Setting>	create(Collection<Setting> entities) Creates a new instance of com.communote.server.persistence.config.Setting and adds from the passed in entities collection
Collection<Setting>	create(int transform, Collection<Setting> entities) Does the same thing as SettingDao.create(com.communote.server.model.config.Setting) with an additional flag called transform.
Object	create(int transform, Setting setting) Does the same thing as SettingDao.create(com.communote.server.model.config.Setting) with an additional flag called transform.
Setting	create(Setting setting) Creates an instance of com.communote.server.persistence.config.Setting and adds it to the persistent store.
void	evict(Setting entity) Evicts (removes) the entity from the hibernate cache
Object	load(int transform, String settingKey) Does the same thing as SettingDao.load(String) with an additional flag called transform.
Setting	load(String settingKey) Loads an instance of com.communote.server.persistence.config.Setting from the persistent store.
Collection<Setting>	loadAll() Loads all entities of type Setting.
Collection<?>	loadAll(int transform) Does the same thing as SettingDao.loadAll() with an additional flag called transform.
void	remove(Collection<Setting> entities) Removes all entities in the given entities collection.
void	remove(Setting setting) Removes the instance of com.communote.server.persistence.config.Setting from the persistent store.
void	remove(String settingKey) Removes the instance of com.communote.server.persistence.config.Setting having the given identifier from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,Setting) method.
protected Object	transformEntity(int transform, Setting entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.config.SettingDao, please note that the SettingDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Setting> entities) Updates all instances in the entities collection in the persistent store.
void	update(Setting setting) Updates the setting instance in the persistent store.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingDaoBase

public SettingDaoBase()

Method Detail

create

public Collection<Setting> create(int transform,
                                  Collection<Setting> entities)

Description copied from interface: SettingDao

Does the same thing as SettingDao.create(com.communote.server.model.config.Setting) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Specified by:

create in interface SettingDao

See Also:

com.communote.server.persistence.config.SettingDao#create(int, java.util.Collection)

create

public Object create(int transform,
                     Setting setting)

Description copied from interface: SettingDao

Does the same thing as SettingDao.create(com.communote.server.model.config.Setting) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface SettingDao

See Also:

com.communote.server.persistence.config.SettingDao#create(int transform, com.communote.server.persistence.config.Setting)

create

public Collection<Setting> create(Collection<Setting> entities)

Description copied from interface: SettingDao

Creates a new instance of com.communote.server.persistence.config.Setting and adds from the passed in entities collection

Specified by:

create in interface SettingDao

Parameters:

entities - the collection of com.communote.server.persistence.config.Setting instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.config.SettingDao#create(java.util.Collection)

create

public Setting create(Setting setting)

Description copied from interface: SettingDao

Creates an instance of com.communote.server.persistence.config.Setting and adds it to the persistent store.

Specified by:

create in interface SettingDao

See Also:

SettingDao.create(Setting)

evict

public void evict(Setting entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface SettingDao

Parameters:

entity - the entity to evict

load

public Object load(int transform,
                   String settingKey)

Description copied from interface: SettingDao

Does the same thing as SettingDao.load(String) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface SettingDao

settingKey - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

SettingDao.load(int, String)

load

public Setting load(String settingKey)

Description copied from interface: SettingDao

Loads an instance of com.communote.server.persistence.config.Setting from the persistent store.

Specified by:

load in interface SettingDao

See Also:

SettingDao.load(String)

loadAll

public Collection<Setting> loadAll()

Description copied from interface: SettingDao

Loads all entities of type Setting.

Specified by:

loadAll in interface SettingDao

Returns:

the loaded entities.

See Also:

SettingDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: SettingDao

Does the same thing as SettingDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

loadAll in interface SettingDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

SettingDao.loadAll(int)

remove

public void remove(Collection<Setting> entities)

Description copied from interface: SettingDao

Removes all entities in the given entities collection.

Specified by:

remove in interface SettingDao

See Also:

com.communote.server.persistence.config.SettingDao#remove(java.util.Collection)

remove

public void remove(Setting setting)

Description copied from interface: SettingDao

Removes the instance of com.communote.server.persistence.config.Setting from the persistent store.

Specified by:

remove in interface SettingDao

See Also:

SettingDao.remove(Setting)

remove

public void remove(String settingKey)

Description copied from interface: SettingDao

Removes the instance of com.communote.server.persistence.config.Setting having the given identifier from the persistent store.

Specified by:

remove in interface SettingDao

See Also:

SettingDao.remove(String)

transformEntities

protected void transformEntities(int transform,
                                 Collection<?> entities)

Transforms a collection of entities using the transformEntity(int,Setting) method. This method does not instantiate a new collection.

This method is to be used internally only.

Parameters:

transform - one of the constants declared in com.communote.server.persistence.config.SettingDao

entities - the collection of entities to transform

See Also:

transformEntity(int,Setting)

transformEntity

protected Object transformEntity(int transform,
                                 Setting entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.config.SettingDao, please note that the SettingDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown SettingDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in SettingDao

entity - an entity that was found

Returns:

the transformed entity (i.e. new value object, etc)

See Also:

transformEntities(int,java.util.Collection)

update

public void update(Collection<Setting> entities)

Description copied from interface: SettingDao

Updates all instances in the entities collection in the persistent store.

Specified by:

update in interface SettingDao

See Also:

com.communote.server.persistence.config.SettingDao#update(java.util.Collection)

update

public void update(Setting setting)

Description copied from interface: SettingDao

Updates the setting instance in the persistent store.

Specified by:

update in interface SettingDao

See Also:

SettingDao.update(Setting)