com.communote.server.persistence.user.note

Class UserNoteEntityDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.note.UserNoteEntityDaoBase

All Implemented Interfaces:

UserNoteEntityDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserNoteEntityDaoImpl

public abstract class UserNoteEntityDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserNoteEntityDao

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

Author:

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

See Also:

UserNoteEntity

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.user.note.UserNoteEntityDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserNoteEntityDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserNoteEntity>	create(Collection<UserNoteEntity> entities) Creates a new instance of com.communote.server.persistence.user.note.UserNoteEntity and adds from the passed in entities collection
Collection<UserNoteEntity>	create(int transform, Collection<UserNoteEntity> entities) Does the same thing as UserNoteEntityDao.create(com.communote.server.model.user.note.UserNoteEntity) with an additional flag called transform.
Object	create(int transform, UserNoteEntity userNoteEntity) Does the same thing as UserNoteEntityDao.create(com.communote.server.model.user.note.UserNoteEntity) with an additional flag called transform.
UserNoteEntity	create(UserNoteEntity userNoteEntity) Creates an instance of com.communote.server.persistence.user.note.UserNoteEntity and adds it to the persistent store.
void	evict(UserNoteEntity entity) Evicts (removes) the entity from the hibernate cache
UserNoteEntity	findByUserIdNoteId(Long userId, Long noteId) Find the user note entity by the given user and note id
protected abstract UserNoteEntity	handleFindByUserIdNoteId(Long userId, Long noteId) Performs the core logic for findByUserIdNoteId(Long, Long)
protected abstract int	handleRemoveUserNoteEntitiesForNote(Long noteId) Performs the core logic for removeUserNoteEntitiesForNote(Long)
protected abstract int	handleRemoveUserNoteEntitiesForUser(Long userid) Performs the core logic for removeUserNoteEntitiesForUser(Long)
Object	load(int transform, Long id) Does the same thing as UserNoteEntityDao.load(Long) with an additional flag called transform.
UserNoteEntity	load(Long id) Loads an instance of com.communote.server.persistence.user.note.UserNoteEntity from the persistent store.
Collection<UserNoteEntity>	loadAll() Loads all entities of type UserNoteEntity.
Collection<?>	loadAll(int transform) Does the same thing as UserNoteEntityDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserNoteEntity> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.note.UserNoteEntity having the given identifier from the persistent store.
void	remove(UserNoteEntity userNoteEntity) Removes the instance of com.communote.server.persistence.user.note.UserNoteEntity from the persistent store.
int	removeUserNoteEntitiesForNote(Long noteId) Remove all UserNoteEntity's for the given note id
int	removeUserNoteEntitiesForUser(Long userid) Remove all UserNoteEntity's for the given user id
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.note.UserNoteEntity) method.
protected Object	transformEntity(int transform, UserNoteEntity 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.user.note.UserNoteEntityDao, please note that the UserNoteEntityDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserNoteEntity> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserNoteEntity userNoteEntity) Updates the userNoteEntity 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

UserNoteEntityDaoBase

public UserNoteEntityDaoBase()

Method Detail

create

public UserNoteEntity create(UserNoteEntity userNoteEntity)

Description copied from interface: UserNoteEntityDao

Creates an instance of com.communote.server.persistence.user.note.UserNoteEntity and adds it to the persistent store.

Specified by:

create in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.create(com.communote.server.model.user.note.UserNoteEntity)

create

public Object create(int transform,
                     UserNoteEntity userNoteEntity)

Description copied from interface: UserNoteEntityDao

Does the same thing as UserNoteEntityDao.create(com.communote.server.model.user.note.UserNoteEntity) 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 UserNoteEntityDao

See Also:

com.communote.server.persistence.user.note.UserNoteEntityDao#create(int transform, com.communote.server.persistence.user.note.UserNoteEntity)

create

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

Description copied from interface: UserNoteEntityDao

Does the same thing as UserNoteEntityDao.create(com.communote.server.model.user.note.UserNoteEntity) 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 UserNoteEntityDao

See Also:

com.communote.server.persistence.user.note.UserNoteEntityDao#create(int, java.util.Collection)

create

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

Description copied from interface: UserNoteEntityDao

Creates a new instance of com.communote.server.persistence.user.note.UserNoteEntity and adds from the passed in entities collection

Specified by:

create in interface UserNoteEntityDao

Parameters:

entities - the collection of com.communote.server.persistence.user.note.UserNoteEntity instances to create.

Returns:

the created instances.

See Also:

UserNoteEntityDao.create(java.util.Collection< com.communote.server.persistence.user.note.UserNoteEntity>)

evict

public void evict(UserNoteEntity entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserNoteEntityDao

Parameters:

entity - the entity to evict

findByUserIdNoteId

public UserNoteEntity findByUserIdNoteId(Long userId,
                                         Long noteId)

Description copied from interface: UserNoteEntityDao

Find the user note entity by the given user and note id

Specified by:

findByUserIdNoteId in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.findByUserIdNoteId(Long, Long)

handleFindByUserIdNoteId

protected abstract UserNoteEntity handleFindByUserIdNoteId(Long userId,
                                                           Long noteId)

Performs the core logic for findByUserIdNoteId(Long, Long)

handleRemoveUserNoteEntitiesForNote

protected abstract int handleRemoveUserNoteEntitiesForNote(Long noteId)

Performs the core logic for removeUserNoteEntitiesForNote(Long)

handleRemoveUserNoteEntitiesForUser

protected abstract int handleRemoveUserNoteEntitiesForUser(Long userid)

Performs the core logic for removeUserNoteEntitiesForUser(Long)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserNoteEntityDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserNoteEntityDao.load(int, Long)

load

public UserNoteEntity load(Long id)

Description copied from interface: UserNoteEntityDao

Loads an instance of com.communote.server.persistence.user.note.UserNoteEntity from the persistent store.

Specified by:

load in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.load(Long)

loadAll

public Collection<UserNoteEntity> loadAll()

Description copied from interface: UserNoteEntityDao

Loads all entities of type UserNoteEntity.

Specified by:

loadAll in interface UserNoteEntityDao

Returns:

the loaded entities.

See Also:

UserNoteEntityDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserNoteEntityDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserNoteEntityDao.loadAll(int)

remove

public void remove(UserNoteEntity userNoteEntity)

Description copied from interface: UserNoteEntityDao

Removes the instance of com.communote.server.persistence.user.note.UserNoteEntity from the persistent store.

Specified by:

remove in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.remove(com.communote.server.model.user.note.UserNoteEntity)

remove

public void remove(Collection<UserNoteEntity> entities)

Description copied from interface: UserNoteEntityDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.remove(java.util.Collection< com.communote.server.persistence.user.note.UserNoteEntity>)

remove

public void remove(Long id)

Description copied from interface: UserNoteEntityDao

Removes the instance of com.communote.server.persistence.user.note.UserNoteEntity having the given identifier from the persistent store.

Specified by:

remove in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.remove(Long)

removeUserNoteEntitiesForNote

public int removeUserNoteEntitiesForNote(Long noteId)

Description copied from interface: UserNoteEntityDao

Remove all UserNoteEntity's for the given note id

Specified by:

removeUserNoteEntitiesForNote in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.removeUserNoteEntitiesForNote(Long)

removeUserNoteEntitiesForUser

public int removeUserNoteEntitiesForUser(Long userid)

Description copied from interface: UserNoteEntityDao

Remove all UserNoteEntity's for the given user id

Specified by:

removeUserNoteEntitiesForUser in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.removeUserNoteEntitiesForUser(Long)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.note.UserNoteEntity) 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.user.note.UserNoteEntityDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.user.note.UserNoteEntity)

transformEntity

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

Parameters:

transform - one of the constants declared in UserNoteEntityDao

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(UserNoteEntity userNoteEntity)

Description copied from interface: UserNoteEntityDao

Updates the userNoteEntity instance in the persistent store.

Specified by:

update in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.update(com.communote.server.model.user.note.UserNoteEntity)

update

public void update(Collection<UserNoteEntity> entities)

Description copied from interface: UserNoteEntityDao

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

Specified by:

update in interface UserNoteEntityDao

See Also:

UserNoteEntityDao.update(java.util.Collection< com.communote.server.persistence.user.note.UserNoteEntity>)