MessageDaoBase (Communote 3.5 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.orm.hibernate3.support.HibernateDaoSupport
  - - com.communote.server.persistence.common.messages.MessageDaoBase

All Implemented Interfaces:

MessageDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

MessageDaoImpl
```
public abstract class MessageDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements MessageDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Message.

Author:

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

See Also:

Message

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

Constructor Summary

Constructors
Constructor and Description

MessageDaoBase()

Constructors
Constructor and Description
`MessageDaoBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<Message>`	`create(Collection<Message> entities)` Creates a new instance of Message and adds from the passed in `entities` collection
`Collection<Message>`	`create(int transform, Collection<Message> entities)` Does the same thing as `MessageDao.create(com.communote.server.model.i18n.Message)` with an additional flag called `transform`.
`Object`	`create(int transform, Message message)` Does the same thing as `MessageDao.create(com.communote.server.model.i18n.Message)` with an additional flag called `transform`.
`Message`	`create(Message message)` Creates an instance of Message and adds it to the persistent store.
`void`	`evict(Message entity)` Evicts (removes) the entity from the hibernate cache
`Collection<Message>`	`find(String key)` Returns a list of all messages for a specific key.
`Message`	`find(String key, String languageCode)` Returns the message for the key in the specific language or null if there is no one.
`Message`	`find(String key, String languageCode, String fallbackLanguageCode)` Returns the specified message.
`protected abstract Collection<Message>`	`handleFind(String key)` Performs the core logic for `find(String)`
`protected abstract Message`	`handleFind(String key, String languageCode)` Performs the core logic for `find(String, String)`
`protected abstract Message`	`handleFind(String key, String languageCode, String fallbackLanguageCode)` Performs the core logic for `find(String, String, String)`
`Object`	`load(int transform, Long id)` Does the same thing as `MessageDao.load(Long)` with an additional flag called `transform`.
`Message`	`load(Long id)` Loads an instance of Message from the persistent store.
`Collection<Message>`	`loadAll()` Loads all entities of type `Message`.
`Collection<?>`	`loadAll(int transform)` Does the same thing as `MessageDao.loadAll()` with an additional flag called `transform`.
`void`	`remove(Collection<Message> entities)` Removes all entities in the given `entities collection.`
`void`	`remove(Long id)` Removes the instance of Message having the given `identifier` from the persistent store.
`void`	`remove(Message message)` Removes the instance of Message from the persistent store.
`protected void`	`transformEntities(int transform, Collection<?> entities)` Transforms a collection of entities using the `transformEntity(int,com.communote.server.model.i18n.Message)` method.
`protected Object`	`transformEntity(int transform, Message 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 `MessageDao`, please note that the `MessageDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(Collection<Message> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(Message message)` Updates the `message` 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
  - MessageDaoBase
```
public MessageDaoBase()
```
- Method Detail
  - create
```
public Message create(Message message)
```
    Description copied from interface: MessageDao
    
    Creates an instance of Message and adds it to the persistent store.
    
    Specified by:
    
    create in interface MessageDao
    
    See Also:
    
    MessageDao.create(com.communote.server.model.i18n.Message)
  - create
```
public Object create(int transform,
                     Message message)
```
    Description copied from interface: MessageDao
    
    Does the same thing as MessageDao.create(com.communote.server.model.i18n.Message) 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 MessageDao
  - create
```
public Collection<Message> create(int transform,
                                  Collection<Message> entities)
```
    Description copied from interface: MessageDao
    
    Does the same thing as MessageDao.create(com.communote.server.model.i18n.Message) 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 MessageDao
  - create
```
public Collection<Message> create(Collection<Message> entities)
```
    Description copied from interface: MessageDao
    
    Creates a new instance of Message and adds from the passed in entities collection
    
    Specified by:
    
    create in interface MessageDao
    
    Parameters:
    
    entities - the collection of Message instances to create.
    
    Returns:
    
    the created instances.
  - evict
```
public void evict(Message entity)
```
    Evicts (removes) the entity from the hibernate cache
    
    Specified by:
    
    evict in interface MessageDao
    
    Parameters:
    
    entity - the entity to evict
  - find
```
public Collection<Message> find(String key)
```
    Description copied from interface: MessageDao
    
    Returns a list of all messages for a specific key.
    
    Specified by:
    
    find in interface MessageDao
    
    See Also:
    
    MessageDao.find(String)
  - find
```
public Message find(String key,
                    String languageCode)
```
    Description copied from interface: MessageDao
    
    Returns the message for the key in the specific language or null if there is no one.
    
    Specified by:
    
    find in interface MessageDao
    
    See Also:
    
    MessageDao.find(String, String)
  - find
```
public Message find(String key,
                    String languageCode,
                    String fallbackLanguageCode)
```
    Description copied from interface: MessageDao
    
    Returns the specified message. Returns the message fallback if the original message was not found.
    
    Specified by:
    
    find in interface MessageDao
    
    See Also:
    
    MessageDao.find(String, String, String)
  - handleFind
```
protected abstract Collection<Message> handleFind(String key)
```
    Performs the core logic for find(String)
  - handleFind
```
protected abstract Message handleFind(String key,
                                      String languageCode)
```
    Performs the core logic for find(String, String)
  - handleFind
```
protected abstract Message handleFind(String key,
                                      String languageCode,
                                      String fallbackLanguageCode)
```
    Performs the core logic for find(String, String, String)
  - load
```
public Object load(int transform,
                   Long id)
```
    Description copied from interface: MessageDao
    
    Does the same thing as MessageDao.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 MessageDao
    
    id - the identifier of the entity to load.
    
    Returns:
    
    either the entity or the object transformed from the entity.
    
    See Also:
    
    MessageDao.load(int, Long)
  - load
```
public Message load(Long id)
```
    Description copied from interface: MessageDao
    
    Loads an instance of Message from the persistent store.
    
    Specified by:
    
    load in interface MessageDao
    
    See Also:
    
    MessageDao.load(Long)
  - loadAll
```
public Collection<Message> loadAll()
```
    Description copied from interface: MessageDao
    
    Loads all entities of type Message.
    
    Specified by:
    
    loadAll in interface MessageDao
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    MessageDao.loadAll()
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Description copied from interface: MessageDao
    
    Does the same thing as MessageDao.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 MessageDao
    
    Parameters:
    
    transform - the flag indicating what transformation to use.
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    MessageDao.loadAll(int)
  - remove
```
public void remove(Message message)
```
    Description copied from interface: MessageDao
    
    Removes the instance of Message from the persistent store.
    
    Specified by:
    
    remove in interface MessageDao
    
    See Also:
    
    MessageDao.remove(com.communote.server.model.i18n.Message)
  - remove
```
public void remove(Collection<Message> entities)
```
    Description copied from interface: MessageDao
    
    Removes all entities in the given entities collection.
    Specified by: remove in interface MessageDao
  remove public void remove(Long id) Description copied from interface: MessageDao Removes the instance of Message having the given identifier from the persistent store. Specified by: remove in interface MessageDao See Also: MessageDao.remove(Long) transformEntities protected void transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.i18n.Message) 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 MessageDao entities - the collection of entities to transform See Also: transformEntity(int,com.communote.server.model.i18n.Message) transformEntity protected Object transformEntity(int transform, Message 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 MessageDao, please note that the MessageDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown MessageDao.TRANSFORM_NONE is assumed. Parameters: transform - one of the constants declared in MessageDao 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(Message message) Description copied from interface: MessageDao Updates the message instance in the persistent store. Specified by: update in interface MessageDao See Also: MessageDao.update(com.communote.server.model.i18n.Message) update public void update(Collection<Message> entities) Description copied from interface: MessageDao Updates all instances in the entities collection in the persistent store. Specified by: update in interface MessageDao

Class MessageDaoBase

Field Summary

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

Fields inherited from interface com.communote.server.persistence.common.messages.MessageDao

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

MessageDaoBase

Method Detail

create

create

create

create

evict

find

find

find

handleFind

handleFind

handleFind

load

load

loadAll

loadAll

remove

remove

remove

transformEntities

transformEntity

update

update