TagDaoBase (Communote 3.5 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.orm.hibernate3.support.HibernateDaoSupport
  - - com.communote.server.persistence.tag.TagDaoBase

All Implemented Interfaces:

TagDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

TagDaoImpl
```
public abstract class TagDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements TagDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Tag.

Author:

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

See Also:

Tag

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

Constructor Summary

Constructors
Constructor and Description

TagDaoBase()

Constructors
Constructor and Description
`TagDaoBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<Tag>`	`create(Collection<Tag> entities)` Creates a new instance of Tag and adds from the passed in `entities` collection
`Collection<Tag>`	`create(int transform, Collection<Tag> entities)` Does the same thing as `TagDao.create(Tag)` with an additional flag called `transform`.
`Object`	`create(int transform, Tag tag)` Does the same thing as `TagDao.create(Tag)` with an additional flag called `transform`.
`Tag`	`create(Tag tag)` Creates an instance of Tag and adds it to the persistent store.
`void`	`evict(Tag entity)` Evicts (removes) the entity from the hibernate cache
`List<TagData>`	`findByPrefix(String prefix, ResultSpecification resultSpecification)`
`Tag`	`findByTagStore(String tagStoreTagId, String tagStoreAlias)` Finds a tag by its TagStore definition.
`protected GlobalIdDao`	`getGlobalIdDao()` Gets the reference to `globalIdDao`.
`protected abstract List<TagData>`	`handleFindByPrefix(String prefix, ResultSpecification resultSpecification)` Performs the core logic for `findByPrefix(String, com.communote.server.core.filter.ResultSpecification)`
`protected abstract Tag`	`handleFindByTagStore(String tagStoreTagId, String tagStoreAlias)` Performs the core logic for `findByTagStore(String, String)`
`Object`	`load(int transform, Long id)` Does the same thing as `TagDao.load(Long)` with an additional flag called `transform`.
`Tag`	`load(Long id)` Loads an instance of Tag from the persistent store.
`Collection<TagImpl>`	`loadAll()` Loads all entities of type `Tag`.
`Collection<TagImpl>`	`loadAll(int transform)` Does the same thing as `TagDao.loadAll()` with an additional flag called `transform`.
`void`	`remove(Long id)` Removes the instance of Tag 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,Tag)` method.
`protected Object`	`transformEntity(int transform, Tag 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 `TagDao`, please note that the `TagDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(Collection<Tag> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(Tag tag)` Updates the `tag` 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.tag.TagDao
getFollowers, remove, removeNoteTag

- Constructor Detail
  - TagDaoBase
```
public TagDaoBase()
```
- Method Detail
  - create
```
public Collection<Tag> create(Collection<Tag> entities)
```
    Description copied from interface: TagDao
    
    Creates a new instance of Tag and adds from the passed in entities collection
    
    Specified by:
    
    create in interface TagDao
    
    Parameters:
    
    entities - the collection of Tag instances to create.
    
    Returns:
    
    the created instances.
    
    See Also:
    
    TagDao#create(Collection)
  - create
```
public Collection<Tag> create(int transform,
                              Collection<Tag> entities)
```
    Description copied from interface: TagDao
    
    Does the same thing as TagDao.create(Tag) 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 TagDao
    
    See Also:
    
    TagDao#create(int, Collection)
  - create
```
public Object create(int transform,
                     Tag tag)
```
    Description copied from interface: TagDao
    
    Does the same thing as TagDao.create(Tag) 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 TagDao
    
    See Also:
    
    TagDao.create(int transform, Tag)
  - create
```
public Tag create(Tag tag)
```
    Description copied from interface: TagDao
    
    Creates an instance of Tag and adds it to the persistent store.
    
    Specified by:
    
    create in interface TagDao
    
    See Also:
    
    TagDao.create(Tag)
  - evict
```
public void evict(Tag entity)
```
    Evicts (removes) the entity from the hibernate cache
    
    Specified by:
    
    evict in interface TagDao
    
    Parameters:
    
    entity - the entity to evict
  - findByPrefix
```
public List<TagData> findByPrefix(String prefix,
                                  ResultSpecification resultSpecification)
```
    Specified by:
    
    findByPrefix in interface TagDao
    
    Returns:
    
    List of tags with the given prefix.
    
    See Also:
    
    TagDao.findByPrefix(String, com.communote.server.core.filter.ResultSpecification)
  - findByTagStore
```
public Tag findByTagStore(String tagStoreTagId,
                          String tagStoreAlias)
```
    Description copied from interface: TagDao
    
    Finds a tag by its TagStore definition.
    
    Specified by:
    
    findByTagStore in interface TagDao
    
    See Also:
    
    TagDao.findByTagStore(String, String)
  - getGlobalIdDao
```
protected GlobalIdDao getGlobalIdDao()
```
    Gets the reference to globalIdDao.
  - handleFindByPrefix
```
protected abstract List<TagData> handleFindByPrefix(String prefix,
                                                    ResultSpecification resultSpecification)
```
    Performs the core logic for findByPrefix(String, com.communote.server.core.filter.ResultSpecification)
  - handleFindByTagStore
```
protected abstract Tag handleFindByTagStore(String tagStoreTagId,
                                            String tagStoreAlias)
```
    Performs the core logic for findByTagStore(String, String)
  - load
```
public Object load(int transform,
                   Long id)
```
    Description copied from interface: TagDao
    
    Does the same thing as TagDao.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 TagDao
    
    id - the identifier of the entity to load.
    
    Returns:
    
    either the entity or the object transformed from the entity.
    
    See Also:
    
    TagDao.load(int, Long)
  - load
```
public Tag load(Long id)
```
    Description copied from interface: TagDao
    
    Loads an instance of Tag from the persistent store.
    
    Specified by:
    
    load in interface TagDao
    
    See Also:
    
    TagDao.load(Long)
  - loadAll
```
public Collection<TagImpl> loadAll()
```
    Description copied from interface: TagDao
    
    Loads all entities of type Tag.
    
    Specified by:
    
    loadAll in interface TagDao
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    TagDao.loadAll()
  - loadAll
```
public Collection<TagImpl> loadAll(int transform)
```
    Description copied from interface: TagDao
    
    Does the same thing as TagDao.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 TagDao
    
    Parameters:
    
    transform - the flag indicating what transformation to use.
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    TagDao.loadAll(int)
  - remove
```
public void remove(Long id)
```
    Description copied from interface: TagDao
    
    Removes the instance of Tag having the given identifier from the persistent store.
    
    Specified by:
    
    remove in interface TagDao
    
    See Also:
    
    TagDao.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,Tag) 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 TagDao
    
    entities - the collection of entities to transform
    
    See Also:
    
    transformEntity(int,Tag)
  - transformEntity
```
protected Object transformEntity(int transform,
                                 Tag 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 TagDao, please note that the TagDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown TagDao.TRANSFORM_NONE is assumed.
    
    Parameters:
    
    transform - one of the constants declared in TagDao
    
    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<Tag> entities)
```
    Description copied from interface: TagDao
    
    Updates all instances in the entities collection in the persistent store.
    
    Specified by:
    
    update in interface TagDao
    
    See Also:
    
    TagDao#update(Collection)
  - update
```
public void update(Tag tag)
```
    Description copied from interface: TagDao
    
    Updates the tag instance in the persistent store.
    
    Specified by:
    
    update in interface TagDao
    
    See Also:
    
    TagDao.update(Tag)

Class TagDaoBase

Field Summary

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

Fields inherited from interface com.communote.server.persistence.tag.TagDao

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

Methods inherited from interface com.communote.server.persistence.tag.TagDao

Constructor Detail

TagDaoBase

Method Detail

create

create

create

create

evict

findByPrefix

findByTagStore

getGlobalIdDao

handleFindByPrefix

handleFindByTagStore

load

load

loadAll

loadAll

remove

setGlobalIdDao

transformEntities

transformEntity

update

update