-/**\r
-* Copyright (C) 2009 EDIT\r
-* European Distributed Institute of Taxonomy\r
-* http://www.e-taxonomy.eu\r
-*\r
-* The contents of this file are subject to the Mozilla Public License Version 1.1\r
-* See LICENSE.TXT at the top of this package for the full license terms.\r
-*/\r
-\r
-package eu.etaxonomy.cdm.api.service;\r
-\r
-import java.util.List;\r
-\r
-import eu.etaxonomy.cdm.api.service.pager.Pager;\r
-import eu.etaxonomy.cdm.model.common.DefinedTermBase;\r
-import eu.etaxonomy.cdm.model.common.Language;\r
-import eu.etaxonomy.cdm.model.common.TermType;\r
-import eu.etaxonomy.cdm.model.common.TermVocabulary;\r
-import eu.etaxonomy.cdm.model.common.VocabularyEnum;\r
-import eu.etaxonomy.cdm.persistence.query.OrderHint;\r
-\r
-public interface IVocabularyService extends IIdentifiableEntityService<TermVocabulary> {\r
-\r
- //TODO candidate for harmonization: rename to load(VocabularyEnum vocabularyType)\r
- public TermVocabulary getVocabulary(VocabularyEnum vocabularyType);\r
-\r
- /**\r
- * Returns term vocabularies that contain terms of a certain class e.g. Feature, Modifier, State.\r
- *\r
- * @param <TERM>\r
- * @param clazz the term class of the terms in the vocabulary\r
- * @param limit The maximum number of vocabularies returned (can be null for all vocabularies)\r
- * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)\r
- * @param orderHints\r
- * Supports path like <code>orderHints.propertyNames</code> which\r
- * include *-to-one properties like createdBy.username or\r
- * authorTeam.persistentTitleCache\r
- * @param propertyPaths properties to be initialized\r
- * @return a list of term vocabularies\r
- * @see #listByTermClass(Class, boolean, Integer, Integer, List, List)\r
- */\r
- public <TERM extends DefinedTermBase> List<TermVocabulary<TERM>> listByTermClass(Class<TERM> clazz, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
-\r
- /**\r
- * Returns term vocabularies that contain terms of a certain class e.g. Feature, Modifier, State.\r
- *\r
- * @param <TERM>\r
- * @param clazz the term class of the terms in the vocabulary\r
- * @param includeSubclasses if <code>true</code> all subclasses of clazz will be included for computation of the result\r
- * @param includeEmptyVocs if <code>true</code> all vocabularies that do not contain any term will be included in the result\r
- * @param limit The maximum number of vocabularies returned (can be null for all vocabularies)\r
- * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)\r
- * @param orderHints\r
- * Supports path like <code>orderHints.propertyNames</code> which\r
- * include *-to-one properties like createdBy.username or\r
- * authorTeam.persistentTitleCache\r
- * @param propertyPaths properties to be initialized\r
- * @return a list of term vocabularies\r
- * @see #listByTermClass(Class, Integer, Integer, List, List)\r
- */\r
- public <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);\r
-\r
-\r
- /**\r
- * Returns Language Vocabulary\r
- * @return\r
- */\r
- //TODO candidate for harmonization: rename to loadLanguageVocabulary(...\r
- public TermVocabulary<Language> getLanguageVocabulary();\r
-\r
- /**\r
- * Returns a list of terms belonging to the vocabulary passed as an argument\r
- *\r
- * @param vocabulary The vocabulary for which the list of terms is desired\r
- * @param limit The maximum number of terms returned (can be null for all terms in the vocabulary)\r
- * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)\r
- * @param orderHints\r
- * Supports path like <code>orderHints.propertyNames</code> which\r
- * include *-to-one properties like createdBy.username or\r
- * authorTeam.persistentTitleCache\r
- * @param propertyPaths properties to be initialized\r
- * @return a paged list of terms\r
- */\r
- //TODO candidate for harmonization: rename to getTerms(...\r
- public Pager<DefinedTermBase> getTerms(TermVocabulary vocabulary, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
- \r
- /**\r
- * Returns a list of term vocabularies corresponding to a term type\r
- *\r
- * @param termType The term type for which the list of vocabularies is desired\r
- * @return a list of vocabularies\r
- */\r
- public <T extends DefinedTermBase> List<TermVocabulary<T>> findByTermType(TermType termType);\r
-\r
-}\r
+/**
+* Copyright (C) 2009 EDIT
+* European Distributed Institute of Taxonomy
+* http://www.e-taxonomy.eu
+*
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+
+package eu.etaxonomy.cdm.api.service;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Set;
+import java.util.UUID;
+
+import eu.etaxonomy.cdm.api.service.pager.Pager;
+import eu.etaxonomy.cdm.model.common.Language;
+import eu.etaxonomy.cdm.model.term.DefinedTermBase;
+import eu.etaxonomy.cdm.model.term.TermType;
+import eu.etaxonomy.cdm.model.term.TermVocabulary;
+import eu.etaxonomy.cdm.persistence.dto.TermDto;
+import eu.etaxonomy.cdm.persistence.dto.TermVocabularyDto;
+import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
+import eu.etaxonomy.cdm.persistence.query.OrderHint;
+
+public interface IVocabularyService extends IIdentifiableEntityService<TermVocabulary> {
+
+ /**
+ * Returns term vocabularies that contain terms of a certain {@link TermType} e.g. Feature, Modifier, State.
+ *
+ * @param <TERMTYPE>
+ * @param termType the {@link TermType} of the terms in the vocabulary and of the vocabulary
+ * @param includeSubTypes if <code>true</code> all subtypes will be included for computation of the result
+ * @param limit The maximum number of vocabularies returned (can be null for all vocabularies)
+ * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)
+ * @param orderHints
+ * Supports path like <code>orderHints.propertyNames</code> which
+ * include *-to-one properties like createdBy.username or
+ * authorTeam.persistentTitleCache
+ * @param propertyPaths properties to be initialized
+ * @return a list of term vocabularies
+ */
+ public List<TermVocabulary> listByTermType(TermType termType, boolean includeSubTypes, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
+
+ /**
+ * Returns Language Vocabulary
+ * @return
+ */
+ //TODO candidate for harmonization: rename to loadLanguageVocabulary(...
+ public TermVocabulary<Language> getLanguageVocabulary();
+
+ /**
+ * Returns a list of terms belonging to the vocabulary passed as an argument
+ *
+ * @param vocabulary The vocabulary for which the list of terms is desired
+ * @param limit The maximum number of terms returned (can be null for all terms in the vocabulary)
+ * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)
+ * @param orderHints
+ * Supports path like <code>orderHints.propertyNames</code> which
+ * include *-to-one properties like createdBy.username or
+ * authorTeam.persistentTitleCache
+ * @param propertyPaths properties to be initialized
+ * @return a paged list of terms
+ */
+ //TODO candidate for harmonization: rename to getTerms(...
+ public Pager<DefinedTermBase> getTerms(TermVocabulary vocabulary, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
+
+ /**
+ * Returns a list of term vocabularies corresponding to a term type
+ *
+ * @param termType The term type for which the list of vocabularies is desired
+ * @return a list of vocabularies
+ */
+ public <T extends DefinedTermBase> List<TermVocabulary<T>> findByTermType(TermType termType, List<String> propertyPaths);
+
+ /**
+ * Loads all top level terms, i.e. terms that have no parent terms, for the given vocabulary
+ * @param vocabularyUuid the uuid of the vocabulary
+ * @return a collection of top level terms
+ */
+ public Collection<TermDto> getTopLevelTerms(UUID vocabularyUuid);
+
+ /**
+ * Loads all terms for the given vocabulary
+ * @param vocabularyUuid the id of the vocabulary
+ * @return a collection of terms
+ */
+ public Collection<TermDto> getTerms(UUID vocabularyUuid);
+
+ /**
+ * Loads all terms for the given vocabularies
+ * @param vocabularyUuids the ids of the vocabularies
+ * @return a collection of terms
+ */
+ public Collection<TermDto> getTerms(List<UUID> vocabularyUuids);
+
+ /**
+ * Initializes the complete term hierarchy consisting of {@link TermDto}s
+ * for the given vocabulary
+ * @param vocabularyDto the dto of the term vocabulary
+ * @return a the top level elements for this vocabulary
+ */
+ public Collection<TermDto> getCompleteTermHierarchy(TermVocabularyDto vocabularyDto);
+
+ /**
+ * Returns term vocabularies that contain terms of a certain {@link TermType} e.g. Feature, Modifier, State.
+ *
+ * @param termType the {@link TermType} of the terms in the vocabulary and of the vocabulary
+ * @return a list of term vocabulary DTOs
+ */
+ public List<TermVocabularyDto> findVocabularyDtoByTermType(TermType termType);
+
+ /**
+ * Returns term vocabularies that contain terms of the given types {@link TermType} e.g. Feature, Modifier, State.
+ *
+ * @param termTypes a set of {@link TermType}s of the terms in the vocabulary and of the vocabulary
+ * @return a list of term vocabulary DTOs
+ */
+ public List<TermVocabularyDto> findVocabularyDtoByTermTypes(Set<TermType> termTypes);
+
+ /**
+ * Creates a new term as a direct child of the given vocabulary.
+ * @param termType the {@link TermType} of the term to create
+ * @param vocabularyUUID the {@link UUID} of the vocabulary
+ * kindOf relation. Otherwise it will added via a partOf relation
+ * @return the new term
+ */
+ public TermDto addNewTerm(TermType termType, UUID vocabularyUUID);
+
+ /**
+ *
+ * Like {@link #getUuidAndTitleCache(Class, Integer, String)} but filtering
+ * the results by {@link TermType} of the vocabularies.
+ *
+ *
+ * @param clazz
+ * the (sub)class
+ * @param termType
+ * the {@link TermType} of the vocabularies to be retrieved
+ * @param limit
+ * max number of results
+ * @param pattern
+ * search pattern
+ * @return a list of {@link UuidAndTitleCache}
+ *
+ * @see #getUuidAndTitleCache(Class, Integer, String))
+ */
+ public <S extends TermVocabulary> List<UuidAndTitleCache<S>> getUuidAndTitleCache(Class<S> clazz, TermType termType,
+ Integer limit, String pattern);
+
+ /**
+ * @param vocUuid
+ * @return
+ */
+ TermVocabularyDto findVocabularyDtoByVocabularyUuid(UUID vocUuid);
+
+}
BGBM BDI Projects / cdmlib.git / blobdiff