com.communote.server.persistence.blog

Interface NoteDao

All Known Implementing Classes:

NoteDaoBase, NoteDaoImpl

public interface NoteDao

Author:

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

See Also:

Note

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

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<?>	create(int transform, Collection<Note> entities) Does the same thing as create(Note) with an additional flag called transform.
Object	create(int transform, Note note) Does the same thing as 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.
Note	forceLoad(Long id) Load a note from the persistent store, even if it is cached.
Long	getAutosave(Long userId, Long noteId, Long parentNoteId, Collection<StringPropertyFilter> filters) 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.
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.
boolean	hasInconsistentTopics(Long discussionId, Long topicId) Test whether a discussion has notes which do not have the provided topic.
Object	load(int transform, Long id) Does the same thing as 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 loadAll() with an additional flag called transform.
void	moveToTopic(Long discussionId, Blog newTopic) Moves the given discussion to the given topic.
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	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.

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

Method Detail

create

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

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

Parameters:

entities - the collection of Note instances to create.

Returns:

the created instances.

create

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

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

create

Object create(int transform,
              Note note)

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

create

Note create(Note note)

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

evict

void evict(Note entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findLatestNote

Note findLatestNote()

Returns the note with highest ID.

findNearestNote

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

Returns the nearest note to the given Id.

forceLoad

Note forceLoad(Long id)

Load a note from the persistent store, even if it is cached. In case the note was cached the updated note will be put into the cache. Note: when called from within a session where the entity is already loaded, the returned object will be the one previously loaded into the session. However, a normal load from a later session will return the latest from the persistent storage.

Parameters:

id - the ID of the note to load

Returns:

the loaded note or null if there is no note with the given ID

getAutosave

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

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.

Returns:

the ID of the note or null if not found

getFavoriteNoteIds

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

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

getNoteIdsOfDiscussion

List<Long> getNoteIdsOfDiscussion(Long discussionId)

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

getNotesByTag

List<Note> getNotesByTag(Long tagId)

getNotesCount

long getNotesCount()

Gets the count of all notes

getNotesForBlog

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

Returns:

List of notes for the given blog and parameters.

getNotesOfUser

List<Note> getNotesOfUser(Long userId)

getNumberOfFavorites

int getNumberOfFavorites(Long noteId)

Returns how often a note is favorized.

Parameters:

noteId - the note to check

Returns:

the number of favorites

hasInconsistentTopics

boolean hasInconsistentTopics(Long discussionId,
                              Long topicId)

Test whether a discussion has notes which do not have the provided topic.

Parameters:

discussionId - ID of the discussion

topicId - the ID of the topic to test

Returns:

true if there are notes that do not have the provided topic

load

Object load(int transform,
            Long id)

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

Parameters:

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

Note load(Long id)

Loads an instance of Note from the persistent store.

loadAll

Collection<Note> loadAll()

Loads all entities of type Note.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

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

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

moveToTopic

void moveToTopic(Long discussionId,
                 Blog newTopic)

Moves the given discussion to the given topic.

Parameters:

discussionId - The discussion to move.

newTopic - The new topic of the discussion.

remove

void remove(Collection<Note> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

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

remove

void remove(Note note)

Removes the instance of Note from the persistent store.

update

void update(Collection<Note> entities)

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

update

void update(Note note)

Updates the note instance in the persistent store.

updateFollowableItems

void updateFollowableItems(Note note,
                           boolean updateChildren)

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

Parameters:

updateChildren - If true, childrens will be updated too.