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

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.cdm.api.service;
  12
  13 import java.util.Collection;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.UUID;
  18
  19 import eu.etaxonomy.cdm.api.service.pager.Pager;
  20 import eu.etaxonomy.cdm.model.common.Annotation;
  21 import eu.etaxonomy.cdm.model.common.Language;
  22 import eu.etaxonomy.cdm.model.common.MarkerType;
  23 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  24 import eu.etaxonomy.cdm.model.description.DescriptionBase;
  25 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
  26 import eu.etaxonomy.cdm.model.description.Feature;
  27 import eu.etaxonomy.cdm.model.description.FeatureTree;
  28 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase;
  29 import eu.etaxonomy.cdm.model.description.Scope;
  30 import eu.etaxonomy.cdm.model.description.TaxonDescription;
  31 import eu.etaxonomy.cdm.model.description.TaxonNameDescription;
  32 import eu.etaxonomy.cdm.model.location.NamedArea;
  33 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
  34 import eu.etaxonomy.cdm.model.media.Media;
  35 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  36 import eu.etaxonomy.cdm.model.taxon.Taxon;
  37 import eu.etaxonomy.cdm.persistence.dao.BeanInitializer;
  38 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  39
  40 public interface IDescriptionService extends IIdentifiableEntityService<DescriptionBase> {
  41
  42         /**
  43          *
  44          * @return
  45          * @deprecated use TermService#getVocabulary(VocabularyType) instead
  46          */
  47         public TermVocabulary<Feature> getDefaultFeatureVocabulary();
  48
  49         /**
  50          * @deprecated use TermService#getVocabulary(VocabularyType) instead
  51          */
  52         public TermVocabulary<Feature> getFeatureVocabulary(UUID uuid);
  53
  54         /**
  55          * Gets a DescriptionElementBase instance matching the supplied uuid
  56          *
  57          * @param uuid the uuid of the DescriptionElement of interest
  58          * @return a DescriptionElement, or null if the DescriptionElement does not exist
  59          */
  60         public DescriptionElementBase getDescriptionElementByUuid(UUID uuid);
  61
  62         /**
  63          * Loads and existing DescriptionElementBase instance matching the supplied uuid,
  64          * and recursively initializes all bean properties given in the
  65          * <code>propertyPaths</code> parameter.
  66          * <p>
  67          * For detailed description and examples <b>please refer to:</b>
  68          * {@link BeanInitializer#initialize(Object, List)}
  69          *
  70          * @param uuid the uuid of the DescriptionElement of interest
  71          * @return a DescriptionElement, or null if the DescriptionElement does not exist
  72          */
  73         public DescriptionElementBase loadDescriptionElement(UUID uuid,List<String> propertyPaths);
  74
  75         /**
  76          * Persists a <code>DescriptionElementBase</code>
  77          * @param descriptionElement
  78          * @return
  79          */
  80         public UUID saveDescriptionElement(DescriptionElementBase descriptionElement);
  81
  82         /**
  83          * Persists a collection of <code>DescriptionElementBase</code>
  84          * @param descriptionElements
  85          * @return
  86          */
  87         public Map<UUID, DescriptionElementBase> saveDescriptionElement(Collection<DescriptionElementBase> descriptionElements);
  88
  89         /**
  90          * Delete an existing description element
  91          *
  92          * @param descriptionElement the description element to be deleted
  93          * @return the unique identifier of the deleted entity
  94          */
  95         public UUID deleteDescriptionElement(DescriptionElementBase descriptionElement);
  96
  97         /**
  98          * List the descriptions of type <T>, filtered using the following parameters
  99          *
 100          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
 101          * @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)
 102          * @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)
 103          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
 104          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 105          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 106          * @param orderHints may be null
 107          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
 108          * @return a Pager containing DescriptionBase instances
 109          */
 110         public Pager<DescriptionBase> page(Class<? extends DescriptionBase> type, Boolean hasMedia, Boolean hasText, Set<Feature> feature, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
 111
 112         /**
 113          * Count the descriptions of type <TYPE>, filtered using the following parameters
 114          *
 115          * @param type The type of description returned (Taxon, TaxonName, or Specimen)
 116          * @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)
 117          * @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)
 118          * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
 119          * @return a count of DescriptionBase instances
 120          */
 121         public int count(Class<? extends DescriptionBase> type, Boolean hasImages, Boolean hasText, Set<Feature> feature);
 122
 123         /**
 124          * Returns description elements of type <TYPE>, belonging to a given description, optionally filtered by one or more features
 125          *
 126          * @param description The description which these description elements belong to (can be null to count all description elements)
 127          * @param features Restrict the results to those description elements which are scoped by one of the Features passed (can be null or empty)
 128          * @param type The type of description
 129          * @param class
 130          * @param pageSize The maximum number of description elements returned (can be null for all description elements)
 131          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 132          * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link BeanInitializer#initialize(Object, List)}
 133          * @return a Pager containing DescriptionElementBase instances
 134          */
 135         public Pager<DescriptionElementBase> getDescriptionElements(DescriptionBase description,Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 136
 137         /**
 138          * Returns description elements of type <TYPE>, belonging to a given description, optionally filtered by one or more features
 139          *
 140          * @param description The description which these description elements belong to (can be null to count all description elements)
 141          * @param features Restrict the results to those description elements which are scoped by one of the Features passed (can be null or empty)
 142          * @param type The type of description
 143          * @param class
 144          * @param pageSize The maximum number of description elements returned (can be null for all description elements)
 145          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 146          * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link BeanInitializer#initialize(Object, List)}
 147          * @return a List containing DescriptionElementBase instances
 148          */
 149         public List<DescriptionElementBase> listDescriptionElements(DescriptionBase description,Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 150
 151         /**
 152          * Return a Pager containing Annotation entities belonging to the DescriptionElementBase instance supplied, optionally filtered by MarkerType
 153      * @param annotatedObj The object that "owns" the annotations returned
 154          * @param status Only return annotations which are marked with a Marker of this type (can be null to return all annotations)
 155          * @param pageSize The maximum number of terms returned (can be null for all annotations)
 156          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 157          * @param orderHints may be null
 158          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
 159          * @return a Pager of Annotation entities
 160          */
 161         public Pager<Annotation> getDescriptionElementAnnotations(DescriptionElementBase annotatedObj, MarkerType status, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
 162
 163
 164         /**
 165          * Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
 166          *
 167          * @param taxon The taxon which the description refers to (can be null for all TaxonDescription instances)
 168          * @param scopes Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)
 169          * @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)
 170          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 171          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 172          * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link BeanInitializer#initialize(Object, List)}
 173          * @return a Pager containing TaxonDescription instances
 174          */
 175         public Pager<TaxonDescription> getTaxonDescriptions(Taxon taxon, Set<Scope> scopes, Set<NamedArea> geographicalScope, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 176
 177         /**
 178          * Returns a List of TaxonNameDescription instances, optionally filtered by the name which they refer to
 179          *
 180          * @param name Restrict the results to those descriptions that refer to a specific name (can be null for all TaxonNameDescription instances)
 181          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 182          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 183          * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link BeanInitializer#initialize(Object, List)}
 184          * @return a Pager containing TaxonNameBase instances
 185          */
 186         public Pager<TaxonNameDescription> getTaxonNameDescriptions(TaxonNameBase name, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 187
 188         /**
 189          * Returns a List of distinct TaxonDescription instances which have Distribution elements that refer to one of the NamedArea instances passed (optionally
 190          * filtered by a type of PresenceAbsenceTerm e.g. PRESENT / ABSENT / NATIVE / CULTIVATED etc)
 191          *
 192          * @param namedAreas The set of NamedArea instances
 193          * @param presence Restrict the descriptions to those which have Distribution elements are of this status (can be null)
 194          * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
 195          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 196          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 197          * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link BeanInitializer#initialize(Object, List)}
 198          * @return a Pager containing TaxonDescription instances
 199          */
 200         public Pager<TaxonDescription> searchDescriptionByDistribution(Set<NamedArea> namedAreas, PresenceAbsenceTermBase presence, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
 201
 202         /**
 203          * Returns a Paged List of DescriptionElementBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
 204          *
 205          * @param clazz filter the results by class (or pass null to return all DescriptionElementBase instances)
 206          * @param queryString
 207          * @param pageSize The maximum number of descriptionElements returned (can be null for all matching descriptionElements)
 208          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 209          * @param orderHints
 210          *            Supports path like <code>orderHints.propertyNames</code> which
 211          *            include *-to-one properties like createdBy.username or
 212          *            authorTeam.persistentTitleCache
 213          * @param propertyPaths properties to be initialized
 214          * @return a Pager DescriptionElementBase instances
 215          * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
 216          */
 217         public Pager<DescriptionElementBase> searchElements(Class<? extends DescriptionElementBase> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
 218
 219         /**
 220      * Returns a List of Media that are associated with a given description element
 221      *
 222          * @param descriptionElement the description element associated with these media
 223          * @param pageSize The maximum number of media returned (can be null for all related media)
 224          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
 225          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
 226      * @return a Pager containing media instances
 227      */
 228     public Pager<Media> getMedia(DescriptionElementBase descriptionElement, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 229
 230     public List<DescriptionElementBase> getDescriptionElementsForTaxon(Taxon taxon, Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
 231
 232         public DistributionTree getOrderedDistributions(Set<TaxonDescription> taxonDescriptions, Set<NamedAreaLevel> levels, List<String> propertyPaths);
 233
 234         /**
 235           * Generate a string representation of the structured <code>description</code> supplied in natural language
 236           * The <code>featureTree</code> will be used to structure the NaturalLanguageDescription.
 237           * This method does not require a initialization strategy so there is no <code>propertyPaths</code> parameter.
 238           * @param featureTree
 239           * @param description
 240           * @param preferredLanguages
 241           * @param separator
 242           * @return
 243           */
 244         public String generateNaturalLanguageDescription(FeatureTree featureTree,TaxonDescription description, List<Language> preferredLanguages, String separator);
 245
 246         /**
 247          * Preliminary method to test whether a description contains structured data.
 248          * @deprecated The means of determining this fact may change soon, so this method is annotated a beeing deprecated.
 249          * @param description
 250          * @return
 251          */
 252         @Deprecated
 253         public boolean hasStructuredData(DescriptionBase<?> description);
 254 }