com.communote.server.persistence.blog

Class NoteDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.blog.NoteDaoBase

All Implemented Interfaces:

NoteDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

NoteDaoImpl

public abstract class NoteDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements NoteDao

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

Author:

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

See Also:

Note

Field Summary

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

logger

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

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
NoteDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<Note>	create(Collection<Note> entities) Creates a new instance of Note and adds from the passed in entities collection
Collection<Note>	create(int transform, Collection<Note> entities) Does the same thing as NoteDao.create(Note) with an additional flag called transform.
Object	create(int transform, Note note) Does the same thing as NoteDao.create(Note) with an additional flag called transform.
Note	create(Note note) Creates an instance of Note and adds it to the persistent store.
void	evict(Note entity) Evicts (removes) the entity from the hibernate cache
Note	findLatestNote() Returns the note with highest ID.
Note	findNearestNote(long noteId, Date creationDate, boolean younger) Returns the nearest note to the given Id.
Long	getAutosave(Long userId, Long noteId, Long parentNoteId, Collection<StringPropertyFilter> propertyfilters) Tries to find an autosaved note of the given user.
Collection<Long>	getFavoriteNoteIds(Long userId, Long lowerBound, Long upperBound) Returns the favorite notes of the given user within the given range.
protected GlobalIdDao	getGlobalIdDao() Gets the reference to globalIdDao.
List<Long>	getNoteIdsOfDiscussion(Long discussionId) Returns the IDs of the notes of the discussion.
List<Note>	getNotesByTag(Long tagId)
long	getNotesCount() Gets the count of all notes
List<Note>	getNotesForBlog(Long blogId, Long firstNoteId, Integer limit)
List<Note>	getNotesOfUser(Long userId)
int	getNumberOfFavorites(Long noteId) Returns how often a note is favorized.
protected abstract Note	handleFindLatestNote() Performs the core logic for findLatestNote()
protected abstract Note	handleFindNearestNote(long noteId, Date creationDate, boolean younger) Performs the core logic for findNearestNote(long, java.util.Date, boolean)
protected abstract Long	handleGetAutosave(Long userId, Long noteId, Long parentNoteId, Collection<StringPropertyFilter> propertyFilters) Performs the core logic for getAutosave(Long, Long, Long, Collection)
protected abstract Collection<Long>	handleGetFavoriteNoteIds(Long userId, Long lowerBound, Long upperBound) Performs the core logic for getFavoriteNoteIds(Long, Long, Long)
protected abstract List<Long>	handleGetNoteIdsOfDiscussion(Long discussionId) Performs the core logic for getNoteIdsOfDiscussion(Long)
protected abstract List<Note>	handleGetNotesByTag(Long tagId) Performs the core logic for getNotesByTag(Long)
protected abstract long	handleGetNotesCount() Performs the core logic for getNotesCount()
protected abstract List<Note>	handleGetNotesForBlog(Long blogId, Long firstNoteId, Integer limit) Performs the core logic for getNotesForBlog(Long, Long, Integer)
protected abstract List<Note>	handleGetNotesOfUser(Long userId) Performs the core logic for getNotesOfUser(Long)
protected abstract int	handleGetNumberOfFavorites(Long noteId)
protected abstract void	handleUpdateFollowableItems(Note note, boolean updateChildren) Performs the core logic for #updateFollowableItems(Note)
Object	load(int transform, Long id) Does the same thing as NoteDao.load(Long) with an additional flag called transform.
Note	load(Long id) Loads an instance of Note from the persistent store.
Collection<Note>	loadAll() Loads all entities of type Note.
Collection<?>	loadAll(int transform) Does the same thing as NoteDao.loadAll() with an additional flag called transform.
void	remove(Collection<Note> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of Note having the given identifier from the persistent store.
void	remove(Note note) Removes the instance of Note 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,Note) method.
protected Object	transformEntity(int transform, Note 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 NoteDao, please note that the NoteDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<Note> entities) Updates all instances in the entities collection in the persistent store.
void	update(Note note) Updates the note instance in the persistent store.
void	updateFollowableItems(Note note, boolean updateChildren) Updates the followableItems of a Note to the current settings.

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.NoteDao

forceLoad, hasInconsistentTopics, moveToTopic

Constructor Detail

NoteDaoBase

public NoteDaoBase()

Method Detail

create

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

Description copied from interface: NoteDao

Does the same thing as NoteDao.create(Note) 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 NoteDao

See Also:

NoteDao#create(int, java.util.Collection)

create

public Object create(int transform,
                     Note note)

Description copied from interface: NoteDao

Does the same thing as NoteDao.create(Note) 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 NoteDao

See Also:

NoteDao.create(int transform, Note)

create

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

Description copied from interface: NoteDao

Creates a new instance of Note and adds from the passed in entities collection

Specified by:

create in interface NoteDao

Parameters:

entities - the collection of Note instances to create.

Returns:

the created instances.

See Also:

NoteDao#create(java.util.Collection)

create

public Note create(Note note)

Description copied from interface: NoteDao

Creates an instance of Note and adds it to the persistent store.

Specified by:

create in interface NoteDao

See Also:

NoteDao.create(Note)

evict

public void evict(Note entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface NoteDao

Parameters:

entity - the entity to evict

findLatestNote

public Note findLatestNote()

Description copied from interface: NoteDao

Returns the note with highest ID.

Specified by:

findLatestNote in interface NoteDao

See Also:

NoteDao.findLatestNote()

findNearestNote

public Note findNearestNote(long noteId,
                            Date creationDate,
                            boolean younger)

Description copied from interface: NoteDao

Returns the nearest note to the given Id.

Specified by:

findNearestNote in interface NoteDao

See Also:

NoteDao.findNearestNote(long, java.util.Date, boolean)

getAutosave

public Long getAutosave(Long userId,
                        Long noteId,
                        Long parentNoteId,
                        Collection<StringPropertyFilter> propertyfilters)

Description copied from interface: NoteDao

Tries to find an autosaved note of the given user. If noteId is not null the returned autosave was created during an edit operation of that note. If noteId is null and parentNoteId is not null the returned autosave was created during an answer operation on that note.

Specified by:

getAutosave in interface NoteDao

Returns:

the ID of the note or null if not found

See Also:

NoteDao#getAutosave(Long, Long, Long, com.communote.server.api.core.property.StringPropertyFilter[])

getFavoriteNoteIds

public Collection<Long> getFavoriteNoteIds(Long userId,
                                           Long lowerBound,
                                           Long upperBound)

Description copied from interface: NoteDao

Returns the favorite notes of the given user within the given range.

Specified by:

getFavoriteNoteIds in interface NoteDao

See Also:

NoteDao.getFavoriteNoteIds(Long, Long, Long)

getGlobalIdDao

protected GlobalIdDao getGlobalIdDao()

Gets the reference to globalIdDao.

getNoteIdsOfDiscussion

public List<Long> getNoteIdsOfDiscussion(Long discussionId)

Description copied from interface: NoteDao

Returns the IDs of the notes of the discussion. The result does not include the root note of the discussion.

Specified by:

getNoteIdsOfDiscussion in interface NoteDao

See Also:

NoteDao.getNoteIdsOfDiscussion(Long)

getNotesByTag

public List<Note> getNotesByTag(Long tagId)

Specified by:

getNotesByTag in interface NoteDao

See Also:

NoteDao.getNotesByTag(Long)

getNotesCount

public long getNotesCount()

Description copied from interface: NoteDao

Gets the count of all notes

Specified by:

getNotesCount in interface NoteDao

See Also:

NoteDao.getNotesCount()

getNotesForBlog

public List<Note> getNotesForBlog(Long blogId,
                                  Long firstNoteId,
                                  Integer limit)

Description copied from interface: NoteDao

Specified by:

getNotesForBlog in interface NoteDao

Returns:

List of notes for the given blog and parameters.

See Also:

NoteDao.getNotesForBlog(Long, Long, Integer)

getNotesOfUser

public List<Note> getNotesOfUser(Long userId)

Specified by:

getNotesOfUser in interface NoteDao

See Also:

NoteDao.getNotesOfUser(Long)

getNumberOfFavorites

public int getNumberOfFavorites(Long noteId)

Description copied from interface: NoteDao

Returns how often a note is favorized.

Specified by:

getNumberOfFavorites in interface NoteDao

Parameters:

noteId - the note to check

Returns:

the number of favorites

See Also:

NoteDao.getNumberOfFavorites(Long)

handleFindLatestNote

protected abstract Note handleFindLatestNote()

Performs the core logic for findLatestNote()

handleFindNearestNote

protected abstract Note handleFindNearestNote(long noteId,
                                              Date creationDate,
                                              boolean younger)

Performs the core logic for findNearestNote(long, java.util.Date, boolean)

handleGetAutosave

protected abstract Long handleGetAutosave(Long userId,
                                          Long noteId,
                                          Long parentNoteId,
                                          Collection<StringPropertyFilter> propertyFilters)

Performs the core logic for getAutosave(Long, Long, Long, Collection)

handleGetFavoriteNoteIds

protected abstract Collection<Long> handleGetFavoriteNoteIds(Long userId,
                                                             Long lowerBound,
                                                             Long upperBound)

Performs the core logic for getFavoriteNoteIds(Long, Long, Long)

handleGetNoteIdsOfDiscussion

protected abstract List<Long> handleGetNoteIdsOfDiscussion(Long discussionId)

Performs the core logic for getNoteIdsOfDiscussion(Long)

handleGetNotesByTag

protected abstract List<Note> handleGetNotesByTag(Long tagId)

Performs the core logic for getNotesByTag(Long)

handleGetNotesCount

protected abstract long handleGetNotesCount()

Performs the core logic for getNotesCount()

handleGetNotesForBlog

protected abstract List<Note> handleGetNotesForBlog(Long blogId,
                                                    Long firstNoteId,
                                                    Integer limit)

Performs the core logic for getNotesForBlog(Long, Long, Integer)

handleGetNotesOfUser

protected abstract List<Note> handleGetNotesOfUser(Long userId)

Performs the core logic for getNotesOfUser(Long)

handleGetNumberOfFavorites

protected abstract int handleGetNumberOfFavorites(Long noteId)

handleUpdateFollowableItems

protected abstract void handleUpdateFollowableItems(Note note,
                                                    boolean updateChildren)

Performs the core logic for #updateFollowableItems(Note)

load

public Object load(int transform,
                   Long id)

Description copied from interface: NoteDao

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

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

NoteDao.load(int, Long)

load

public Note load(Long id)

Description copied from interface: NoteDao

Loads an instance of Note from the persistent store.

Specified by:

load in interface NoteDao

See Also:

NoteDao.load(Long)

loadAll

public Collection<Note> loadAll()

Description copied from interface: NoteDao

Loads all entities of type Note.

Specified by:

loadAll in interface NoteDao

Returns:

the loaded entities.

See Also:

NoteDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: NoteDao

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

NoteDao.loadAll(int)

remove

public void remove(Collection<Note> entities)

Description copied from interface: NoteDao

Removes all entities in the given entities collection.

Specified by:

remove in interface NoteDao

See Also:

NoteDao#remove(java.util.Collection)

remove

public void remove(Long id)

Description copied from interface: NoteDao

Removes the instance of Note having the given identifier from the persistent store.

Specified by:

remove in interface NoteDao

See Also:

NoteDao.remove(Long)

remove

public void remove(Note note)

Description copied from interface: NoteDao

Removes the instance of Note from the persistent store.

Specified by:

remove in interface NoteDao

See Also:

NoteDao.remove(Note)

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,Note) 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 NoteDao

entities - the collection of entities to transform

See Also:

transformEntity(int,Note)

transformEntity

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

Parameters:

transform - one of the constants declared in NoteDao

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(Collection<Note> entities)

Description copied from interface: NoteDao

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

Specified by:

update in interface NoteDao

See Also:

NoteDao#update(java.util.Collection)

update

public void update(Note note)

Description copied from interface: NoteDao

Updates the note instance in the persistent store.

Specified by:

update in interface NoteDao

See Also:

NoteDao.update(Note)

updateFollowableItems

public void updateFollowableItems(Note note,
                                  boolean updateChildren)

Description copied from interface: NoteDao

Updates the followableItems of a Note to the current settings. Should be called after the note was updated/created.

Specified by:

updateFollowableItems in interface NoteDao

updateChildren - If true, childrens will be updated too.

See Also:

NoteDao#updateFollowableItems(Note)