com.communote.server.persistence.blog

Class BlogDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.blog.BlogDaoBase

All Implemented Interfaces:

BlogDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

BlogDaoImpl

public abstract class BlogDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements BlogDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type Blog.

Author:

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

See Also:

Blog

Field Summary

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

logger

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

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
BlogDaoBase()

Method Summary

Modifier and Type	Method and Description
Blog	create(Blog blog) Creates an instance of com.communote.server.persistence.blog.Blog and adds it to the persistent store.
Collection<Blog>	create(Collection<Blog> entities) Creates a new instance of com.communote.server.persistence.blog.Blog and adds from the passed in entities collection
Object	create(int transform, Blog blog) Does the same thing as BlogDao.create(com.communote.server.model.blog.Blog) with an additional flag called transform.
Collection<Blog>	create(int transform, Collection<Blog> entities) Does the same thing as BlogDao.create(com.communote.server.model.blog.Blog) with an additional flag called transform.
void	evict(Blog entity) Evicts (removes) the entity from the hibernate cache
List<Blog>	findBlogs(Long[] ids)
Blog	findByExternalObject(Long internalExternalObjectId) Return the blog that has the given external object assigned
Blog	findByExternalObject(String externalSystemId, String externalId) Find a blog that has a given external object
List<Blog>	findByExternalSystemId(String systemId) Return all blogs that have an external object with the given external system id
Object	findByNameIdentifier(int transform, String nameIdentifier) Does the same thing as BlogDao.findByNameIdentifier(String) with an additional flag called transform.
Object	findByNameIdentifier(int transform, String queryString, String nameIdentifier) Does the same thing as #findByNameIdentifier(boolean, String) with an additional argument called queryString.
Blog	findByNameIdentifier(String nameIdentifier) Find the blog with the given name identifier.
Blog	findByNameIdentifier(String queryString, String nameIdentifier) Does the same thing as BlogDao.findByNameIdentifier(String) with an additional argument called queryString.
List<Blog>	findDirectlyManagedBlogsOfUser(Long userId) Returns all blogs that are managed by a user.
Blog	findLatestBlog() Returns the Blog entity with the highest ID value.
protected GlobalIdDao	getGlobalIdDao() Gets the reference to globalIdDao.
List<BlogData>	getLastUsedBlogs(Long userId, int maxResult)
List<BlogData>	getMostUsedBlogs(Long userId, int maxResults, int maxDays)
protected abstract List<Blog>	handleFindBlogs(Long[] ids) Performs the core logic for findBlogs(Long[])
protected abstract Blog	handleFindByExternalObject(Long internalExternalObjectId) Performs the core logic for findByExternalObject(Long)
protected abstract Blog	handleFindByExternalObject(String externalSystemId, String externalId) Performs the core logic for findByExternalObject(String, String)
protected abstract List<Blog>	handleFindByExternalSystemId(String systemId) Performs the core logic for findByExternalSystemId(String)
protected abstract List<Blog>	handleFindDirectlyManagedBlogsOfUser(Long userId) Performs the core logic for findDirectlyManagedBlogsOfUser(Long)
protected abstract Blog	handleFindLatestBlog() Performs the core logic for findLatestBlog()
protected abstract List<BlogData>	handleGetLastUsedBlogs(Long userId, int maxResult) Performs the core logic for getLastUsedBlogs(Long, int)
protected abstract List<BlogData>	handleGetMostUsedBlogs(Long userId, int maxResults, int maxDays) Performs the core logic for getMostUsedBlogs(Long, int, int)
Object	load(int transform, Long id) Does the same thing as BlogDao.load(Long) with an additional flag called transform.
Blog	load(Long id) Loads an instance of com.communote.server.persistence.blog.Blog from the persistent store.
Collection<Blog>	loadAll() Loads all entities of type Blog.
Collection<?>	loadAll(int transform) Does the same thing as BlogDao.loadAll() with an additional flag called transform.
void	remove(Blog blog) Removes the instance of com.communote.server.persistence.blog.Blog from the persistent store.
void	remove(Collection<Blog> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.blog.Blog 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,Blog) method.
protected Object	transformEntity(int transform, Blog 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.BlogDao, please note that the BlogDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Blog blog) Updates the blog instance in the persistent store.
void	update(Collection<Blog> entities) Updates all instances in the entities collection 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.BlogDao

getBlogCount, resetGlobalPermissions

Constructor Detail

BlogDaoBase

public BlogDaoBase()

Method Detail

create

public Blog create(Blog blog)

Description copied from interface: BlogDao

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

Specified by:

create in interface BlogDao

See Also:

BlogDao.create(Blog)

create

public Object create(int transform,
                     Blog blog)

Description copied from interface: BlogDao

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

See Also:

com.communote.server.persistence.blog.BlogDao#create(int transform, com.communote.server.persistence.blog.Blog)

create

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

Description copied from interface: BlogDao

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

See Also:

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

create

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

Description copied from interface: BlogDao

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

Specified by:

create in interface BlogDao

Parameters:

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

Returns:

the created instances.

See Also:

com.communote.server.persistence.blog.BlogDao#create(java.util.Collection)

evict

public void evict(Blog entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface BlogDao

Parameters:

entity - the entity to evict

findBlogs

public List<Blog> findBlogs(Long[] ids)

Specified by:

findBlogs in interface BlogDao

See Also:

BlogDao.findBlogs(Long[])

findByExternalObject

public Blog findByExternalObject(Long internalExternalObjectId)

Description copied from interface: BlogDao

Return the blog that has the given external object assigned

Specified by:

findByExternalObject in interface BlogDao

See Also:

BlogDao.findByExternalObject(Long)

findByExternalObject

public Blog findByExternalObject(String externalSystemId,
                                 String externalId)

Description copied from interface: BlogDao

Find a blog that has a given external object

Specified by:

findByExternalObject in interface BlogDao

See Also:

BlogDao.findByExternalObject(String, String)

findByExternalSystemId

public List<Blog> findByExternalSystemId(String systemId)

Description copied from interface: BlogDao

Return all blogs that have an external object with the given external system id

Specified by:

findByExternalSystemId in interface BlogDao

See Also:

BlogDao.findByExternalSystemId(String)

findByNameIdentifier

public Object findByNameIdentifier(int transform,
                                   String nameIdentifier)

Description copied from interface: BlogDao

Does the same thing as BlogDao.findByNameIdentifier(String) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results 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:

findByNameIdentifier in interface BlogDao

See Also:

BlogDao.findByNameIdentifier(int, String)

findByNameIdentifier

public Object findByNameIdentifier(int transform,
                                   String queryString,
                                   String nameIdentifier)

Description copied from interface: BlogDao

Does the same thing as #findByNameIdentifier(boolean, String) with an additional argument called queryString. This queryString argument allows you to override the query string defined in BlogDao.findByNameIdentifier(int, String nameIdentifier).

Specified by:

findByNameIdentifier in interface BlogDao

See Also:

BlogDao.findByNameIdentifier(int, String, String)

findByNameIdentifier

public Blog findByNameIdentifier(String nameIdentifier)

Description copied from interface: BlogDao

Find the blog with the given name identifier.

Specified by:

findByNameIdentifier in interface BlogDao

See Also:

BlogDao.findByNameIdentifier(String)

findByNameIdentifier

public Blog findByNameIdentifier(String queryString,
                                 String nameIdentifier)

Description copied from interface: BlogDao

Does the same thing as BlogDao.findByNameIdentifier(String) with an additional argument called queryString. This queryString argument allows you to override the query string defined in BlogDao.findByNameIdentifier(String).

Specified by:

findByNameIdentifier in interface BlogDao

See Also:

BlogDao.findByNameIdentifier(String, String)

findDirectlyManagedBlogsOfUser

public List<Blog> findDirectlyManagedBlogsOfUser(Long userId)

Description copied from interface: BlogDao

Returns all blogs that are managed by a user. This does only include blogs to which the user was explicitly added as manager and not those the user can manage because of his membership in a group with management access.

Specified by:

findDirectlyManagedBlogsOfUser in interface BlogDao

See Also:

BlogDao.findDirectlyManagedBlogsOfUser(Long)

findLatestBlog

public Blog findLatestBlog()

Description copied from interface: BlogDao

Returns the Blog entity with the highest ID value.

Specified by:

findLatestBlog in interface BlogDao

See Also:

BlogDao.findLatestBlog()

getGlobalIdDao

protected GlobalIdDao getGlobalIdDao()

Gets the reference to globalIdDao.

getLastUsedBlogs

public List<BlogData> getLastUsedBlogs(Long userId,
                                       int maxResult)

Specified by:

getLastUsedBlogs in interface BlogDao

See Also:

BlogDao.getLastUsedBlogs(Long, int)

getMostUsedBlogs

public List<BlogData> getMostUsedBlogs(Long userId,
                                       int maxResults,
                                       int maxDays)

Specified by:

getMostUsedBlogs in interface BlogDao

See Also:

BlogDao.getMostUsedBlogs(Long, int, int)

handleFindBlogs

protected abstract List<Blog> handleFindBlogs(Long[] ids)

Performs the core logic for findBlogs(Long[])

handleFindByExternalObject

protected abstract Blog handleFindByExternalObject(Long internalExternalObjectId)

Performs the core logic for findByExternalObject(Long)

handleFindByExternalObject

protected abstract Blog handleFindByExternalObject(String externalSystemId,
                                                   String externalId)

Performs the core logic for findByExternalObject(String, String)

handleFindByExternalSystemId

protected abstract List<Blog> handleFindByExternalSystemId(String systemId)

Performs the core logic for findByExternalSystemId(String)

handleFindDirectlyManagedBlogsOfUser

protected abstract List<Blog> handleFindDirectlyManagedBlogsOfUser(Long userId)

Performs the core logic for findDirectlyManagedBlogsOfUser(Long)

handleFindLatestBlog

protected abstract Blog handleFindLatestBlog()

Performs the core logic for findLatestBlog()

handleGetLastUsedBlogs

protected abstract List<BlogData> handleGetLastUsedBlogs(Long userId,
                                                         int maxResult)

Performs the core logic for getLastUsedBlogs(Long, int)

handleGetMostUsedBlogs

protected abstract List<BlogData> handleGetMostUsedBlogs(Long userId,
                                                         int maxResults,
                                                         int maxDays)

Performs the core logic for getMostUsedBlogs(Long, int, int)

load

public Object load(int transform,
                   Long id)

Description copied from interface: BlogDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

BlogDao.load(int, Long)

load

public Blog load(Long id)

Description copied from interface: BlogDao

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

Specified by:

load in interface BlogDao

See Also:

BlogDao.load(Long)

loadAll

public Collection<Blog> loadAll()

Description copied from interface: BlogDao

Loads all entities of type Blog.

Specified by:

loadAll in interface BlogDao

Returns:

the loaded entities.

See Also:

BlogDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: BlogDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

BlogDao.loadAll(int)

remove

public void remove(Blog blog)

Description copied from interface: BlogDao

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

Specified by:

remove in interface BlogDao

See Also:

BlogDao.remove(Blog)

remove

public void remove(Collection<Blog> entities)

Description copied from interface: BlogDao

Removes all entities in the given entities collection.

Specified by:

remove in interface BlogDao

See Also:

com.communote.server.persistence.blog.BlogDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: BlogDao

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

Specified by:

remove in interface BlogDao

See Also:

BlogDao.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,Blog) 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.BlogDao

entities - the collection of entities to transform

See Also:

transformEntity(int,Blog)

transformEntity

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

Parameters:

transform - one of the constants declared in BlogDao

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(Blog blog)

Description copied from interface: BlogDao

Updates the blog instance in the persistent store.

Specified by:

update in interface BlogDao

See Also:

BlogDao.update(Blog)

update

public void update(Collection<Blog> entities)

Description copied from interface: BlogDao

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

Specified by:

update in interface BlogDao

See Also:

com.communote.server.persistence.blog.BlogDao#update(java.util.Collection)