com.communote.server.persistence.user

Class UserNotePropertyDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.UserNotePropertyDaoBase

All Implemented Interfaces:

UserNotePropertyDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserNotePropertyDaoImpl

public abstract class UserNotePropertyDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserNotePropertyDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type UserNoteProperty.

Author:

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

See Also:

UserNoteProperty

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.user.UserNotePropertyDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserNotePropertyDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserNoteProperty>	create(Collection<UserNoteProperty> entities) Creates a new instance of com.communote.server.persistence.user.UserNoteProperty and adds from the passed in entities collection
Collection<UserNoteProperty>	create(int transform, Collection<UserNoteProperty> entities) Does the same thing as UserNotePropertyDao.create(com.communote.server.model.user.UserNoteProperty) with an additional flag called transform.
Object	create(int transform, UserNoteProperty userNoteProperty) Does the same thing as UserNotePropertyDao.create(com.communote.server.model.user.UserNoteProperty) with an additional flag called transform.
UserNoteProperty	create(UserNoteProperty userNoteProperty) Creates an instance of com.communote.server.persistence.user.UserNoteProperty and adds it to the persistent store.
void	evict(UserNoteProperty entity) Evicts (removes) the entity from the hibernate cache
Collection<UserNoteProperty>	findProperties(Long noteId, String keyGroup, String key) Return a collection of matching user note properties.
UserNoteProperty	findProperty(Long noteId, String keyGroup, String key) Return the property with the given key group and key for the given note ID or null if the current user does not have such a property for that note.
protected abstract Collection<UserNoteProperty>	handleFindProperties(Long noteId, String keyGroup, String key) Performs the core logic for findProperties(Long, String, String)
protected abstract UserNoteProperty	handleFindProperty(Long noteId, String keyGroup, String key) Performs the core logic for findProperty(Long, String, String)
protected abstract int	handleRemovePropertiesForNote(Long noteId) Performs the core logic for removePropertiesForNote(Long)
protected abstract int	handleRemovePropertiesForUser(Long userId) Performs the core logic for removePropertiesForUser(Long)
Object	load(int transform, Long id) Does the same thing as UserNotePropertyDao.load(Long) with an additional flag called transform.
UserNoteProperty	load(Long id) Loads an instance of com.communote.server.persistence.user.UserNoteProperty from the persistent store.
Collection<UserNoteProperty>	loadAll() Loads all entities of type UserNoteProperty.
Collection<?>	loadAll(int transform) Does the same thing as UserNotePropertyDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserNoteProperty> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.UserNoteProperty having the given identifier from the persistent store.
void	remove(UserNoteProperty userNoteProperty) Removes the instance of com.communote.server.persistence.user.UserNoteProperty from the persistent store.
int	removePropertiesForNote(Long noteId) Remove all properties for the given note.
int	removePropertiesForUser(Long userId) Remove all properties for the given user.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,UserNoteProperty) method.
protected Object	transformEntity(int transform, UserNoteProperty 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 UserNotePropertyDao, please note that the UserNotePropertyDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserNoteProperty> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserNoteProperty userNoteProperty) Updates the userNoteProperty 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

UserNotePropertyDaoBase

public UserNotePropertyDaoBase()

Method Detail

create

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

Description copied from interface: UserNotePropertyDao

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

See Also:

UserNotePropertyDao#create(int, java.util.Collection)

create

public Object create(int transform,
                     UserNoteProperty userNoteProperty)

Description copied from interface: UserNotePropertyDao

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

See Also:

UserNotePropertyDao.create(int transform, UserNoteProperty)

create

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

Description copied from interface: UserNotePropertyDao

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

Specified by:

create in interface UserNotePropertyDao

Parameters:

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

Returns:

the created instances.

See Also:

UserNotePropertyDao#create(java.util.Collection)

create

public UserNoteProperty create(UserNoteProperty userNoteProperty)

Description copied from interface: UserNotePropertyDao

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

Specified by:

create in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.create(UserNoteProperty)

evict

public void evict(UserNoteProperty entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserNotePropertyDao

Parameters:

entity - the entity to evict

findProperties

public Collection<UserNoteProperty> findProperties(Long noteId,
                                                   String keyGroup,
                                                   String key)

Description copied from interface: UserNotePropertyDao

Return a collection of matching user note properties. This will consider all users and include their property for a given note if it has the provided group and key.

Specified by:

findProperties in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.findProperties(Long, String, String)

findProperty

public UserNoteProperty findProperty(Long noteId,
                                     String keyGroup,
                                     String key)

Description copied from interface: UserNotePropertyDao

Return the property with the given key group and key for the given note ID or null if the current user does not have such a property for that note.

Specified by:

findProperty in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.findProperty(Long, String, String)

handleFindProperties

protected abstract Collection<UserNoteProperty> handleFindProperties(Long noteId,
                                                                     String keyGroup,
                                                                     String key)

Performs the core logic for findProperties(Long, String, String)

handleFindProperty

protected abstract UserNoteProperty handleFindProperty(Long noteId,
                                                       String keyGroup,
                                                       String key)

Performs the core logic for findProperty(Long, String, String)

handleRemovePropertiesForNote

protected abstract int handleRemovePropertiesForNote(Long noteId)

Performs the core logic for removePropertiesForNote(Long)

handleRemovePropertiesForUser

protected abstract int handleRemovePropertiesForUser(Long userId)

Performs the core logic for removePropertiesForUser(Long)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserNotePropertyDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserNotePropertyDao.load(int, Long)

load

public UserNoteProperty load(Long id)

Description copied from interface: UserNotePropertyDao

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

Specified by:

load in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.load(Long)

loadAll

public Collection<UserNoteProperty> loadAll()

Description copied from interface: UserNotePropertyDao

Loads all entities of type UserNoteProperty.

Specified by:

loadAll in interface UserNotePropertyDao

Returns:

the loaded entities.

See Also:

UserNotePropertyDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserNotePropertyDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserNotePropertyDao.loadAll(int)

remove

public void remove(Collection<UserNoteProperty> entities)

Description copied from interface: UserNotePropertyDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserNotePropertyDao

See Also:

UserNotePropertyDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: UserNotePropertyDao

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

Specified by:

remove in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.remove(Long)

remove

public void remove(UserNoteProperty userNoteProperty)

Description copied from interface: UserNotePropertyDao

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

Specified by:

remove in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.remove(UserNoteProperty)

removePropertiesForNote

public int removePropertiesForNote(Long noteId)

Description copied from interface: UserNotePropertyDao

Remove all properties for the given note. This method should only be called by the UserNotePropertyAccessor.

Specified by:

removePropertiesForNote in interface UserNotePropertyDao

Parameters:

noteId - the ID of the note

Returns:

the number of removed properties.

See Also:

UserNotePropertyDao.removePropertiesForNote(Long)

removePropertiesForUser

public int removePropertiesForUser(Long userId)

Description copied from interface: UserNotePropertyDao

Remove all properties for the given user.

Specified by:

removePropertiesForUser in interface UserNotePropertyDao

Parameters:

userId - the ID of the user

Returns:

the number of removed properties.

See Also:

UserNotePropertyDao.removePropertiesForUser(Long)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,UserNoteProperty) 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 UserNotePropertyDao

entities - the collection of entities to transform

See Also:

transformEntity(int,UserNoteProperty)

transformEntity

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

Parameters:

transform - one of the constants declared in UserNotePropertyDao

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<UserNoteProperty> entities)

Description copied from interface: UserNotePropertyDao

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

Specified by:

update in interface UserNotePropertyDao

See Also:

UserNotePropertyDao#update(java.util.Collection)

update

public void update(UserNoteProperty userNoteProperty)

Description copied from interface: UserNotePropertyDao

Updates the userNoteProperty instance in the persistent store.

Specified by:

update in interface UserNotePropertyDao

See Also:

UserNotePropertyDao.update(UserNoteProperty)