cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IDescriptionService.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.api.service;
  11
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16 import java.util.UUID;
  17
  18 import eu.etaxonomy.cdm.api.service.pager.Pager;
  19 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  20 import eu.etaxonomy.cdm.model.common.VersionableEntity;
  21 import eu.etaxonomy.cdm.model.description.DescriptionBase;
  22 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
  23 import eu.etaxonomy.cdm.model.description.Feature;
  24 import eu.etaxonomy.cdm.model.description.FeatureNode;
  25 import eu.etaxonomy.cdm.model.description.FeatureTree;
  26 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase;
  27 import eu.etaxonomy.cdm.model.description.Scope;
  28 import eu.etaxonomy.cdm.model.description.TaxonDescription;
  29 import eu.etaxonomy.cdm.model.description.TaxonNameDescription;
  30 import eu.etaxonomy.cdm.model.description.TextData;
  31 import eu.etaxonomy.cdm.model.location.NamedArea;
  32 import eu.etaxonomy.cdm.model.media.Media;
  33 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  34 import eu.etaxonomy.cdm.model.taxon.Taxon;
  35
  36 public interface IDescriptionService extends IIdentifiableEntityService<DescriptionBase> {
  37
  38         /**
  39          * @param uuid
  40          * @return
  41          */
  42         // FIXME candidate for harmonization? findByUuid
  43         public DescriptionBase getDescriptionBaseByUuid(UUID uuid);
  44
  45         /**
  46          * Persists a <code>Description</code>
  47           * @param description
  48          * @return
  49          */
  50         // FIXME candidate for harmonization? save
  51         public UUID saveDescription(DescriptionBase description);
  52
  53         /**
  54          * Persists a <code>FeatureTree</code>
  55          * @param tree
  56          * @return
  57          */
  58         public UUID saveFeatureTree(FeatureTree tree);
  59         // FIXME could you handle the feature data elements using @Cascade?
  60         public void saveFeatureDataAll(Collection<VersionableEntity> featureData);
  61         public Map<UUID, FeatureTree> saveFeatureTreeAll(Collection<FeatureTree> trees);
  62         public Map<UUID, FeatureNode> saveFeatureNodeAll(Collection<FeatureNode> nodes);
  63
  64         /**
  65          * Gets a FeatureTree instance matching the supplied uuid
  66          *
  67          * @param uuid the uuid of the FeatureTree of interest
  68          * @return a FeatureTree, or null if the FeatureTree does not exist
  69          */
  70         public FeatureTree getFeatureTreeByUuid(UUID uuid);
  71
  72         public List<FeatureTree> getFeatureTreesAll();
  73         public List<FeatureNode> getFeatureNodesAll();
  74
  75         public TermVocabulary<Feature> getDefaultFeatureVocabulary();
  76         //public TermVocabulary<Feature> getFeatureVocabulary();
  77         public TermVocabulary<Feature> getFeatureVocabulary(UUID uuid);
  78
  79         /**
  80          * Gets a DescriptionElementBase instance matching the supplied uuid
  81          *
  82          * @param uuid the uuid of the DescriptionElement of interest
  83          * @return a DescriptionElement, or null if the DescriptionElement does not exist
  84          */
  85         public DescriptionElementBase getDescriptionElementByUuid(UUID uuid);
  86
  87         /**
  88          * List the descriptions of type <TYPE>, filtered using the following parameters
  89          *
  90          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
  91          * @param hasMedia Restrict the description to those that do (true) or don't (false) contain <i>elements</i> that have one or more media (can be null)
  92          * @param hasText Restrict the description to those that do (true) or don't (false) contain TextData <i>elements</i> that have some textual content (can be null)
  93          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
  94          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
  95          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  96          * @return a Pager containing DescriptionBase instances
  97          */
  98         public <TYPE extends DescriptionBase> Pager<TYPE> listDescriptions(Class<TYPE> type, Boolean hasMedia, Boolean hasText, Set<Feature> feature, Integer pageSize, Integer pageNumber);
  99
 100         /**
 101          * Count the descriptions of type <TYPE>, filtered using the following parameters
 102          *
 103          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
 104          * @param hasMedia Restrict the description to those that do (true) or don't (false) contain <i>elements</i> that have one or more media (can be null)
 105          * @param hasText Restrict the description to those that do (true) or don't (false) contain TextData <i>elements</i> that have some textual content (can be null)
 106          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
 107          * @return a count of DescriptionBase instances
 108          */
 109         public <TYPE extends DescriptionBase> int countDescriptions(Class<TYPE> type, Boolean hasImages, Boolean hasText, Set<Feature> feature);
 110
 111         /**
 112          * Returns description elements of type <TYPE>, belonging to a given description, optionally filtered by one or more features
 113          *
 114          * @param description The description which these description elements belong to (can be null to count all description elements)
 115          * @param features Restrict the results to those description elements which are scoped by one of the Features passed (can be null or empty)
 116          * @param type The type of description
 117          * @param pageSize The maximum number of description elements returned (can be null for all description elements)
 118          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 119          * @return a Pager containing DescriptionElementBase instances
 120          */
 121         public <TYPE extends DescriptionElementBase> Pager<TYPE> getDescriptionElements(DescriptionBase description,Set<Feature> features, Class<TYPE> type, Integer pageSize, Integer pageNumber);
 122
 123         /**
 124          * Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
 125          *
 126          * @param taxon The taxon which the description refers to (can be null for all TaxonDescription instances)
 127          * @param scopes Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)
 128          * @param geographicalScope Restrict the results to those descriptions which have a geographical scope that overlaps with the NamedArea instances passed (can be null or empty)
 129          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 130          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 131          * @return a Pager containing TaxonDescription instances
 132          */
 133         public Pager<TaxonDescription> getTaxonDescriptions(Taxon taxon, Set<Scope> scopes, Set<NamedArea> geographicalScope, Integer pageSize, Integer pageNumber);
 134
 135         /**
 136          * Returns a List of TaxonNameDescription instances, optionally filtered by the name which they refer to
 137          *
 138          * @param name Restrict the results to those descriptions that refer to a specific name (can be null for all TaxonNameDescription instances)
 139          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 140          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 141          * @return a Pager containing TaxonNameBase instances
 142          */
 143         public Pager<TaxonNameDescription> getTaxonNameDescriptions(TaxonNameBase name, Integer pageSize, Integer pageNumber);
 144
 145         /**
 146          * Returns a List of distinct TaxonDescription instances which have Distribution elements that refer to one of the NamedArea instances passed (optionally
 147          * filtered by a type of PresenceAbsenceTerm e.g. PRESENT / ABSENT / NATIVE / CULTIVATED etc)
 148          *
 149          * @param namedAreas The set of NamedArea instances
 150          * @param presence Restrict the descriptions to those which have Distribution elements are of this status (can be null)
 151          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 152          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 153          * @return a Pager containing TaxonDescription instances
 154          */
 155         public Pager<TaxonDescription> searchDescriptionByDistribution(Set<NamedArea> namedAreas, PresenceAbsenceTermBase presence, Integer pageSize, Integer pageNumber);
 156
 157         /**
 158      * Returns a List of TextData elements that match a given queryString provided.
 159          *
 160          * @param queryString
 161          * @param pageSize
 162          * @param pageNumber
 163          * @return
 164          * @throws QueryParseException
 165          */
 166         public Pager<TextData> searchTextData(String queryString, Integer pageSize, Integer pageNumber);
 167
 168         /**
 169      * Returns a List of Media that are associated with a given description element
 170      *
 171          * @param descriptionElement the description element associated with these media
 172          * @param pageSize The maximum number of media returned (can be null for all related media)
 173          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 174      * @return a Pager containing media instances
 175      */
 176     public Pager<Media> getMedia(DescriptionElementBase descriptionElement, Integer pageSize, Integer pageNumber);
 177
 178 }