eu.etaxonomy.cdm.api.service
Interface IVocabularyService

All Superinterfaces:

IAnnotatableService<TermVocabulary>, IIdentifiableEntityService<TermVocabulary>, IService<TermVocabulary>, IVersionableService<TermVocabulary>

All Known Implementing Classes:

VocabularyServiceImpl

public interface IVocabularyService
extends IIdentifiableEntityService<TermVocabulary>

Method Summary

TermVocabulary<Language>	getLanguageVocabulary() Returns Language Vocabulary
Pager<DefinedTermBase>	getTerms(TermVocabulary vocabulary, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths) Returns a list of terms belonging to the vocabulary passed as an argument
TermVocabulary	getVocabulary(VocabularyEnum vocabularyType)
<TERM extends DefinedTermBase> List<TermVocabulary<? extends TERM>>	listByTermClass(Class<TERM> 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.
<TERM extends DefinedTermBase> List<TermVocabulary<TERM>>	listByTermClass(Class<TERM> clazz, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths) Returns term vocabularies that contain terms of a certain class e.g.

Methods inherited from interface eu.etaxonomy.cdm.api.service.IIdentifiableEntityService

countByTitle, countByTitle, deduplicate, find, findByTitle, findByTitle, findTitleCache, getRights, getSourcedObjectByIdInSource, getSources, getUuidAndTitleCache, listByReferenceTitle, listByTitle, replace, search, updateTitleCache, updateTitleCache

Methods inherited from interface eu.etaxonomy.cdm.api.service.IAnnotatableService

countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.api.service.IVersionableService

getNextAuditEvent, getPreviousAuditEvent, pageAuditEvents, pageAuditEvents

Methods inherited from interface eu.etaxonomy.cdm.api.service.IService

clear, count, delete, exists, find, find, find, findById, getSession, group, list, list, load, load, lock, merge, page, refresh, refresh, rows, save, save, saveOrUpdate, saveOrUpdate, update

Method Detail

getVocabulary

TermVocabulary getVocabulary(VocabularyEnum vocabularyType)

listByTermClass

<TERM extends DefinedTermBase> List<TermVocabulary<TERM>> listByTermClass(Class<TERM> clazz,
                                                                          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:

TERM -

Parameters:

clazz - the term class of the terms in the vocabulary

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

See Also:

#listByTermClass(Class, boolean, Integer, Integer, List, List)

listByTermClass

<TERM extends DefinedTermBase> List<TermVocabulary<? extends TERM>> listByTermClass(Class<TERM> 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:

TERM -

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

See Also:

listByTermClass(Class, Integer, Integer, List, List)

getLanguageVocabulary

TermVocabulary<Language> getLanguageVocabulary()

Returns Language Vocabulary

Returns:

getTerms

Pager<DefinedTermBase> getTerms(TermVocabulary vocabulary,
                                Integer limit,
                                Integer start,
                                List<OrderHint> orderHints,
                                List<String> propertyPaths)

Returns a list of terms belonging to the vocabulary passed as an argument

Parameters:

vocabulary - The vocabulary for which the list of terms is desired

limit - The maximum number of terms returned (can be null for all terms in the vocabulary)

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 paged list of terms