com.communote.server.persistence.user.group

Class UserOfGroupDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.group.UserOfGroupDaoBase

All Implemented Interfaces:

UserOfGroupDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserOfGroupDaoImpl

public abstract class UserOfGroupDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserOfGroupDao

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

Author:

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

See Also:

UserOfGroup

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.user.group.UserOfGroupDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserOfGroupDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserOfGroup>	create(Collection<UserOfGroup> entities) Creates a new instance of com.communote.server.persistence.user.group.UserOfGroup and adds from the passed in entities collection
Collection<UserOfGroup>	create(int transform, Collection<UserOfGroup> entities) Does the same thing as UserOfGroupDao.create(com.communote.server.model.user.group.UserOfGroup) with an additional flag called transform.
Object	create(int transform, UserOfGroup userOfGroup) Does the same thing as UserOfGroupDao.create(com.communote.server.model.user.group.UserOfGroup) with an additional flag called transform.
UserOfGroup	create(UserOfGroup userOfGroup) Creates an instance of com.communote.server.persistence.user.group.UserOfGroup and adds it to the persistent store.
void	evict(UserOfGroup entity) Evicts (removes) the entity from the hibernate cache
UserOfGroup	findByUserIdGroupId(Long userId, Long groupId) Returns a UserOfGroup entity identified by the userId and groupId.
Collection<UserOfGroup>	getUserOfGroupEntities(UserOfGroupModificationType modificationType) Returns the UserOfGroup entities that have the provided UserOfGroupModificationType.
Collection<Long>	getUsersOfGroup(Long groupId) Returns for a given group all users participating in the UserOfGroup association.
protected abstract UserOfGroup	handleFindByUserIdGroupId(Long userId, Long groupId) Performs the core logic for findByUserIdGroupId(Long, Long)
protected abstract Collection<UserOfGroup>	handleGetUserOfGroupEntities(UserOfGroupModificationType modificationType) Performs the core logic for getUserOfGroupEntities(com.communote.server.model.user.group.UserOfGroupModificationType)
protected abstract Collection<Long>	handleGetUsersOfGroup(Long groupId) Performs the core logic for getUsersOfGroup(Long)
protected abstract boolean	handleIsUserOfGroup(Long userId, Long groupId) Performs the core logic for isUserOfGroup(Long, Long)
boolean	isUserOfGroup(Long userId, Long groupId) Tests wether there is an association between the user and the group.
Object	load(int transform, Long id) Does the same thing as UserOfGroupDao.load(Long) with an additional flag called transform.
UserOfGroup	load(Long id) Loads an instance of com.communote.server.persistence.user.group.UserOfGroup from the persistent store.
Collection<UserOfGroup>	loadAll() Loads all entities of type UserOfGroup.
Collection<?>	loadAll(int transform) Does the same thing as UserOfGroupDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserOfGroup> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.group.UserOfGroup having the given identifier from the persistent store.
void	remove(UserOfGroup userOfGroup) Removes the instance of com.communote.server.persistence.user.group.UserOfGroup from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.group.UserOfGroup) method.
protected Object	transformEntity(int transform, UserOfGroup 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.group.UserOfGroupDao, please note that the UserOfGroupDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserOfGroup> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserOfGroup userOfGroup) Updates the userOfGroup 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

UserOfGroupDaoBase

public UserOfGroupDaoBase()

Method Detail

create

public UserOfGroup create(UserOfGroup userOfGroup)

Description copied from interface: UserOfGroupDao

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

Specified by:

create in interface UserOfGroupDao

See Also:

UserOfGroupDao.create(com.communote.server.model.user.group.UserOfGroup)

create

public Object create(int transform,
                     UserOfGroup userOfGroup)

Description copied from interface: UserOfGroupDao

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

See Also:

com.communote.server.persistence.user.group.UserOfGroupDao#create(int transform, com.communote.server.persistence.user.group.UserOfGroup)

create

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

Description copied from interface: UserOfGroupDao

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

See Also:

com.communote.server.persistence.user.group.UserOfGroupDao#create(int, java.util.Collection)

create

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

Description copied from interface: UserOfGroupDao

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

Specified by:

create in interface UserOfGroupDao

Parameters:

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

Returns:

the created instances.

See Also:

com.communote.server.persistence.user.group.UserOfGroupDao#create(java.util.Collection)

evict

public void evict(UserOfGroup entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserOfGroupDao

Parameters:

entity - the entity to evict

findByUserIdGroupId

public UserOfGroup findByUserIdGroupId(Long userId,
                                       Long groupId)

Description copied from interface: UserOfGroupDao

Returns a UserOfGroup entity identified by the userId and groupId.

Specified by:

findByUserIdGroupId in interface UserOfGroupDao

See Also:

UserOfGroupDao.findByUserIdGroupId(Long, Long)

getUserOfGroupEntities

public Collection<UserOfGroup> getUserOfGroupEntities(UserOfGroupModificationType modificationType)

Description copied from interface: UserOfGroupDao

Returns the UserOfGroup entities that have the provided UserOfGroupModificationType. If the modification type is null the entities having null as modification type value are retrieved.

Specified by:

getUserOfGroupEntities in interface UserOfGroupDao

See Also:

UserOfGroupDao.getUserOfGroupEntities(com.communote.server.model.user.group.UserOfGroupModificationType)

getUsersOfGroup

public Collection<Long> getUsersOfGroup(Long groupId)

Description copied from interface: UserOfGroupDao

Returns for a given group all users participating in the UserOfGroup association. The return value will be a collection of user IDs.

Specified by:

getUsersOfGroup in interface UserOfGroupDao

See Also:

UserOfGroupDao.getUsersOfGroup(Long)

handleFindByUserIdGroupId

protected abstract UserOfGroup handleFindByUserIdGroupId(Long userId,
                                                         Long groupId)

Performs the core logic for findByUserIdGroupId(Long, Long)

handleGetUserOfGroupEntities

protected abstract Collection<UserOfGroup> handleGetUserOfGroupEntities(UserOfGroupModificationType modificationType)

Performs the core logic for getUserOfGroupEntities(com.communote.server.model.user.group.UserOfGroupModificationType)

handleGetUsersOfGroup

protected abstract Collection<Long> handleGetUsersOfGroup(Long groupId)

Performs the core logic for getUsersOfGroup(Long)

handleIsUserOfGroup

protected abstract boolean handleIsUserOfGroup(Long userId,
                                               Long groupId)

Performs the core logic for isUserOfGroup(Long, Long)

isUserOfGroup

public boolean isUserOfGroup(Long userId,
                             Long groupId)

Description copied from interface: UserOfGroupDao

Tests wether there is an association between the user and the group.

Specified by:

isUserOfGroup in interface UserOfGroupDao

See Also:

UserOfGroupDao.isUserOfGroup(Long, Long)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserOfGroupDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserOfGroupDao.load(int, Long)

load

public UserOfGroup load(Long id)

Description copied from interface: UserOfGroupDao

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

Specified by:

load in interface UserOfGroupDao

See Also:

UserOfGroupDao.load(Long)

loadAll

public Collection<UserOfGroup> loadAll()

Description copied from interface: UserOfGroupDao

Loads all entities of type UserOfGroup.

Specified by:

loadAll in interface UserOfGroupDao

Returns:

the loaded entities.

See Also:

UserOfGroupDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserOfGroupDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserOfGroupDao.loadAll(int)

remove

public void remove(UserOfGroup userOfGroup)

Description copied from interface: UserOfGroupDao

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

Specified by:

remove in interface UserOfGroupDao

See Also:

UserOfGroupDao.remove(com.communote.server.model.user.group.UserOfGroup)

remove

public void remove(Collection<UserOfGroup> entities)

Description copied from interface: UserOfGroupDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserOfGroupDao

See Also:

com.communote.server.persistence.user.group.UserOfGroupDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: UserOfGroupDao

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

Specified by:

remove in interface UserOfGroupDao

See Also:

UserOfGroupDao.remove(Long)

transformEntities

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

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

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.user.group.UserOfGroup)

transformEntity

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

Parameters:

transform - one of the constants declared in UserOfGroupDao

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(UserOfGroup userOfGroup)

Description copied from interface: UserOfGroupDao

Updates the userOfGroup instance in the persistent store.

Specified by:

update in interface UserOfGroupDao

See Also:

UserOfGroupDao.update(com.communote.server.model.user.group.UserOfGroup)

update

public void update(Collection<UserOfGroup> entities)

Description copied from interface: UserOfGroupDao

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

Specified by:

update in interface UserOfGroupDao

See Also:

com.communote.server.persistence.user.group.UserOfGroupDao#update(java.util.Collection)