GroupDaoBase (Communote 3.5 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.orm.hibernate3.support.HibernateDaoSupport
  - - com.communote.server.persistence.user.group.GroupDaoBase

All Implemented Interfaces:

GroupDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

GroupDaoImpl
```
public abstract class GroupDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements GroupDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Group.

Author:

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

See Also:

Group

Field Summary
- Fields inherited from class org.springframework.dao.support.DaoSupport
  logger
- Fields inherited from interface com.communote.server.persistence.user.group.GroupDao
  TRANSFORM_NONE

Constructor Summary

Constructors
Constructor and Description

GroupDaoBase()

Constructors
Constructor and Description
`GroupDaoBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`count(String filter)` Returns the number of elements within the database.
`int`	`countMembers(long groupId)` Returns the number of members of the given group.
`Collection<Group>`	`create(Collection<Group> entities)` Creates a new instance of Group and adds from the passed in `entities` collection
`Group`	`create(Group group)` Creates an instance of Group and adds it to the persistent store.
`Collection<Group>`	`create(int transform, Collection<Group> entities)` Does the same thing as `GroupDao.create(com.communote.server.model.user.group.Group)` with an additional flag called `transform`.
`Object`	`create(int transform, Group group)` Does the same thing as `GroupDao.create(com.communote.server.model.user.group.Group)` with an additional flag called `transform`.
`void`	`evict(Group entity)` Evicts (removes) the entity from the hibernate cache
`Group`	`findByAlias(String alias)` Searches a group by the alias.
`protected GlobalIdDao`	`getGlobalIdDao()` Gets the reference to `globalIdDao`.
`Collection<Group>`	`getGroupsOfUser(Long userId)`
`protected abstract int`	`handleCount(String filter)` Performs the core logic for `count(String)`
`protected abstract int`	`handleCountMembers(long groupId)` Performs the core logic for `countMembers(long)`
`protected abstract Group`	`handleFindByAlias(String alias)` Performs the core logic for `findByAlias(String)`
`protected abstract Collection<Group>`	`handleGetGroupsOfUser(Long userId)` Performs the core logic for `getGroupsOfUser(Long)`
`protected abstract boolean`	`handleIsEntityMember(Long groupId, Long entityId)` Performs the core logic for `isEntityMember(Long, Long)`
`protected abstract Collection<Group>`	`handleLoadAllWithReferences()` Performs the core logic for `loadAllWithReferences()`
`protected abstract Collection<Group>`	`handleLoadWithReferences(int offset, int count, String nameFilter)` Performs the core logic for `loadWithReferences(int, int, String)`
`boolean`	`isEntityMember(Long groupId, Long entityId)` Tests whether an entity identified by an ID is member of the group.
`Object`	`load(int transform, Long id)` Does the same thing as `GroupDao.load(Long)` with an additional flag called `transform`.
`Group`	`load(Long id)` Loads an instance of Group from the persistent store.
`Collection<Group>`	`loadAll()` Loads all entities of type `Group`.
`Collection<?>`	`loadAll(int transform)` Does the same thing as `GroupDao.loadAll()` with an additional flag called `transform`.
`Collection<Group>`	`loadAllWithReferences()`
`Collection<Group>`	`loadWithReferences(int offset, int count, String nameFilter)` Loads a range of groups.
`void`	`remove(Collection<Group> entities)` Removes all entities in the given `entities collection.`
`void`	`remove(Group group)` Removes the instance of Group from the persistent store.
`void`	`remove(Long id)` Removes the instance of Group 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,Group)` method.
`protected Object`	`transformEntity(int transform, Group 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 `GroupDao`, please note that the `GroupDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(Collection<Group> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(Group group)` Updates the `group` 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
  - GroupDaoBase
```
public GroupDaoBase()
```
- Method Detail
  - count
```
public int count(String filter)
```
    Description copied from interface: GroupDao
    
    Returns the number of elements within the database.
    
    Specified by:
    
    count in interface GroupDao
    
    See Also:
    
    GroupDao.count(String)
  - countMembers
```
public int countMembers(long groupId)
```
    Description copied from interface: GroupDao
    
    Returns the number of members of the given group.
    
    Specified by:
    
    countMembers in interface GroupDao
    
    See Also:
    
    GroupDao.countMembers(long)
  - create
```
public Collection<Group> create(Collection<Group> entities)
```
    Description copied from interface: GroupDao
    
    Creates a new instance of Group and adds from the passed in entities collection
    
    Specified by:
    
    create in interface GroupDao
    
    Parameters:
    
    entities - the collection of Group instances to create.
    
    Returns:
    
    the created instances.
    
    See Also:
    
    GroupDao.create(Collection <Group>)
  - create
```
public Group create(Group group)
```
    Description copied from interface: GroupDao
    
    Creates an instance of Group and adds it to the persistent store.
    
    Specified by:
    
    create in interface GroupDao
    
    See Also:
    
    GroupDao.create(Group)
  - create
```
public Collection<Group> create(int transform,
                                Collection<Group> entities)
```
    Description copied from interface: GroupDao
    
    Does the same thing as GroupDao.create(com.communote.server.model.user.group.Group) 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 GroupDao
    
    See Also:
    
    GroupDao#create(int, Collection)
  - create
```
public Object create(int transform,
                     Group group)
```
    Description copied from interface: GroupDao
    
    Does the same thing as GroupDao.create(com.communote.server.model.user.group.Group) 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 GroupDao
    
    See Also:
    
    GroupDao.create(int transform, Group)
  - evict
```
public void evict(Group entity)
```
    Evicts (removes) the entity from the hibernate cache
    
    Specified by:
    
    evict in interface GroupDao
    
    Parameters:
    
    entity - the entity to evict
  - findByAlias
```
public Group findByAlias(String alias)
```
    Description copied from interface: GroupDao
    
    Searches a group by the alias.
    
    Specified by:
    
    findByAlias in interface GroupDao
    
    See Also:
    
    GroupDao.findByAlias(String)
  - getGlobalIdDao
```
protected GlobalIdDao getGlobalIdDao()
```
    Gets the reference to globalIdDao.
  - getGroupsOfUser
```
public Collection<Group> getGroupsOfUser(Long userId)
```
    Specified by:
    
    getGroupsOfUser in interface GroupDao
    
    See Also:
    
    GroupDao.getGroupsOfUser(Long)
  - handleCount
```
protected abstract int handleCount(String filter)
```
    Performs the core logic for count(String)
  - handleCountMembers
```
protected abstract int handleCountMembers(long groupId)
```
    Performs the core logic for countMembers(long)
  - handleFindByAlias
```
protected abstract Group handleFindByAlias(String alias)
```
    Performs the core logic for findByAlias(String)
  - handleGetGroupsOfUser
```
protected abstract Collection<Group> handleGetGroupsOfUser(Long userId)
```
    Performs the core logic for getGroupsOfUser(Long)
  - handleIsEntityMember
```
protected abstract boolean handleIsEntityMember(Long groupId,
                                                Long entityId)
```
    Performs the core logic for isEntityMember(Long, Long)
  - handleLoadAllWithReferences
```
protected abstract Collection<Group> handleLoadAllWithReferences()
```
    Performs the core logic for loadAllWithReferences()
  - handleLoadWithReferences
```
protected abstract Collection<Group> handleLoadWithReferences(int offset,
                                                              int count,
                                                              String nameFilter)
```
    Performs the core logic for loadWithReferences(int, int, String)
  - isEntityMember
```
public boolean isEntityMember(Long groupId,
                              Long entityId)
```
    Description copied from interface: GroupDao
    
    Tests whether an entity identified by an ID is member of the group.
    
    Specified by:
    
    isEntityMember in interface GroupDao
    
    See Also:
    
    GroupDao.isEntityMember(Long, Long)
  - load
```
public Object load(int transform,
                   Long id)
```
    Description copied from interface: GroupDao
    
    Does the same thing as GroupDao.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 GroupDao
    
    id - the identifier of the entity to load.
    
    Returns:
    
    either the entity or the object transformed from the entity.
    
    See Also:
    
    GroupDao.load(int, Long)
  - load
```
public Group load(Long id)
```
    Description copied from interface: GroupDao
    
    Loads an instance of Group from the persistent store.
    
    Specified by:
    
    load in interface GroupDao
    
    See Also:
    
    GroupDao.load(Long)
  - loadAll
```
public Collection<Group> loadAll()
```
    Description copied from interface: GroupDao
    
    Loads all entities of type Group.
    
    Specified by:
    
    loadAll in interface GroupDao
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    GroupDao.loadAll()
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Description copied from interface: GroupDao
    
    Does the same thing as GroupDao.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 GroupDao
    
    Parameters:
    
    transform - the flag indicating what transformation to use.
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    GroupDao.loadAll(int)
  - loadAllWithReferences
```
public Collection<Group> loadAllWithReferences()
```
    Specified by:
    
    loadAllWithReferences in interface GroupDao
    
    See Also:
    
    GroupDao.loadAllWithReferences()
  - loadWithReferences
```
public Collection<Group> loadWithReferences(int offset,
                                            int count,
                                            String nameFilter)
```
    Description copied from interface: GroupDao
    
    Loads a range of groups.
    
    Specified by:
    
    loadWithReferences in interface GroupDao
    
    See Also:
    
    GroupDao.loadWithReferences(int, int, String)
  - remove
```
public void remove(Collection<Group> entities)
```
    Description copied from interface: GroupDao
    
    Removes all entities in the given entities collection.
    Specified by: remove in interface GroupDao See Also: GroupDao.remove(Collection <Group>)
  remove public void remove(Group group) Description copied from interface: GroupDao Removes the instance of Group from the persistent store. Specified by: remove in interface GroupDao See Also: GroupDao.remove(Group) remove public void remove(Long id) Description copied from interface: GroupDao Removes the instance of Group having the given identifier from the persistent store. Specified by: remove in interface GroupDao See Also: GroupDao.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,Group) 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 GroupDao entities - the collection of entities to transform See Also: transformEntity(int,Group) transformEntity protected Object transformEntity(int transform, Group 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 GroupDao, please note that the GroupDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown GroupDao.TRANSFORM_NONE is assumed. Parameters: transform - one of the constants declared in GroupDao entity - an entity that was found Returns: the transformed entity (i.e. new value object, etc) See Also: transformEntities(int,Collection) update public void update(Collection<Group> entities) Description copied from interface: GroupDao Updates all instances in the entities collection in the persistent store. Specified by: update in interface GroupDao See Also: GroupDao.update(Collection <Group>) update public void update(Group group) Description copied from interface: GroupDao Updates the group instance in the persistent store. Specified by: update in interface GroupDao See Also: GroupDao.update(Group)

Class GroupDaoBase

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

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

Methods inherited from class java.lang.Object

Constructor Detail

GroupDaoBase

Method Detail

count

countMembers

create

create

create

create

evict

findByAlias

getGlobalIdDao

getGroupsOfUser

handleCount

handleCountMembers

handleFindByAlias

handleGetGroupsOfUser

handleIsEntityMember

handleLoadAllWithReferences

handleLoadWithReferences

isEntityMember

load

load

loadAll

loadAll

loadAllWithReferences

loadWithReferences

remove

remove

remove

setGlobalIdDao

transformEntities

transformEntity

update

update