org.finra.herd.dao

Interface TagDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

TagDaoImpl

public interface TagDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
List<TagEntity>	getChildrenTags(List<TagEntity> parentTagEntities) Gets a list of tag entities that are immediate children of the specified parent tag entities.
long	getCountOfAllTags() Gets a count of all tag entities
List<TagEntity>	getMostRecentTags(int numberOfResults) Gets the most recent of all tag entities
List<TagEntity>	getPercentageOfAllTags(double percentage) Gets a percentage of all tag entities.
TagEntity	getTagByKey(TagKey tagKey) Get a tag entity by its key.
TagEntity	getTagByTagTypeAndDisplayName(String tagTypeCode, String displayName) Get a tag entity by its tag type code and display name.
List<TagEntity>	getTags() Gets a list of all tag entities registered in the system.
List<TagEntity>	getTagsByIds(List<Long> ids) Gets a list of tag entities by a list of ids
List<TagChild>	getTagsByTagTypeAndParentTagCode(String tagTypeCode, String parentTagCode) Gets a list of tag child objects with children flags, whose parent tag code is the specified tag code.
List<TagEntity>	getTagsByTagTypeEntityAndParentTagCode(TagTypeEntity tagTypeEntity, String parentTagCode, Boolean isParentTagNull) Gets a list of tag entities per specified parameters.

Methods inherited from interface org.finra.herd.dao.BaseJpaDao

delete, detach, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, query, queryByNamedParams, save, saveAndRefresh

Method Detail

getChildrenTags

List<TagEntity> getChildrenTags(List<TagEntity> parentTagEntities)

Gets a list of tag entities that are immediate children of the specified parent tag entities.

Parameters:

parentTagEntities - the list of parent tag entities

Returns:

the list of tag entities that are immediate children of the specified parent tag entities

getTagByKey

TagEntity getTagByKey(TagKey tagKey)

Get a tag entity by its key.

Parameters:

tagKey - the tag key

Returns:

the tag entity for the specified key

getTagByTagTypeAndDisplayName

TagEntity getTagByTagTypeAndDisplayName(String tagTypeCode,
                                        String displayName)

Get a tag entity by its tag type code and display name.

Parameters:

tagTypeCode - the specified tag type code

displayName - the specified display name

Returns:

the tag entity for the specified parameters

getTags

List<TagEntity> getTags()

Gets a list of all tag entities registered in the system. The list of tags returned by this method is sorted by tag type order number and by tag's display name ascending.

Returns:

list of tag entities

getTagsByIds

List<TagEntity> getTagsByIds(List<Long> ids)

Gets a list of tag entities by a list of ids

Parameters:

ids - a list of tag ids

Returns:

the list of tag entities.

getTagsByTagTypeAndParentTagCode

List<TagChild> getTagsByTagTypeAndParentTagCode(String tagTypeCode,
                                                String parentTagCode)

Gets a list of tag child objects with children flags, whose parent tag code is the specified tag code.

When tagCode is null, return tags of tagTypeCode whose have no parent (root tags).

Parameters:

tagTypeCode - the tag type code

parentTagCode - the parent tag code, may be null

Returns:

list of tag child objects with children flags

getTagsByTagTypeEntityAndParentTagCode

List<TagEntity> getTagsByTagTypeEntityAndParentTagCode(TagTypeEntity tagTypeEntity,
                                                       String parentTagCode,
                                                       Boolean isParentTagNull)

Gets a list of tag entities per specified parameters.

Parameters:

tagTypeEntity - the tag type entity

parentTagCode - the parent tag code, may be null

isParentTagNull - specifies if tags should have no parents (root tags). This flag is ignored when parent tag code is specified

Returns:

list of tag entities

getPercentageOfAllTags

List<TagEntity> getPercentageOfAllTags(double percentage)

Gets a percentage of all tag entities. The percentage is randomly selected from all the tags. The random selection is done by assigning a random number between 0 and 1 for each tag and if that number is below the percentage value passed in as an argument, also between 0 and 1, then the tag is selected.

Parameters:

percentage - the percentage of all tags to return. Value between 0 and 1 (inclusive).

Returns:

the percentage of all tag entities

getMostRecentTags

List<TagEntity> getMostRecentTags(int numberOfResults)

Gets the most recent of all tag entities

Parameters:

numberOfResults - the number of results to return

Returns:

the most recent of all tag entities.

getCountOfAllTags

long getCountOfAllTags()

Gets a count of all tag entities

Returns:

the count of all tag entities.