From ed8f7a1cd33d1aa4156a5df5ed265fdea9d786b4 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Andreas=20M=C3=BCller?= Date: Sat, 21 Jan 2023 00:20:57 +0100 Subject: [PATCH 1/1] minor --- .../dao/reference/IReferenceDao.java | 314 +++++++++--------- 1 file changed, 157 insertions(+), 157 deletions(-) diff --git a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/reference/IReferenceDao.java b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/reference/IReferenceDao.java index 420a7e91ac..8c470be44e 100644 --- a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/reference/IReferenceDao.java +++ b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/reference/IReferenceDao.java @@ -1,157 +1,157 @@ -/** -* Copyright (C) 2007 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.persistence.dao.reference; - -import java.util.List; -import java.util.Set; -import java.util.UUID; - -import org.hibernate.criterion.Criterion; - -import eu.etaxonomy.cdm.model.reference.Reference; -import eu.etaxonomy.cdm.model.reference.ReferenceType; -import eu.etaxonomy.cdm.model.taxon.TaxonBase; -import eu.etaxonomy.cdm.model.term.DefinedTermBase; -import eu.etaxonomy.cdm.persistence.dao.common.IIdentifiableDao; -import eu.etaxonomy.cdm.persistence.dao.common.ITitledDao; -import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache; -import eu.etaxonomy.cdm.persistence.query.MatchMode; -import eu.etaxonomy.cdm.persistence.query.OrderHint; - -/** - * @author a.mueller - */ -public interface IReferenceDao extends IIdentifiableDao, ITitledDao { - - public List> getUuidAndTitle(); - - /** - * TODO candidate for harmonization: rename to listAllReferencesForPublishing - * @return all references marked with publish-flag - */ - public List getAllReferencesForPublishing(); - - /** - * TODO candidate for harmonization: rename to listAllNotNomenclaturalReferencesForPublishing - * @return all references not used as nomenclatural reference with publish flag - */ - public List getAllNotNomenclaturalReferencesForPublishing(); - - /** - * TODO candidate for harmonization: rename to listNomenclaturalReferences - * @return - */ - public List getAllNomenclaturalReferences(); - - /** - * recursively finds all references where the referenceBase given as parameter - * is the {@link Reference.getInReference inReference}. - * @param reference - * @return - */ - public List getSubordinateReferences(Reference reference); - - /** - * searches for taxa using the following relations: - *
    - *
  • taxon.name.nomenclaturalSource.citation
    • - *
  • taxon.descriptions.descriptionElement.sources.citation
    • - *
  • taxon.descriptions.descriptionSources
    • - *
  • taxon.name.descriptions.descriptionElement.sources
    • - *
  • taxon.name.descriptions.descriptionSources
    • - *
- * - * @param reference - * @param orderHints TODO - * @param propertyPaths TODO - * @return - */ - public List listCoveredTaxa(Reference reference, boolean includeSubordinateReferences, List orderHints, List propertyPaths); - - /** - * @param limit - * @param pattern - * @param refType - * @return - */ - List> getUuidAndAbbrevTitleCache(Integer limit, String pattern, ReferenceType refType); - - /** - * @param limit - * @param pattern - * @param refType - * @return - */ - List> getUuidAndTitleCache(Integer limit, String pattern, ReferenceType refType); - - /** - * @param identifier - * @param identifierType - * @param matchmode - * @param limit - * @return - */ - List findByIdentifierAbbrev(String identifier, DefinedTermBase identifierType, MatchMode matchmode, - Integer limit); - - /** - * @param limit - * @param pattern - * @param refType - * @return - */ - List> getUuidAndAbbrevTitleCacheForAuthor(Integer limit, String pattern, - ReferenceType refType); - - /** - * @param uuids - * @return - */ - List> getUuidAndTitle(Set uuids); - - /** - * @param uuids - * @param refType - * @return - */ - List> getUuidAndTitle(Set uuids, ReferenceType refType); - - /** - * @param clazz - * @param queryString - * @param matchmode - * @param criterion - * @param pageSize - * @param pageNumber - * @param orderHints - * @param propertyPaths - * @return - */ - List findByTitleAndAbbrevTitle(Class clazz, String queryString, MatchMode matchmode, - List criterion, Integer pageSize, Integer pageNumber, List orderHints, - List propertyPaths); - - List> getUuidAndAbbrevTitleCacheForAuthorID(Integer limit, Integer authorID, - ReferenceType refType); - - /** - * @param uuids - * @param refType - * @return - */ - List> getUuidAndAbbrevTitle(Set uuids, ReferenceType refType); - - /** - * @param uuids - * @return - */ - List> getUuidAndAbbrevTitle(Set uuids); - - -} +/** +* Copyright (C) 2007 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.persistence.dao.reference; + +import java.util.List; +import java.util.Set; +import java.util.UUID; + +import org.hibernate.criterion.Criterion; + +import eu.etaxonomy.cdm.model.reference.Reference; +import eu.etaxonomy.cdm.model.reference.ReferenceType; +import eu.etaxonomy.cdm.model.taxon.TaxonBase; +import eu.etaxonomy.cdm.model.term.DefinedTermBase; +import eu.etaxonomy.cdm.persistence.dao.common.IIdentifiableDao; +import eu.etaxonomy.cdm.persistence.dao.common.ITitledDao; +import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache; +import eu.etaxonomy.cdm.persistence.query.MatchMode; +import eu.etaxonomy.cdm.persistence.query.OrderHint; + +/** + * @author a.mueller + */ +public interface IReferenceDao extends IIdentifiableDao, ITitledDao { + + public List> getUuidAndTitle(); + + /** + * TODO candidate for harmonization: rename to listAllReferencesForPublishing + * @return all references marked with publish-flag + */ + public List getAllReferencesForPublishing(); + + /** + * TODO candidate for harmonization: rename to listAllNotNomenclaturalReferencesForPublishing + * @return all references not used as nomenclatural reference with publish flag + */ + public List getAllNotNomenclaturalReferencesForPublishing(); + + /** + * TODO candidate for harmonization: rename to listNomenclaturalReferences + * @return + */ + public List getAllNomenclaturalReferences(); + + /** + * recursively finds all references where the referenceBase given as parameter + * is the {@link Reference.getInReference inReference}. + * @param reference + * @return + */ + public List getSubordinateReferences(Reference reference); + + /** + * searches for taxa using the following relations: + *
    + *
  • taxon.name.nomenclaturalSource.citation
    • + *
  • taxon.descriptions.descriptionElement.sources.citation
    • + *
  • taxon.descriptions.descriptionSources
    • + *
  • taxon.name.descriptions.descriptionElement.sources
    • + *
  • taxon.name.descriptions.descriptionSources
    • + *
+ * + * @param reference + * @param orderHints TODO + * @param propertyPaths TODO + * @return + */ + public List listCoveredTaxa(Reference reference, boolean includeSubordinateReferences, List orderHints, List propertyPaths); + + /** + * @param limit + * @param pattern + * @param refType + * @return + */ + List> getUuidAndAbbrevTitleCache(Integer limit, String pattern, ReferenceType refType); + + /** + * @param limit + * @param pattern + * @param refType + * @return + */ + List> getUuidAndTitleCache(Integer limit, String pattern, ReferenceType refType); + + /** + * @param identifier + * @param identifierType + * @param matchmode + * @param limit + * @return + */ + List findByIdentifierAbbrev(String identifier, DefinedTermBase identifierType, MatchMode matchmode, + Integer limit); + + /** + * @param limit + * @param pattern + * @param refType + * @return + */ + List> getUuidAndAbbrevTitleCacheForAuthor(Integer limit, String pattern, + ReferenceType refType); + + /** + * @param uuids + * @return + */ + List> getUuidAndTitle(Set uuids); + + /** + * @param uuids + * @param refType + * @return + */ + List> getUuidAndTitle(Set uuids, ReferenceType refType); + + /** + * @param clazz + * @param queryString + * @param matchmode + * @param criterion + * @param pageSize + * @param pageNumber + * @param orderHints + * @param propertyPaths + * @return + */ + List findByTitleAndAbbrevTitle(Class clazz, String queryString, MatchMode matchmode, + List criterion, Integer pageSize, Integer pageNumber, List orderHints, + List propertyPaths); + + List> getUuidAndAbbrevTitleCacheForAuthorID(Integer limit, Integer authorID, + ReferenceType refType); + + /** + * @param uuids + * @param refType + * @return + */ + List> getUuidAndAbbrevTitle(Set uuids, ReferenceType refType); + + /** + * @param uuids + * @return + */ + List> getUuidAndAbbrevTitle(Set uuids); + + +} -- 2.34.1