com.communote.server.persistence.tasks

Class TaskDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.tasks.TaskDaoBase

All Implemented Interfaces:

TaskDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

TaskDaoImpl

public abstract class TaskDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements TaskDao

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

Author:

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

See Also:

Task

Field Summary

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

logger

Fields inherited from interface com.communote.server.persistence.tasks.TaskDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
TaskDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<Task>	create(Collection<Task> entities) Creates a new instance of com.communote.server.persistence.tasks.Task and adds from the passed in entities collection
Collection<Task>	create(int transform, Collection<Task> entities) Does the same thing as TaskDao.create(com.communote.server.model.task.Task) with an additional flag called transform.
Object	create(int transform, Task task) Does the same thing as TaskDao.create(com.communote.server.model.task.Task) with an additional flag called transform.
Task	create(Task task) Creates an instance of com.communote.server.persistence.tasks.Task and adds it to the persistent store.
void	evict(Task entity) Evicts (removes) the entity from the hibernate cache
Task	findNextScheduledTask()
Collection<Task>	findNextScheduledTasks(Date upperBound, int maxTasks, Collection<Long> taskIdsToExclude) Returns all task, which can be scheduled within the next time frame.
Task	findTaskByUniqueName(String uniqueName)
protected abstract Task	handleFindNextScheduledTask() Performs the core logic for findNextScheduledTask()
protected abstract Collection<Task>	handleFindNextScheduledTasks(Date upperBound, int maxTasks, Collection<Long> taskIdsToExclude) Performs the core logic for #findNextScheduledTasks(java.util.Date, int, java.util.Collection)
protected abstract Task	handleFindTaskByUniqueName(String uniqueName) Performs the core logic for findTaskByUniqueName(String)
Object	load(int transform, Long id) Does the same thing as TaskDao.load(Long) with an additional flag called transform.
Task	load(Long id) Loads an instance of com.communote.server.persistence.tasks.Task from the persistent store.
Collection<Task>	loadAll() Loads all entities of type Task.
Collection<?>	loadAll(int transform) Does the same thing as TaskDao.loadAll() with an additional flag called transform.
void	remove(Collection<Task> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.tasks.Task having the given identifier from the persistent store.
void	remove(Task task) Removes the instance of com.communote.server.persistence.tasks.Task from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.task.Task) method.
protected Object	transformEntity(int transform, Task 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.tasks.TaskDao, please note that the TaskDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Task> entities) Updates all instances in the entities collection in the persistent store.
void	update(Task task) Updates the task 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

TaskDaoBase

public TaskDaoBase()

Method Detail

create

public Task create(Task task)

Description copied from interface: TaskDao

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

Specified by:

create in interface TaskDao

See Also:

TaskDao.create(com.communote.server.model.task.Task)

create

public Object create(int transform,
                     Task task)

Description copied from interface: TaskDao

Does the same thing as TaskDao.create(com.communote.server.model.task.Task) 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 TaskDao

See Also:

com.communote.server.persistence.tasks.TaskDao#create(int transform, com.communote.server.persistence.tasks.Task)

create

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

Description copied from interface: TaskDao

Does the same thing as TaskDao.create(com.communote.server.model.task.Task) 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 TaskDao

See Also:

com.communote.server.persistence.tasks.TaskDao#create(int, java.util.Collection)

create

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

Description copied from interface: TaskDao

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

Specified by:

create in interface TaskDao

Parameters:

entities - the collection of com.communote.server.persistence.tasks.Task instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.tasks.TaskDao#create(java.util.Collection)

evict

public void evict(Task entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface TaskDao

Parameters:

entity - the entity to evict

findNextScheduledTask

public Task findNextScheduledTask()

Description copied from interface: TaskDao

Specified by:

findNextScheduledTask in interface TaskDao

Returns:

Returns the next task to schedule or null if there is none.

See Also:

TaskDao.findNextScheduledTask()

findNextScheduledTasks

public Collection<Task> findNextScheduledTasks(Date upperBound,
                                               int maxTasks,
                                               Collection<Long> taskIdsToExclude)

Description copied from interface: TaskDao

Returns all task, which can be scheduled within the next time frame.

Specified by:

findNextScheduledTasks in interface TaskDao

See Also:

com.communote.server.persistence.tasks.TaskDao#findNextScheduledTasks(java.util.Date, int, java.util.Collection)

findTaskByUniqueName

public Task findTaskByUniqueName(String uniqueName)

Description copied from interface: TaskDao

Specified by:

findTaskByUniqueName in interface TaskDao

Returns:

The task specified by its name or null.

See Also:

TaskDao.findTaskByUniqueName(String)

handleFindNextScheduledTask

protected abstract Task handleFindNextScheduledTask()

Performs the core logic for findNextScheduledTask()

handleFindNextScheduledTasks

protected abstract Collection<Task> handleFindNextScheduledTasks(Date upperBound,
                                                                 int maxTasks,
                                                                 Collection<Long> taskIdsToExclude)

Performs the core logic for #findNextScheduledTasks(java.util.Date, int, java.util.Collection)

handleFindTaskByUniqueName

protected abstract Task handleFindTaskByUniqueName(String uniqueName)

Performs the core logic for findTaskByUniqueName(String)

load

public Object load(int transform,
                   Long id)

Description copied from interface: TaskDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

TaskDao.load(int, Long)

load

public Task load(Long id)

Description copied from interface: TaskDao

Loads an instance of com.communote.server.persistence.tasks.Task from the persistent store.

Specified by:

load in interface TaskDao

See Also:

TaskDao.load(Long)

loadAll

public Collection<Task> loadAll()

Description copied from interface: TaskDao

Loads all entities of type Task.

Specified by:

loadAll in interface TaskDao

Returns:

the loaded entities.

See Also:

TaskDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: TaskDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

TaskDao.loadAll(int)

remove

public void remove(Task task)

Description copied from interface: TaskDao

Removes the instance of com.communote.server.persistence.tasks.Task from the persistent store.

Specified by:

remove in interface TaskDao

See Also:

TaskDao.remove(com.communote.server.model.task.Task)

remove

public void remove(Collection<Task> entities)

Description copied from interface: TaskDao

Removes all entities in the given entities collection.

Specified by:

remove in interface TaskDao

See Also:

com.communote.server.persistence.tasks.TaskDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: TaskDao

Removes the instance of com.communote.server.persistence.tasks.Task having the given identifier from the persistent store.

Specified by:

remove in interface TaskDao

See Also:

TaskDao.remove(Long)

transformEntities

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

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.task.Task) 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.tasks.TaskDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.task.Task)

transformEntity

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

Parameters:

transform - one of the constants declared in TaskDao

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(Task task)

Description copied from interface: TaskDao

Updates the task instance in the persistent store.

Specified by:

update in interface TaskDao

See Also:

TaskDao.update(com.communote.server.model.task.Task)

update

public void update(Collection<Task> entities)

Description copied from interface: TaskDao

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

Specified by:

update in interface TaskDao

See Also:

com.communote.server.persistence.tasks.TaskDao#update(java.util.Collection)