Revision 892efc69
Added by Andreas Kohlbecker almost 14 years ago
| cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IDescriptionService.java | ||
|---|---|---|
| 17 | 17 |
import java.util.UUID; |
| 18 | 18 |
|
| 19 | 19 |
import eu.etaxonomy.cdm.api.service.pager.Pager; |
| 20 |
import eu.etaxonomy.cdm.model.common.Annotation; |
|
| 21 |
import eu.etaxonomy.cdm.model.common.MarkerType; |
|
| 20 | 22 |
import eu.etaxonomy.cdm.model.common.TermVocabulary; |
| 21 | 23 |
import eu.etaxonomy.cdm.model.common.VersionableEntity; |
| 22 | 24 |
import eu.etaxonomy.cdm.model.description.DescriptionBase; |
| 23 | 25 |
import eu.etaxonomy.cdm.model.description.DescriptionElementBase; |
| 26 |
import eu.etaxonomy.cdm.model.description.Distribution; |
|
| 24 | 27 |
import eu.etaxonomy.cdm.model.description.Feature; |
| 25 | 28 |
import eu.etaxonomy.cdm.model.description.FeatureNode; |
| 26 | 29 |
import eu.etaxonomy.cdm.model.description.FeatureTree; |
| ... | ... | |
| 29 | 32 |
import eu.etaxonomy.cdm.model.description.TaxonDescription; |
| 30 | 33 |
import eu.etaxonomy.cdm.model.description.TaxonNameDescription; |
| 31 | 34 |
import eu.etaxonomy.cdm.model.location.NamedArea; |
| 35 |
import eu.etaxonomy.cdm.model.location.NamedAreaLevel; |
|
| 32 | 36 |
import eu.etaxonomy.cdm.model.media.Media; |
| 33 | 37 |
import eu.etaxonomy.cdm.model.name.TaxonNameBase; |
| 34 | 38 |
import eu.etaxonomy.cdm.model.taxon.Taxon; |
| ... | ... | |
| 77 | 81 |
*/ |
| 78 | 82 |
public UUID saveDescriptionElement(DescriptionElementBase descriptionElement); |
| 79 | 83 |
|
| 84 |
/** |
|
| 85 |
* Persists a collection of <code>DescriptionElementBase</code> |
|
| 86 |
* @param descriptionElements |
|
| 87 |
* @return |
|
| 88 |
*/ |
|
| 89 |
public Map<UUID, DescriptionElementBase> saveDescriptionElement(Collection<DescriptionElementBase> descriptionElements); |
|
| 90 |
|
|
| 80 | 91 |
/** |
| 81 | 92 |
* Delete an existing description element |
| 82 | 93 |
* |
| ... | ... | |
| 125 | 136 |
*/ |
| 126 | 137 |
public Pager<DescriptionElementBase> getDescriptionElements(DescriptionBase description,Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths); |
| 127 | 138 |
|
| 139 |
/** |
|
| 140 |
* |
|
| 141 |
* @param taxonDescriptions |
|
| 142 |
* @param omitLevels |
|
| 143 |
* @return |
|
| 144 |
*/ |
|
| 145 |
public NamedAreaTree getOrderedDistributions(Set<TaxonDescription> taxonDescriptions, |
|
| 146 |
Set<NamedAreaLevel> omitLevels); |
|
| 147 |
|
|
| 148 |
|
|
| 128 | 149 |
/** |
| 129 | 150 |
* Returns description elements of type <TYPE>, belonging to a given description, optionally filtered by one or more features |
| 130 | 151 |
* |
| ... | ... | |
| 139 | 160 |
*/ |
| 140 | 161 |
public List<DescriptionElementBase> listDescriptionElements(DescriptionBase description,Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths); |
| 141 | 162 |
|
| 163 |
/** |
|
| 164 |
* Return a Pager containing Annotation entities belonging to the DescriptionElementBase instance supplied, optionally filtered by MarkerType |
|
| 165 |
* @param annotatedObj The object that "owns" the annotations returned |
|
| 166 |
* @param status Only return annotations which are marked with a Marker of this type (can be null to return all annotations) |
|
| 167 |
* @param pageSize The maximum number of terms returned (can be null for all annotations) |
|
| 168 |
* @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based) |
|
| 169 |
* @param orderHints may be null |
|
| 170 |
* @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
|
|
| 171 |
* @return a Pager of Annotation entities |
|
| 172 |
*/ |
|
| 173 |
public Pager<Annotation> getDescriptionElementAnnotations(DescriptionElementBase annotatedObj, MarkerType status, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths); |
|
| 174 |
|
|
| 175 |
|
|
| 142 | 176 |
/** |
| 143 | 177 |
* Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method |
| 144 | 178 |
* |
| ... | ... | |
| 204 | 238 |
* @return a Pager containing media instances |
| 205 | 239 |
*/ |
| 206 | 240 |
public Pager<Media> getMedia(DescriptionElementBase descriptionElement, Integer pageSize, Integer pageNumber, List<String> propertyPaths); |
| 241 |
|
|
| 242 |
public List<DescriptionElementBase> getDescriptionElementsForTaxon(Taxon taxon, Set<Feature> features, Class<? extends DescriptionElementBase> type, Integer pageSize, Integer pageNumber, List<String> propertyPaths); |
|
| 243 |
|
|
| 207 | 244 |
} |
Also available in: Unified diff
merging /branches/cdmlib/SPRINT-Chichorieae1/ to trunk