eu.etaxonomy.cdm.persistence.dao.common
Interface ITermVocabularyDao

All Superinterfaces:

IAnnotatableDao<TermVocabulary>, ICdmEntityDao<TermVocabulary>, IIdentifiableDao<TermVocabulary>, ISearchableDao<TermVocabulary>, ITitledDao<TermVocabulary>, IVersionableDao<TermVocabulary>

All Known Implementing Classes:

TermVocabularyDaoImpl

public interface ITermVocabularyDao
extends IIdentifiableDao<TermVocabulary>

Author:

a.mueller

Method Summary

int	countTerms(TermVocabulary termVocabulary) Return a count of terms that belong to the termVocabulary supplied
<T extends DefinedTermBase> TermVocabulary<T>	findByUri(String termSourceUri, Class<T> clazz)
<T extends DefinedTermBase> List<T>	getTerms(TermVocabulary<T> termVocabulary, Integer pageSize, Integer pageNumber) Return a List of terms that belong to the termVocabulary supplied
<T extends DefinedTermBase> List<T>	getTerms(TermVocabulary<T> vocabulary, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) Return a List of terms that belong to the termVocabulary supplied
<TERMTYPE extends DefinedTermBase> List<TermVocabulary<? extends TERMTYPE>>	listByTermClass(Class<TERMTYPE> clazz, boolean includeSubclasses, boolean includeEmptyVocs, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths) Returns term vocabularies that contain terms of a certain class e.g.
List<TermVocabulary>	listEmpty(Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths)

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.IIdentifiableDao

countByReferenceTitle, countByTitle, countRights, countSources, countTitleCache, find, findByReferenceTitle, findByTitle, findOriginalSourceByIdInSource, findTitleCache, getRights, getSources, getUuidAndTitleCache

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.IAnnotatableDao

countAnnotations, countMarkers, countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.IVersionableDao

countAuditEvents, countAuditEvents, getAuditEvents, getAuditEvents, getNextAuditEvent, getPreviousAuditEvent

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ICdmEntityDao

clear, count, count, count, delete, exists, findById, findByUuid, flush, getSession, getType, group, list, list, list, list, list, list, list, listByIds, load, load, load, lock, merge, refresh, refresh, replace, rows, save, saveAll, saveOrUpdate, saveOrUpdateAll, update

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ITitledDao

countByTitle, countByTitle, countByTitle, findByTitle, findByTitle, findByTitle, findByTitleAndClass

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ISearchableDao

count, optimizeIndex, purgeIndex, rebuildIndex, search, suggestQuery

Method Detail

countTerms

int countTerms(TermVocabulary termVocabulary)

Return a count of terms that belong to the termVocabulary supplied

Parameters:

termVocabulary - The term vocabulary which 'owns' the terms of interest

Returns:

a count of terms

getTerms

<T extends DefinedTermBase> List<T> getTerms(TermVocabulary<T> termVocabulary,
                                             Integer pageSize,
                                             Integer pageNumber)

Return a List of terms that belong to the termVocabulary supplied

Parameters:

termVocabulary - The term vocabulary which 'owns' the terms of interest

pageSize - The maximum number of terms returned (can be null for all terms)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)

Returns:

a List of terms

findByUri

<T extends DefinedTermBase> TermVocabulary<T> findByUri(String termSourceUri,
                                                        Class<T> clazz)

getTerms

<T extends DefinedTermBase> List<T> getTerms(TermVocabulary<T> vocabulary,
                                             Integer pageSize,
                                             Integer pageNumber,
                                             List<OrderHint> orderHints,
                                             List<String> propertyPaths)

Return a List of terms that belong to the termVocabulary supplied

Parameters:

termVocabulary - The term vocabulary which 'owns' the terms of interest

pageSize - The maximum number of terms returned (can be null for all terms)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)

orderHints - Supports path like orderHints.propertyNames which include *-to-one properties like createdBy.username or authorTeam.persistentTitleCache

propertyPaths - properties to be initialized

Returns:

a List of terms

listByTermClass

<TERMTYPE extends DefinedTermBase> List<TermVocabulary<? extends TERMTYPE>> listByTermClass(Class<TERMTYPE> clazz,
                                                                                            boolean includeSubclasses,
                                                                                            boolean includeEmptyVocs,
                                                                                            Integer limit,
                                                                                            Integer start,
                                                                                            List<OrderHint> orderHints,
                                                                                            List<String> propertyPaths)

Returns term vocabularies that contain terms of a certain class e.g. Feature, Modifier, State.

Type Parameters:

TERMTYPE -

Parameters:

clazz - the term class of the terms in the vocabulary

includeSubclasses - if true all subclasses of clazz will be included for computation of the result

includeEmptyVocs - if true all vocabularies that do not contain any term will be included in the result

limit - The maximum number of vocabularies returned (can be null for all vocabularies)

start - The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)

orderHints - Supports path like orderHints.propertyNames which include *-to-one properties like createdBy.username or authorTeam.persistentTitleCache

propertyPaths - properties to be initialized

Returns:

a list of term vocabularies

listEmpty

List<TermVocabulary> listEmpty(Integer limit,
                               Integer start,
                               List<OrderHint> orderHints,
                               List<String> propertyPaths)