com.communote.server.persistence.external

Class ExternalObjectDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.external.ExternalObjectDaoBase

All Implemented Interfaces:

ExternalObjectDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ExternalObjectDaoImpl

public abstract class ExternalObjectDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ExternalObjectDao

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

Author:

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

See Also:

ExternalObject

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.external.ExternalObjectDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
ExternalObjectDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<ExternalObject>	create(Collection<ExternalObject> entities) Creates a new instance of com.communote.server.persistence.external.ExternalObject and adds from the passed in entities collection
ExternalObject	create(ExternalObject externalObject) Creates an instance of com.communote.server.persistence.external.ExternalObject and adds it to the persistent store.
Collection<ExternalObject>	create(int transform, Collection<ExternalObject> entities) Does the same thing as ExternalObjectDao.create(com.communote.server.model.external.ExternalObject) with an additional flag called transform.
Object	create(int transform, ExternalObject externalObject) Does the same thing as ExternalObjectDao.create(com.communote.server.model.external.ExternalObject) with an additional flag called transform.
void	evict(ExternalObject entity) Evicts (removes) the entity from the hibernate cache
Object	load(int transform, Long id) Does the same thing as ExternalObjectDao.load(Long) with an additional flag called transform.
ExternalObject	load(Long id) Loads an instance of com.communote.server.persistence.external.ExternalObject from the persistent store.
Collection<ExternalObject>	loadAll() Loads all entities of type ExternalObject.
Collection<?>	loadAll(int transform) Does the same thing as ExternalObjectDao.loadAll() with an additional flag called transform.
void	remove(Collection<ExternalObject> entities) Removes all entities in the given entities collection.
void	remove(ExternalObject externalObject) Removes the instance of com.communote.server.persistence.external.ExternalObject from the persistent store.
void	remove(Long id) Removes the instance of com.communote.server.persistence.external.ExternalObject having the given identifier from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.external.ExternalObject) method.
protected Object	transformEntity(int transform, ExternalObject 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.external.ExternalObjectDao, please note that the ExternalObjectDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<ExternalObject> entities) Updates all instances in the entities collection in the persistent store.
void	update(ExternalObject externalObject) Updates the externalObject 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

ExternalObjectDaoBase

public ExternalObjectDaoBase()

Method Detail

create

public ExternalObject create(ExternalObject externalObject)

Description copied from interface: ExternalObjectDao

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

Specified by:

create in interface ExternalObjectDao

See Also:

ExternalObjectDao.create(com.communote.server.model.external.ExternalObject)

create

public Object create(int transform,
                     ExternalObject externalObject)

Description copied from interface: ExternalObjectDao

Does the same thing as ExternalObjectDao.create(com.communote.server.model.external.ExternalObject) 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 ExternalObjectDao

See Also:

com.communote.server.persistence.external.ExternalObjectDao#create(int transform, com.communote.server.persistence.external.ExternalObject)

create

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

Description copied from interface: ExternalObjectDao

Does the same thing as ExternalObjectDao.create(com.communote.server.model.external.ExternalObject) 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 ExternalObjectDao

See Also:

com.communote.server.persistence.external.ExternalObjectDao#create(int, java.util.Collection)

create

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

Description copied from interface: ExternalObjectDao

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

Specified by:

create in interface ExternalObjectDao

Parameters:

entities - the collection of com.communote.server.persistence.external.ExternalObject instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.external.ExternalObjectDao#create(java.util.Collection)

evict

public void evict(ExternalObject entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface ExternalObjectDao

Parameters:

entity - the entity to evict

load

public Object load(int transform,
                   Long id)

Description copied from interface: ExternalObjectDao

Does the same thing as ExternalObjectDao.load(Long) 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 ExternalObjectDao

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

ExternalObjectDao.load(int, Long)

load

public ExternalObject load(Long id)

Description copied from interface: ExternalObjectDao

Loads an instance of com.communote.server.persistence.external.ExternalObject from the persistent store.

Specified by:

load in interface ExternalObjectDao

See Also:

ExternalObjectDao.load(Long)

loadAll

public Collection<ExternalObject> loadAll()

Description copied from interface: ExternalObjectDao

Loads all entities of type ExternalObject.

Specified by:

loadAll in interface ExternalObjectDao

Returns:

the loaded entities.

See Also:

ExternalObjectDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: ExternalObjectDao

Does the same thing as ExternalObjectDao.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 ExternalObjectDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

ExternalObjectDao.loadAll(int)

remove

public void remove(ExternalObject externalObject)

Description copied from interface: ExternalObjectDao

Removes the instance of com.communote.server.persistence.external.ExternalObject from the persistent store.

Specified by:

remove in interface ExternalObjectDao

See Also:

ExternalObjectDao.remove(com.communote.server.model.external.ExternalObject)

remove

public void remove(Collection<ExternalObject> entities)

Description copied from interface: ExternalObjectDao

Removes all entities in the given entities collection.

Specified by:

remove in interface ExternalObjectDao

See Also:

com.communote.server.persistence.external.ExternalObjectDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: ExternalObjectDao

Removes the instance of com.communote.server.persistence.external.ExternalObject having the given identifier from the persistent store.

Specified by:

remove in interface ExternalObjectDao

See Also:

ExternalObjectDao.remove(Long)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.external.ExternalObject) 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.external.ExternalObjectDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.external.ExternalObject)

transformEntity

protected Object transformEntity(int transform,
                                 ExternalObject 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.external.ExternalObjectDao, please note that the ExternalObjectDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown ExternalObjectDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in ExternalObjectDao

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(ExternalObject externalObject)

Description copied from interface: ExternalObjectDao

Updates the externalObject instance in the persistent store.

Specified by:

update in interface ExternalObjectDao

See Also:

ExternalObjectDao.update(com.communote.server.model.external.ExternalObject)

update

public void update(Collection<ExternalObject> entities)

Description copied from interface: ExternalObjectDao

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

Specified by:

update in interface ExternalObjectDao

See Also:

com.communote.server.persistence.external.ExternalObjectDao#update(java.util.Collection)