com.communote.server.persistence.tag

Interface TagDao

All Known Implementing Classes:

TagDaoBase, TagDaoImpl

public interface TagDao

Author:

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

See Also:

Tag

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<Tag>	create(Collection<Tag> entities) Creates a new instance of Tag and adds from the passed in entities collection
Collection<Tag>	create(int transform, Collection<Tag> entities) Does the same thing as create(Tag) with an additional flag called transform.
Object	create(int transform, Tag tag) Does the same thing as create(Tag) with an additional flag called transform.
Tag	create(Tag tag) Creates an instance of Tag and adds it to the persistent store.
void	evict(Tag entity) Evicts (removes) the entity from the hibernate cache
List<TagData>	findByPrefix(String prefix, ResultSpecification resultSpecification)
Tag	findByTagStore(String tagStoreTagId, String tagStoreAlias) Finds a tag by its TagStore definition.
List<Long>	getFollowers(Long tagId) Return the IDs of all users that follow the tag with the given ID.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
Tag	load(Long id) Loads an instance of Tag from the persistent store.
Collection<? extends Tag>	loadAll() Loads all entities of type Tag.
Collection<? extends Tag>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Long id) Removes the instance of Tag having the given identifier from the persistent store.
void	remove(Tag tag) Removes the instance of Tag from the persistent store.
void	removeNoteTag(long oldTagId, Long newTagId) This method removes the given tag.
void	update(Collection<Tag> entities) Updates all instances in the entities collection in the persistent store.
void	update(Tag tag) Updates the tag instance in the persistent store.

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

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

Parameters:

entities - the collection of Tag instances to create.

Returns:

the created instances.

create

Collection<Tag> create(int transform,
                       Collection<Tag> entities)

Does the same thing as create(Tag) 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,
              Tag tag)

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

Tag create(Tag tag)

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

evict

void evict(Tag entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findByPrefix

List<TagData> findByPrefix(String prefix,
                           ResultSpecification resultSpecification)

Returns:

List of tags with the given prefix.

findByTagStore

Tag findByTagStore(String tagStoreTagId,
                   String tagStoreAlias)

Finds a tag by its TagStore definition.

getFollowers

List<Long> getFollowers(Long tagId)

Return the IDs of all users that follow the tag with the given ID. The resulting list will be empty if the tag does not exis.

Parameters:

tagId - the ID of the tag for which the followers should be returned

Returns:

the IDs of the followers

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

Tag load(Long id)

Loads an instance of Tag from the persistent store.

loadAll

Collection<? extends Tag> loadAll()

Loads all entities of type Tag.

Returns:

the loaded entities.

loadAll

Collection<? extends Tag> 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.

remove

void remove(Long id)

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

remove

void remove(Tag tag)

Removes the instance of Tag from the persistent store.

removeNoteTag

void removeNoteTag(long oldTagId,
                   Long newTagId)

This method removes the given tag. The tag may only be a note tag.

Parameters:

oldTagId - Id of the tag to delete.

newTagId - Id of an optional new tag, the data of the old tag should be assigned to.

update

void update(Collection<Tag> entities)

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

update

void update(Tag tag)

Updates the tag instance in the persistent store.