com.communote.server.persistence.resource

Class AttachmentDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.resource.AttachmentDaoBase

All Implemented Interfaces:

AttachmentDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AttachmentDaoImpl

public abstract class AttachmentDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements AttachmentDao

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

Author:

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

See Also:

Attachment

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.resource.AttachmentDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
AttachmentDaoBase()

Method Summary

Modifier and Type	Method and Description
Attachment	create(Attachment attachment) Creates an instance of Attachment and adds it to the persistent store.
Collection<Attachment>	create(Collection<Attachment> entities) Creates a new instance of Attachment and adds from the passed in entities collection
Object	create(int transform, Attachment attachment) Does the same thing as AttachmentDao.create(Attachment) with an additional flag called transform.
Collection<Attachment>	create(int transform, Collection<Attachment> entities) Does the same thing as AttachmentDao.create(Attachment) with an additional flag called transform.
void	evict(Attachment entity) Evicts (removes) the entity from the hibernate cache
Object	find(int transform, String contentIdentifier, String repositoryIdentifier) Does the same thing as AttachmentDao.find(String, String) with an additional flag called transform.
Attachment	find(String contentIdentifier, String repositoryIdentifier) Find a resource by the given identifiers
Attachment	findContentTypeNull() Find an attachments with an empty content type to be migrated
Note	findNoteByContentId(ContentId contentId) Finds the note by a given content id of an attachment.
protected GlobalIdDao	getGlobalIdDao() Gets the reference to globalIdDao.
protected abstract Attachment	handleFindContentTypeNull() Performs the core logic for findContentTypeNull()
protected abstract Note	handleFindNoteByContentId(ContentId contentId) Performs the core logic for findNoteByContentId(com.communote.server.core.crc.vo.ContentId)
Object	load(int transform, Long id) Does the same thing as AttachmentDao.load(Long) with an additional flag called transform.
Attachment	load(Long id) Loads an instance of Attachment from the persistent store.
Collection<Attachment>	loadAll() Loads all entities of type Attachment.
Collection<?>	loadAll(int transform) Does the same thing as AttachmentDao.loadAll() with an additional flag called transform.
void	remove(Attachment attachment) Removes the instance of Attachment from the persistent store.
void	remove(Collection<Attachment> attachments) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of Attachment having the given identifier from the persistent store.
void	setGlobalIdDao(GlobalIdDao globalIdDao) Sets the reference to globalIdDao.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.attachment.Attachment) method.
protected Object	transformEntity(int transform, Attachment 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.resource.AttachmentDao, please note that the AttachmentDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Attachment attachment) Updates the attachment instance in the persistent store.
void	update(Collection<Attachment> entities) Updates all instances in the entities collection 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

Methods inherited from interface com.communote.server.persistence.resource.AttachmentDao

findOrphanedAttachments

Constructor Detail

AttachmentDaoBase

public AttachmentDaoBase()

Method Detail

create

public Attachment create(Attachment attachment)

Description copied from interface: AttachmentDao

Creates an instance of Attachment and adds it to the persistent store.

Specified by:

create in interface AttachmentDao

See Also:

AttachmentDao.create(com.communote.server.model.attachment.Attachment)

create

public Object create(int transform,
                     Attachment attachment)

Description copied from interface: AttachmentDao

Does the same thing as AttachmentDao.create(Attachment) 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 AttachmentDao

See Also:

com.communote.server.persistence.resource.AttachmentDao#create(int transform, com.communote.server.persistence.resource.Attachment)

create

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

Description copied from interface: AttachmentDao

Does the same thing as AttachmentDao.create(Attachment) 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 AttachmentDao

See Also:

com.communote.server.persistence.resource.AttachmentDao#create(int, java.util.Collection)

create

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

Description copied from interface: AttachmentDao

Creates a new instance of Attachment and adds from the passed in entities collection

Specified by:

create in interface AttachmentDao

Parameters:

entities - the collection of Attachment instances to create.

Returns:

the created instances.

See Also:

AttachmentDao.create(java.util.Collection< Attachment>)

evict

public void evict(Attachment entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface AttachmentDao

Parameters:

entity - the entity to evict

find

public Object find(int transform,
                   String contentIdentifier,
                   String repositoryIdentifier)

Description copied from interface: AttachmentDao

Does the same thing as AttachmentDao.find(String, String) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results 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:

find in interface AttachmentDao

See Also:

AttachmentDao.find(int, String, String)

find

public Attachment find(String contentIdentifier,
                       String repositoryIdentifier)

Description copied from interface: AttachmentDao

Find a resource by the given identifiers

Specified by:

find in interface AttachmentDao

See Also:

AttachmentDao.find(String, String)

findContentTypeNull

public Attachment findContentTypeNull()

Description copied from interface: AttachmentDao

Find an attachments with an empty content type to be migrated

Specified by:

findContentTypeNull in interface AttachmentDao

See Also:

AttachmentDao.findContentTypeNull()

findNoteByContentId

public Note findNoteByContentId(ContentId contentId)

Description copied from interface: AttachmentDao

Finds the note by a given content id of an attachment.

Specified by:

findNoteByContentId in interface AttachmentDao

See Also:

AttachmentDao.findNoteByContentId(com.communote.server.core.crc.vo.ContentId)

getGlobalIdDao

protected GlobalIdDao getGlobalIdDao()

Gets the reference to globalIdDao.

handleFindContentTypeNull

protected abstract Attachment handleFindContentTypeNull()

Performs the core logic for findContentTypeNull()

handleFindNoteByContentId

protected abstract Note handleFindNoteByContentId(ContentId contentId)

Performs the core logic for findNoteByContentId(com.communote.server.core.crc.vo.ContentId)

load

public Object load(int transform,
                   Long id)

Description copied from interface: AttachmentDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

AttachmentDao.load(int, Long)

load

public Attachment load(Long id)

Description copied from interface: AttachmentDao

Loads an instance of Attachment from the persistent store.

Specified by:

load in interface AttachmentDao

See Also:

AttachmentDao.load(Long)

loadAll

public Collection<Attachment> loadAll()

Description copied from interface: AttachmentDao

Loads all entities of type Attachment.

Specified by:

loadAll in interface AttachmentDao

Returns:

the loaded entities.

See Also:

AttachmentDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: AttachmentDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

AttachmentDao.loadAll(int)

remove

public void remove(Collection<Attachment> attachments)

Description copied from interface: AttachmentDao

Removes all entities in the given entities collection.

Specified by:

remove in interface AttachmentDao

See Also:

AttachmentDao.remove(java.util.Collection< Attachment>)

remove

public void remove(Attachment attachment)

Description copied from interface: AttachmentDao

Removes the instance of Attachment from the persistent store.

Specified by:

remove in interface AttachmentDao

See Also:

AttachmentDao.remove(com.communote.server.model.attachment.Attachment)

remove

public void remove(Long id)

Description copied from interface: AttachmentDao

Removes the instance of Attachment having the given identifier from the persistent store.

Specified by:

remove in interface AttachmentDao

See Also:

AttachmentDao.remove(Long)

setGlobalIdDao

public void setGlobalIdDao(GlobalIdDao globalIdDao)

Sets the reference to globalIdDao.

transformEntities

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

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.attachment.Attachment) 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.resource.AttachmentDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.attachment.Attachment)

transformEntity

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

Parameters:

transform - one of the constants declared in AttachmentDao

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(Attachment attachment)

Description copied from interface: AttachmentDao

Updates the attachment instance in the persistent store.

Specified by:

update in interface AttachmentDao

See Also:

AttachmentDao.update(com.communote.server.model.attachment.Attachment)

update

public void update(Collection<Attachment> entities)

Description copied from interface: AttachmentDao

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

Specified by:

update in interface AttachmentDao

See Also:

AttachmentDao.update(java.util.Collection< Attachment>)