com.communote.server.persistence.global

Class GlobalIdDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.global.GlobalIdDaoBase

All Implemented Interfaces:

GlobalIdDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

GlobalIdDaoImpl

public abstract class GlobalIdDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements GlobalIdDao

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

Author:

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

See Also:

GlobalId

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.global.GlobalIdDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
GlobalIdDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<GlobalId>	create(Collection<GlobalId> entities) Creates a new instance of com.communote.server.persistence.global.GlobalId and adds from the passed in entities collection
GlobalId	create(GlobalId globalId) Creates an instance of com.communote.server.persistence.global.GlobalId and adds it to the persistent store.
Collection<GlobalId>	create(int transform, Collection<GlobalId> entities) Does the same thing as GlobalIdDao.create(com.communote.server.model.global.GlobalId) with an additional flag called transform.
Object	create(int transform, GlobalId globalId) Does the same thing as GlobalIdDao.create(com.communote.server.model.global.GlobalId) with an additional flag called transform.
GlobalId	createGlobalId(Attachment attachment)
GlobalId	createGlobalId(Blog blog)
GlobalId	createGlobalId(Group group)
GlobalId	createGlobalId(Note note)
GlobalId	createGlobalId(Tag tag)
GlobalId	createGlobalId(User user)
void	evict(GlobalId entity) Evicts (removes) the entity from the hibernate cache
GlobalId	findByGlobalIdentifier(String globalIdentifier) Returns a global ID matching the global identifier or null if there is no matching global ID.
GlobalId	findLatestGlobalId() Returns the latest GlobalID, which is the GlobalID with highest ID member.
protected abstract GlobalId	handleCreateGlobalId(Attachment attachment) Performs the core logic for createGlobalId(com.communote.server.model.attachment.Attachment)
protected abstract GlobalId	handleCreateGlobalId(Blog blog) Performs the core logic for createGlobalId(com.communote.server.model.blog.Blog)
protected abstract GlobalId	handleCreateGlobalId(Group group) Performs the core logic for createGlobalId(com.communote.server.model.user.group.Group)
protected abstract GlobalId	handleCreateGlobalId(Note note) Performs the core logic for createGlobalId(com.communote.server.model.note.Note)
protected abstract GlobalId	handleCreateGlobalId(Tag tag) Performs the core logic for createGlobalId(com.communote.server.model.tag.Tag)
protected abstract GlobalId	handleCreateGlobalId(User user) Performs the core logic for createGlobalId(com.communote.server.model.user.User)
protected abstract GlobalId	handleFindByGlobalIdentifier(String globalIdentifier) Performs the core logic for findByGlobalIdentifier(String)
protected abstract GlobalId	handleFindLatestGlobalId() Performs the core logic for findLatestGlobalId()
Object	load(int transform, Long id) Does the same thing as GlobalIdDao.load(Long) with an additional flag called transform.
GlobalId	load(Long id) Loads an instance of com.communote.server.persistence.global.GlobalId from the persistent store.
Collection<GlobalId>	loadAll() Loads all entities of type GlobalId.
Collection<?>	loadAll(int transform) Does the same thing as GlobalIdDao.loadAll() with an additional flag called transform.
void	remove(Collection<GlobalId> entities) Removes all entities in the given entities collection.
void	remove(GlobalId globalId) Removes the instance of com.communote.server.persistence.global.GlobalId from the persistent store.
void	remove(Long id) Removes the instance of com.communote.server.persistence.global.GlobalId 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.global.GlobalId) method.
protected Object	transformEntity(int transform, GlobalId 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.global.GlobalIdDao, please note that the GlobalIdDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<GlobalId> entities) Updates all instances in the entities collection in the persistent store.
void	update(GlobalId globalId) Updates the globalId 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

GlobalIdDaoBase

public GlobalIdDaoBase()

Method Detail

create

public GlobalId create(GlobalId globalId)

Description copied from interface: GlobalIdDao

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

Specified by:

create in interface GlobalIdDao

See Also:

GlobalIdDao.create(com.communote.server.model.global.GlobalId)

create

public Object create(int transform,
                     GlobalId globalId)

Description copied from interface: GlobalIdDao

Does the same thing as GlobalIdDao.create(com.communote.server.model.global.GlobalId) 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 GlobalIdDao

See Also:

com.communote.server.persistence.global.GlobalIdDao#create(int transform, com.communote.server.persistence.global.GlobalId)

create

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

Description copied from interface: GlobalIdDao

Does the same thing as GlobalIdDao.create(com.communote.server.model.global.GlobalId) 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 GlobalIdDao

See Also:

com.communote.server.persistence.global.GlobalIdDao#create(int, java.util.Collection)

create

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

Description copied from interface: GlobalIdDao

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

Specified by:

create in interface GlobalIdDao

Parameters:

entities - the collection of com.communote.server.persistence.global.GlobalId instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.global.GlobalIdDao#create(java.util.Collection)

createGlobalId

public GlobalId createGlobalId(Attachment attachment)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.attachment.Attachment)

createGlobalId

public GlobalId createGlobalId(Blog blog)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.blog.Blog)

createGlobalId

public GlobalId createGlobalId(Note note)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.note.Note)

createGlobalId

public GlobalId createGlobalId(Tag tag)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.tag.Tag)

createGlobalId

public GlobalId createGlobalId(Group group)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.user.group.Group)

createGlobalId

public GlobalId createGlobalId(User user)

Specified by:

createGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.createGlobalId(com.communote.server.model.user.User)

evict

public void evict(GlobalId entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface GlobalIdDao

Parameters:

entity - the entity to evict

findByGlobalIdentifier

public GlobalId findByGlobalIdentifier(String globalIdentifier)

Description copied from interface: GlobalIdDao

Returns a global ID matching the global identifier or null if there is no matching global ID.

Specified by:

findByGlobalIdentifier in interface GlobalIdDao

See Also:

GlobalIdDao.findByGlobalIdentifier(String)

findLatestGlobalId

public GlobalId findLatestGlobalId()

Description copied from interface: GlobalIdDao

Returns the latest GlobalID, which is the GlobalID with highest ID member. The return value might be null if there is no global ID yet.

Specified by:

findLatestGlobalId in interface GlobalIdDao

See Also:

GlobalIdDao.findLatestGlobalId()

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(Attachment attachment)

Performs the core logic for createGlobalId(com.communote.server.model.attachment.Attachment)

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(Blog blog)

Performs the core logic for createGlobalId(com.communote.server.model.blog.Blog)

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(Note note)

Performs the core logic for createGlobalId(com.communote.server.model.note.Note)

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(Tag tag)

Performs the core logic for createGlobalId(com.communote.server.model.tag.Tag)

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(Group group)

Performs the core logic for createGlobalId(com.communote.server.model.user.group.Group)

handleCreateGlobalId

protected abstract GlobalId handleCreateGlobalId(User user)

Performs the core logic for createGlobalId(com.communote.server.model.user.User)

handleFindByGlobalIdentifier

protected abstract GlobalId handleFindByGlobalIdentifier(String globalIdentifier)

Performs the core logic for findByGlobalIdentifier(String)

handleFindLatestGlobalId

protected abstract GlobalId handleFindLatestGlobalId()

Performs the core logic for findLatestGlobalId()

load

public Object load(int transform,
                   Long id)

Description copied from interface: GlobalIdDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

GlobalIdDao.load(int, Long)

load

public GlobalId load(Long id)

Description copied from interface: GlobalIdDao

Loads an instance of com.communote.server.persistence.global.GlobalId from the persistent store.

Specified by:

load in interface GlobalIdDao

See Also:

GlobalIdDao.load(Long)

loadAll

public Collection<GlobalId> loadAll()

Description copied from interface: GlobalIdDao

Loads all entities of type GlobalId.

Specified by:

loadAll in interface GlobalIdDao

Returns:

the loaded entities.

See Also:

GlobalIdDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: GlobalIdDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

GlobalIdDao.loadAll(int)

remove

public void remove(GlobalId globalId)

Description copied from interface: GlobalIdDao

Removes the instance of com.communote.server.persistence.global.GlobalId from the persistent store.

Specified by:

remove in interface GlobalIdDao

See Also:

GlobalIdDao.remove(com.communote.server.model.global.GlobalId)

remove

public void remove(Collection<GlobalId> entities)

Description copied from interface: GlobalIdDao

Removes all entities in the given entities collection.

Specified by:

remove in interface GlobalIdDao

See Also:

com.communote.server.persistence.global.GlobalIdDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: GlobalIdDao

Removes the instance of com.communote.server.persistence.global.GlobalId having the given identifier from the persistent store.

Specified by:

remove in interface GlobalIdDao

See Also:

GlobalIdDao.remove(Long)

transformEntities

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

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

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.global.GlobalId)

transformEntity

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

Parameters:

transform - one of the constants declared in GlobalIdDao

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(GlobalId globalId)

Description copied from interface: GlobalIdDao

Updates the globalId instance in the persistent store.

Specified by:

update in interface GlobalIdDao

See Also:

GlobalIdDao.update(com.communote.server.model.global.GlobalId)

update

public void update(Collection<GlobalId> entities)

Description copied from interface: GlobalIdDao

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

Specified by:

update in interface GlobalIdDao

See Also:

com.communote.server.persistence.global.GlobalIdDao#update(java.util.Collection)