com.communote.server.persistence.blog

Class UserToBlogRoleMappingDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.blog.UserToBlogRoleMappingDaoBase

All Implemented Interfaces:

UserToBlogRoleMappingDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserToBlogRoleMappingDaoImpl

public abstract class UserToBlogRoleMappingDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserToBlogRoleMappingDao

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

Author:

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

See Also:

UserToBlogRoleMapping

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.blog.UserToBlogRoleMappingDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserToBlogRoleMappingDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserToBlogRoleMapping>	create(Collection<UserToBlogRoleMapping> entities) Creates a new instance of com.communote.server.persistence.blog.UserToBlogRoleMapping and adds from the passed in entities collection
Collection<UserToBlogRoleMapping>	create(int transform, Collection<UserToBlogRoleMapping> entities) Does the same thing as UserToBlogRoleMappingDao.create(com.communote.server.model.blog.UserToBlogRoleMapping) with an additional flag called transform.
Object	create(int transform, UserToBlogRoleMapping userToBlogRoleMapping) Does the same thing as UserToBlogRoleMappingDao.create(com.communote.server.model.blog.UserToBlogRoleMapping) with an additional flag called transform.
UserToBlogRoleMapping	create(UserToBlogRoleMapping userToBlogRoleMapping) Creates an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping and adds it to the persistent store.
void	evict(UserToBlogRoleMapping entity) Evicts (removes) the entity from the hibernate cache
Collection<UserToBlogRoleMapping>	findMappingsForExternal(Long blogId, Long userId, Long groupId, boolean grantedByGroup, BlogRole role, String externalSystemId) Retrieves mappings matching the parameters.
BlogRole	getRoleOfUser(Long blogId, Long userId) Returns the role of the user for the blog or null if the user has no role for the blog.
protected abstract Collection<UserToBlogRoleMapping>	handleFindMappingsForExternal(Long blogId, Long userId, Long groupId, boolean grantedByGroup, BlogRole role, String externalSystemId) Performs the core logic for findMappingsForExternal(Long, Long, Long, boolean, com.communote.server.model.blog.BlogRole, String)
protected abstract BlogRole	handleGetRoleOfUser(Long blogId, Long userId) Performs the core logic for getRoleOfUser(Long, Long)
protected abstract void	handleRemoveAllForBlog(Long blogId) Performs the core logic for removeAllForBlog(Long)
protected abstract void	handleRemoveAllForGroup(Long groupId) Performs the core logic for removeAllForGroup(Long)
protected abstract void	handleRemoveAllForGroupMember(Long userId, Long groupId) Performs the core logic for removeAllForGroupMember(Long, Long)
Object	load(int transform, Long id) Does the same thing as UserToBlogRoleMappingDao.load(Long) with an additional flag called transform.
UserToBlogRoleMapping	load(Long id) Loads an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.
Collection<UserToBlogRoleMapping>	loadAll() Loads all entities of type UserToBlogRoleMapping.
Collection<?>	loadAll(int transform) Does the same thing as UserToBlogRoleMappingDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserToBlogRoleMapping> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping having the given identifier from the persistent store.
void	remove(UserToBlogRoleMapping userToBlogRoleMapping) Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.
void	removeAllForBlog(Long blogId) Removes all entries for one blog.
void	removeAllForGroup(Long groupId)
void	removeAllForGroupMember(Long userId, Long groupId) Removes all entries for group member.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.blog.UserToBlogRoleMapping) method.
protected Object	transformEntity(int transform, UserToBlogRoleMapping 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.blog.UserToBlogRoleMappingDao, please note that the UserToBlogRoleMappingDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserToBlogRoleMapping> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserToBlogRoleMapping userToBlogRoleMapping) Updates the userToBlogRoleMapping 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

Methods inherited from interface com.communote.server.persistence.blog.UserToBlogRoleMappingDao

findMappings

Constructor Detail

UserToBlogRoleMappingDaoBase

public UserToBlogRoleMappingDaoBase()

Method Detail

create

public UserToBlogRoleMapping create(UserToBlogRoleMapping userToBlogRoleMapping)

Description copied from interface: UserToBlogRoleMappingDao

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

Specified by:

create in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.create(com.communote.server.model.blog.UserToBlogRoleMapping)

create

public Object create(int transform,
                     UserToBlogRoleMapping userToBlogRoleMapping)

Description copied from interface: UserToBlogRoleMappingDao

Does the same thing as UserToBlogRoleMappingDao.create(com.communote.server.model.blog.UserToBlogRoleMapping) 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 UserToBlogRoleMappingDao

See Also:

com.communote.server.persistence.blog.UserToBlogRoleMappingDao#create(int transform, com.communote.server.persistence.blog.UserToBlogRoleMapping)

create

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

Description copied from interface: UserToBlogRoleMappingDao

Does the same thing as UserToBlogRoleMappingDao.create(com.communote.server.model.blog.UserToBlogRoleMapping) 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 UserToBlogRoleMappingDao

See Also:

com.communote.server.persistence.blog.UserToBlogRoleMappingDao#create(int, java.util.Collection)

create

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

Description copied from interface: UserToBlogRoleMappingDao

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

Specified by:

create in interface UserToBlogRoleMappingDao

Parameters:

entities - the collection of com.communote.server.persistence.blog.UserToBlogRoleMapping instances to create.

Returns:

the created instances.

See Also:

UserToBlogRoleMappingDao.create(java.util.Collection <com.communote.server.persistence.blog.UserToBlogRoleMapping>)

evict

public void evict(UserToBlogRoleMapping entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserToBlogRoleMappingDao

Parameters:

entity - the entity to evict

findMappingsForExternal

public Collection<UserToBlogRoleMapping> findMappingsForExternal(Long blogId,
                                                                 Long userId,
                                                                 Long groupId,
                                                                 boolean grantedByGroup,
                                                                 BlogRole role,
                                                                 String externalSystemId)

Description copied from interface: UserToBlogRoleMappingDao

Retrieves mappings matching the parameters. The external system ID is respected.

Specified by:

findMappingsForExternal in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.findMappingsForExternal(Long, Long, Long, boolean, com.communote.server.model.blog.BlogRole, String)

getRoleOfUser

public BlogRole getRoleOfUser(Long blogId,
                              Long userId)

Description copied from interface: UserToBlogRoleMappingDao

Returns the role of the user for the blog or null if the user has no role for the blog.

Specified by:

getRoleOfUser in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.getRoleOfUser(Long, Long)

handleFindMappingsForExternal

protected abstract Collection<UserToBlogRoleMapping> handleFindMappingsForExternal(Long blogId,
                                                                                   Long userId,
                                                                                   Long groupId,
                                                                                   boolean grantedByGroup,
                                                                                   BlogRole role,
                                                                                   String externalSystemId)

Performs the core logic for findMappingsForExternal(Long, Long, Long, boolean, com.communote.server.model.blog.BlogRole, String)

handleGetRoleOfUser

protected abstract BlogRole handleGetRoleOfUser(Long blogId,
                                                Long userId)

Performs the core logic for getRoleOfUser(Long, Long)

handleRemoveAllForBlog

protected abstract void handleRemoveAllForBlog(Long blogId)

Performs the core logic for removeAllForBlog(Long)

handleRemoveAllForGroup

protected abstract void handleRemoveAllForGroup(Long groupId)

Performs the core logic for removeAllForGroup(Long)

handleRemoveAllForGroupMember

protected abstract void handleRemoveAllForGroupMember(Long userId,
                                                      Long groupId)

Performs the core logic for removeAllForGroupMember(Long, Long)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserToBlogRoleMappingDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserToBlogRoleMappingDao.load(int, Long)

load

public UserToBlogRoleMapping load(Long id)

Description copied from interface: UserToBlogRoleMappingDao

Loads an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.

Specified by:

load in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.load(Long)

loadAll

public Collection<UserToBlogRoleMapping> loadAll()

Description copied from interface: UserToBlogRoleMappingDao

Loads all entities of type UserToBlogRoleMapping.

Specified by:

loadAll in interface UserToBlogRoleMappingDao

Returns:

the loaded entities.

See Also:

UserToBlogRoleMappingDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserToBlogRoleMappingDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserToBlogRoleMappingDao.loadAll(int)

remove

public void remove(UserToBlogRoleMapping userToBlogRoleMapping)

Description copied from interface: UserToBlogRoleMappingDao

Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.

Specified by:

remove in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.remove(com.communote.server.model.blog.UserToBlogRoleMapping)

remove

public void remove(Collection<UserToBlogRoleMapping> entities)

Description copied from interface: UserToBlogRoleMappingDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.remove(java.util.Collection <com.communote.server.persistence.blog.UserToBlogRoleMapping>)

remove

public void remove(Long id)

Description copied from interface: UserToBlogRoleMappingDao

Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping having the given identifier from the persistent store.

Specified by:

remove in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.remove(Long)

removeAllForBlog

public void removeAllForBlog(Long blogId)

Description copied from interface: UserToBlogRoleMappingDao

Removes all entries for one blog.

Specified by:

removeAllForBlog in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.removeAllForBlog(Long)

removeAllForGroup

public void removeAllForGroup(Long groupId)

Specified by:

removeAllForGroup in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.removeAllForGroup(Long)

removeAllForGroupMember

public void removeAllForGroupMember(Long userId,
                                    Long groupId)

Description copied from interface: UserToBlogRoleMappingDao

Removes all entries for group member.

Specified by:

removeAllForGroupMember in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.removeAllForGroupMember(Long, Long)

transformEntities

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

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

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.blog.UserToBlogRoleMapping)

transformEntity

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

Parameters:

transform - one of the constants declared in UserToBlogRoleMappingDao

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(UserToBlogRoleMapping userToBlogRoleMapping)

Description copied from interface: UserToBlogRoleMappingDao

Updates the userToBlogRoleMapping instance in the persistent store.

Specified by:

update in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.update(com.communote.server.model.blog.UserToBlogRoleMapping)

update

public void update(Collection<UserToBlogRoleMapping> entities)

Description copied from interface: UserToBlogRoleMappingDao

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

Specified by:

update in interface UserToBlogRoleMappingDao

See Also:

UserToBlogRoleMappingDao.update(java.util.Collection <com.communote.server.persistence.blog.UserToBlogRoleMapping>)