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         public DescriptionBase getDescriptionBaseByUuid(UUID uuid);
  43
  44         /**
  45          * Persists a <code>Description</code>
  46           * @param description
  47          * @return
  48          */
  49         public UUID saveDescription(DescriptionBase description);
  50
  51         /**
  52          * Persists a <code>FeatureTree</code>
  53          * @param tree
  54          * @return
  55          */
  56         public UUID saveFeatureTree(FeatureTree tree);
  57         // FIXME could you handle the feature data elements using @Cascade?
  58         public void saveFeatureDataAll(Collection<VersionableEntity> featureData);
  59         public Map<UUID, FeatureTree> saveFeatureTreeAll(Collection<FeatureTree> trees);
  60         public Map<UUID, FeatureNode> saveFeatureNodeAll(Collection<FeatureNode> nodes);
  61
  62         public List<FeatureTree> getFeatureTreesAll();
  63         public List<FeatureNode> getFeatureNodesAll();
  64
  65         public TermVocabulary<Feature> getDefaultFeatureVocabulary();
  66         //public TermVocabulary<Feature> getFeatureVocabulary();
  67         public TermVocabulary<Feature> getFeatureVocabulary(UUID uuid);
  68
  69         /**
  70          * List the descriptions of type <TYPE>, filtered using the following parameters
  71          *
  72          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
  73          * @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)
  74          * @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)
  75          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
  76          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
  77          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  78          * @return a Pager containing DescriptionBase instances
  79          */
  80         public <TYPE extends DescriptionBase> Pager<TYPE> listDescriptions(Class<TYPE> type, Boolean hasMedia, Boolean hasText, Set<Feature> feature, Integer pageSize, Integer pageNumber);
  81
  82         /**
  83          * Count the descriptions of type <TYPE>, filtered using the following parameters
  84          *
  85          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
  86          * @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)
  87          * @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)
  88          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
  89          * @return a count of DescriptionBase instances
  90          */
  91         public <TYPE extends DescriptionBase> int countDescriptions(Class<TYPE> type, Boolean hasImages, Boolean hasText, Set<Feature> feature);
  92
  93         /**
  94          * Returns description elements of type <TYPE>, belonging to a given description, optionally filtered by one or more features
  95          *
  96          * @param description The description which these description elements belong to (can be null to count all description elements)
  97          * @param features Restrict the results to those description elements which are scoped by one of the Features passed (can be null or empty)
  98          * @param type The type of description
  99          * @param pageSize The maximum number of description elements returned (can be null for all description elements)
 100          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 101          * @return a Pager containing DescriptionElementBase instances
 102          */
 103         public <TYPE extends DescriptionElementBase> Pager<TYPE> getDescriptionElements(DescriptionBase description,Set<Feature> features, Class<TYPE> type, Integer pageSize, Integer pageNumber);
 104
 105         /**
 106          * Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
 107          *
 108          * @param taxon The taxon which the description refers to (can be null for all TaxonDescription instances)
 109          * @param scopes Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)
 110          * @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)
 111          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 112          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 113          * @return a Pager containing TaxonDescription instances
 114          */
 115         public Pager<TaxonDescription> getTaxonDescriptions(Taxon taxon, Set<Scope> scopes, Set<NamedArea> geographicalScope, Integer pageSize, Integer pageNumber);
 116
 117         /**
 118          * Returns a List of TaxonNameDescription instances, optionally filtered by the name which they refer to
 119          *
 120          * @param name Restrict the results to those descriptions that refer to a specific name (can be null for all TaxonNameDescription instances)
 121          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 122          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 123          * @return a Pager containing TaxonNameBase instances
 124          */
 125         public Pager<TaxonNameDescription> getTaxonNameDescriptions(TaxonNameBase name, Integer pageSize, Integer pageNumber);
 126
 127         /**
 128          * Returns a List of distinct TaxonDescription instances which have Distribution elements that refer to one of the NamedArea instances passed (optionally
 129          * filtered by a type of PresenceAbsenceTerm e.g. PRESENT / ABSENT / NATIVE / CULTIVATED etc)
 130          *
 131          * @param namedAreas The set of NamedArea instances
 132          * @param presence Restrict the descriptions to those which have Distribution elements are of this status (can be null)
 133          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 134          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 135          * @return a Pager containing TaxonDescription instances
 136          */
 137         public Pager<TaxonDescription> searchDescriptionByDistribution(Set<NamedArea> namedAreas, PresenceAbsenceTermBase presence, Integer pageSize, Integer pageNumber);
 138
 139         /**
 140      * Returns a List of TextData elements that match a given queryString provided.
 141          *
 142          * @param queryString
 143          * @param pageSize
 144          * @param pageNumber
 145          * @return
 146          * @throws QueryParseException
 147          */
 148         public Pager<TextData> searchTextData(String queryString, Integer pageSize, Integer pageNumber);
 149
 150         /**
 151      * Returns a List of Media that are associated with a given description element
 152      *
 153          * @param descriptionElement the description element associated with these media
 154          * @param pageSize The maximum number of media returned (can be null for all related media)
 155          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 156      * @return a Pager containing media instances
 157      */
 158     public Pager<Media> getMedia(DescriptionElementBase descriptionElement, Integer pageSize, Integer pageNumber);
 159
 160 }