public interface IDescriptionService extends IIdentifiableEntityService<DescriptionBase>
Modifier and Type | Method and Description |
---|---|
long |
count(java.lang.Class<? extends DescriptionBase> type,
java.lang.Boolean hasImages,
java.lang.Boolean hasText,
java.util.Set<Feature> feature)
Count the descriptions of type
|
int |
countTaxonDescriptionMedia(java.util.UUID taxonUuid,
boolean limitToGalleries,
java.util.Set<MarkerType> markerTypes)
Returns count for all
Media attached to a taxon via TaxonDescription.elements.media. |
DeleteResult |
deleteDescription(DescriptionBase description) |
DeleteResult |
deleteDescription(java.util.UUID descriptionUuid) |
java.util.UUID |
deleteDescriptionElement(DescriptionElementBase descriptionElement)
Delete an existing description element
|
java.util.UUID |
deleteDescriptionElement(java.util.UUID descriptionElementUuid) |
java.lang.String |
generateNaturalLanguageDescription(TermTree featureTree,
TaxonDescription description,
java.util.List<Language> preferredLanguages,
java.lang.String separator)
Generate a string representation of the structured
description supplied in natural language
The featureTree will be used to structure the NaturalLanguageDescription. |
TermVocabulary<Feature> |
getDefaultFeatureVocabulary()
Deprecated.
use TermService#getVocabulary(VocabularyType) instead
|
Pager<Annotation> |
getDescriptionElementAnnotations(DescriptionElementBase annotatedObj,
MarkerType status,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<OrderHint> orderHints,
java.util.List<java.lang.String> propertyPaths)
Return a Pager containing Annotation entities belonging to the DescriptionElementBase instance supplied, optionally filtered by MarkerType
|
DescriptionElementBase |
getDescriptionElementByUuid(java.util.UUID uuid)
Gets a DescriptionElementBase instance matching the supplied uuid
|
<T extends DescriptionElementBase> |
getDescriptionElements(DescriptionBase description,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
use
#pageDescriptionElements(DescriptionBase, Set, Class, Integer, Integer, List)
instead |
<T extends DescriptionElementBase> |
getDescriptionElementsForTaxon(Taxon taxon,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
|
TermVocabulary<Feature> |
getFeatureVocabulary(java.util.UUID uuid)
Deprecated.
use TermService#getVocabulary(VocabularyType) instead
|
Pager<Media> |
getMedia(DescriptionElementBase descriptionElement,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns a List of Media that are associated with a given description element
|
DistributionTree |
getOrderedDistributions(java.util.Set<TaxonDescription> taxonDescriptions,
boolean subAreaPreference,
boolean statusOrderPreference,
java.util.Set<MarkerType> hideMarkedAreas,
java.util.Set<NamedAreaLevel> omitLevels,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
use
IEditGeoService#composeDistributionInfoFor() instead |
Pager<TaxonNameDescription> |
getTaxonNameDescriptions(TaxonName name,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns a List of TaxonNameDescription instances, optionally filtered by the name which they refer to
|
boolean |
hasStructuredData(DescriptionBase<?> description)
Deprecated.
The means of determining this fact may change soon, so this method is
annotated as being deprecated.
|
DeleteResult |
isDeletable(java.util.UUID descriptionUuid) |
<T extends DescriptionElementBase> |
listDescriptionElements(DescriptionBase description,
java.lang.Class<? extends DescriptionBase> descriptionType,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns description elements of type
|
<T extends DescriptionElementBase> |
listDescriptionElements(DescriptionBase description,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
|
<T extends DescriptionElementBase> |
listDescriptionElementsForTaxon(Taxon taxon,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Provides access to all DescriptionElements associated with the given Taxon
via a TaxonDescrition.
|
java.util.List<Media> |
listTaxonDescriptionMedia(java.util.UUID taxonUuid,
boolean limitToGalleries,
java.util.Set<MarkerType> markerTypes,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns all
Media attached to a taxon via TaxonDescription.elements.media. |
java.util.List<TaxonDescription> |
listTaxonDescriptions(Taxon taxon,
java.util.Set<DefinedTerm> scopes,
java.util.Set<NamedArea> geographicalScope,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonDescription> |
listTaxonDescriptions(Taxon taxon,
java.util.Set<DefinedTerm> scopes,
java.util.Set<NamedArea> geographicalScope,
java.util.Set<MarkerType> markerTypes,
java.util.Set<DescriptionType> descriptionTypes,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths) |
DescriptionElementBase |
loadDescriptionElement(java.util.UUID uuid,
java.util.List<java.lang.String> propertyPaths)
Loads and existing DescriptionElementBase instance matching the supplied uuid,
and recursively initializes all bean properties given in the
propertyPaths parameter. |
java.util.List<MergeResult<DescriptionBase>> |
mergeDescriptionElements(java.util.Collection<TaxonDistributionDTO> descriptionElements,
boolean returnTransientEntity) |
UpdateResult |
moveDescriptionElementsToDescription(java.util.Collection<DescriptionElementBase> descriptionElements,
DescriptionBase targetDescription,
boolean isPaste,
boolean setNameInSource)
Add the collection of
description elements to the targetDescription . |
UpdateResult |
moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs,
DescriptionBase targetDescription,
boolean isCopy,
boolean setNameInSource) |
UpdateResult |
moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs,
java.util.UUID targetDescriptionUuid,
boolean isCopy,
boolean setNameInSource) |
UpdateResult |
moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs,
java.util.UUID targetTaxonUuid,
java.lang.String moveMessage,
boolean isCopy,
boolean setNameInSource) |
UpdateResult |
moveTaxonDescription(java.util.UUID descriptionUuid,
java.util.UUID targetTaxonUuid,
boolean setNameInSource) |
UpdateResult |
moveTaxonDescriptions(Taxon sourceTaxon,
Taxon targetTaxon,
boolean setNameInSource) |
UpdateResult |
moveTaxonDescriptions(java.util.UUID sourceTaxonUuid,
java.util.UUID targetTaxonUuid,
boolean setNameInSource) |
Pager<DescriptionBase> |
page(java.lang.Class<? extends DescriptionBase> type,
java.lang.Boolean hasMedia,
java.lang.Boolean hasText,
java.util.Set<Feature> feature,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<OrderHint> orderHints,
java.util.List<java.lang.String> propertyPaths)
List the descriptions of type
|
<T extends DescriptionElementBase> |
pageDescriptionElements(DescriptionBase description,
java.lang.Class<? extends DescriptionBase> descriptionType,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns description elements of type
|
<T extends DescriptionElementBase> |
pageDescriptionElementsForTaxon(Taxon taxon,
java.util.Set<Feature> features,
java.lang.Class<T> type,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Provides access to all DescriptionElements associated with the given Taxon
via a TaxonDescrition.
|
Pager<TermDto> |
pageNamedAreasInUse(boolean includeAllParents,
java.lang.Integer pageSize,
java.lang.Integer pageNumber)
Pager method to get all
NamedAreas instances which are currently used
by Distribution elements. |
Pager<TaxonDescription> |
pageTaxonDescriptions(Taxon taxon,
java.util.Set<DefinedTerm> scopes,
java.util.Set<NamedArea> geographicalScope,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
|
Pager<TaxonDescription> |
pageTaxonDescriptions(Taxon taxon,
java.util.Set<DefinedTerm> scopes,
java.util.Set<NamedArea> geographicalScope,
java.util.Set<MarkerType> markerTypes,
java.util.Set<DescriptionType> descriptionTypes,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<java.lang.String> propertyPaths)
Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
|
java.util.Map<java.util.UUID,DescriptionElementBase> |
saveDescriptionElement(java.util.Collection<DescriptionElementBase> descriptionElements)
Persists a collection of
DescriptionElementBase |
java.util.UUID |
saveDescriptionElement(DescriptionElementBase descriptionElement)
Persists a
DescriptionElementBase |
Pager<TaxonDescription> |
searchDescriptionByDistribution(java.util.Set<NamedArea> namedAreas,
PresenceAbsenceTerm presence,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<OrderHint> orderHints,
java.util.List<java.lang.String> propertyPaths)
Returns a List of distinct TaxonDescription instances which have Distribution elements that refer to one of the NamedArea instances passed (optionally
filtered by a type of PresenceAbsenceTerm e.g.
|
<S extends DescriptionElementBase> |
searchElements(java.lang.Class<S> clazz,
java.lang.String queryString,
java.lang.Integer pageSize,
java.lang.Integer pageNumber,
java.util.List<OrderHint> orderHints,
java.util.List<java.lang.String> propertyPaths)
Returns a Paged List of DescriptionElementBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
|
countByTitle, countByTitle, countByTitleWithRestrictions, deduplicate, find, findByIdentifier, findByMarker, findByTitle, findByTitle, findByTitleWithRestrictions, findTitleCache, findUuidAndTitleCacheByMarker, getRights, getSourcedObjectByIdInSource, getSources, getTitleCache, getUuidAndTitleCache, getUuidAndTitleCache, listByIdentifier, listByReferenceTitle, listByReferenceTitleWithRestrictions, listByTitle, listByTitleWithRestrictions, replace, search, updateCaches, updateCaches
countMarkers, getAnnotations, getMarkers, groupMarkers
getNextAuditEvent, getPreviousAuditEvent, isDeletable, pageAuditEvents, pageAuditEvents
clear, count, delete, delete, delete, exists, find, find, find, find, findById, findWithoutFlush, getSession, group, list, list, load, load, load, load, loadByIds, loadByIds, loadWithUpdate, lock, merge, merge, merge, merge, page, page, page, pageByParamWithRestrictions, refresh, refresh, save, save, saveOrUpdate, saveOrUpdate, update
@Deprecated TermVocabulary<Feature> getDefaultFeatureVocabulary()
@Deprecated TermVocabulary<Feature> getFeatureVocabulary(java.util.UUID uuid)
DescriptionElementBase getDescriptionElementByUuid(java.util.UUID uuid)
uuid
- the uuid of the DescriptionElement of interestDescriptionElementBase loadDescriptionElement(java.util.UUID uuid, java.util.List<java.lang.String> propertyPaths)
propertyPaths
parameter.
For detailed description and examples please refer to:
IBeanInitializer.initialize(Object, List)
uuid
- the uuid of the DescriptionElement of interestjava.util.UUID saveDescriptionElement(DescriptionElementBase descriptionElement)
DescriptionElementBase
descriptionElement
- java.util.Map<java.util.UUID,DescriptionElementBase> saveDescriptionElement(java.util.Collection<DescriptionElementBase> descriptionElements)
DescriptionElementBase
descriptionElements
- java.util.UUID deleteDescriptionElement(DescriptionElementBase descriptionElement)
descriptionElement
- the description element to be deletedjava.util.UUID deleteDescriptionElement(java.util.UUID descriptionElementUuid)
Pager<DescriptionBase> page(java.lang.Class<? extends DescriptionBase> type, java.lang.Boolean hasMedia, java.lang.Boolean hasText, java.util.Set<Feature> feature, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<OrderHint> orderHints, java.util.List<java.lang.String> propertyPaths)
type
- The type of description returned (Taxon, TaxonName, or Specimen)hasMedia
- Restrict the description to those that do (true) or don't (false) contain elements that have one or more media (can be null)hasText
- Restrict the description to those that do (true) or don't (false) contain TextData elements that have some textual content (can be null)feature
- Restrict the description to those elements which are scoped by one of the Features passed (can be null or empty)pageSize
- The maximum number of descriptions returned (can be null for all descriptions)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints
- may be nullpropertyPaths
- properties to initialize - see IBeanInitializer.initialize(Object, List)
long count(java.lang.Class<? extends DescriptionBase> type, java.lang.Boolean hasImages, java.lang.Boolean hasText, java.util.Set<Feature> feature)
type
- The type of description returned (Taxon, TaxonName, or Specimen)hasMedia
- Restrict the description to those that do (true) or don't (false) contain elements that have one or more media (can be null)hasText
- Restrict the description to those that do (true) or don't (false) contain TextData elements that have some textual content (can be null)feature
- Restrict the description to those elements which are scoped by one of the Features passed (can be null or empty)@Deprecated <T extends DescriptionElementBase> Pager<T> getDescriptionElements(DescriptionBase description, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
#pageDescriptionElements(DescriptionBase, Set, Class, Integer, Integer, List)
insteaddescription
- The description which these description elements belong to
(can be null to count all description elements)descriptionType
- A filter DescriptionElements which belong to of a specific
class of Descriptionsfeatures
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
<T extends DescriptionElementBase> Pager<T> pageDescriptionElements(DescriptionBase description, java.lang.Class<? extends DescriptionBase> descriptionType, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
description
- The description which these description elements belong to
(can be null to count all description elements)descriptionType
- A filter DescriptionElements which belong to of a specific
class of Descriptionsfeatures
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
@Deprecated <T extends DescriptionElementBase> java.util.List<T> listDescriptionElements(DescriptionBase description, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
listDescriptionElements(DescriptionBase, Class, Set, Class, Integer, Integer, List)
insteaddescription
- The description which these description elements belong to
(can be null to count all description elements)features
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
<T extends DescriptionElementBase> java.util.List<T> listDescriptionElements(DescriptionBase description, java.lang.Class<? extends DescriptionBase> descriptionType, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
description
- The description which these description elements belong to
(can be null to count all description elements)features
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter DescriptionElements of a for specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
Pager<Annotation> getDescriptionElementAnnotations(DescriptionElementBase annotatedObj, MarkerType status, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<OrderHint> orderHints, java.util.List<java.lang.String> propertyPaths)
annotatedObj
- The object that "owns" the annotations returnedstatus
- Only return annotations which are marked with a Marker of this type (can be null to return all annotations)pageSize
- The maximum number of terms returned (can be null for all annotations)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints
- may be nullpropertyPaths
- properties to initialize - see IBeanInitializer.initialize(Object, List)
Pager<TaxonDescription> pageTaxonDescriptions(Taxon taxon, java.util.Set<DefinedTerm> scopes, java.util.Set<NamedArea> geographicalScope, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- The taxon which the description refers to (can be null for all TaxonDescription instances)scopes
- Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)geographicalScope
- Restrict the results to those descriptions which have a geographical scope that overlaps with the NamedArea instances passed (can be null or empty)pageSize
- The maximum number of descriptions returned (can be null for all descriptions)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)
#pageMarkedTaxonDescriptions(Taxon, Set, Set, Set, Integer, Integer, List)
Pager<TaxonDescription> pageTaxonDescriptions(Taxon taxon, java.util.Set<DefinedTerm> scopes, java.util.Set<NamedArea> geographicalScope, java.util.Set<MarkerType> markerTypes, java.util.Set<DescriptionType> descriptionTypes, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- The taxon which the description refers to (can be null for all TaxonDescription instances)scopes
- Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)geographicalScope
- Restrict the results to those descriptions which have a geographical scope that overlaps with the NamedArea instances passed (can be null or empty)markerType
- Restrict the results to those descriptions which are marked as true by one of the given marker types (can be null or empty)descriptionTypes
- Restrict the results to those descriptions of the given types (can be null or empty)pageSize
- The maximum number of descriptions returned (can be null for all descriptions)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)
java.util.List<TaxonDescription> listTaxonDescriptions(Taxon taxon, java.util.Set<DefinedTerm> scopes, java.util.Set<NamedArea> geographicalScope, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- scopes
- geographicalScope
- pageSize
- pageNumber
- propertyPaths
- #pageTaxonDescriptions(Taxon, Set, Set, Integer, Integer, List)}
java.util.List<TaxonDescription> listTaxonDescriptions(Taxon taxon, java.util.Set<DefinedTerm> scopes, java.util.Set<NamedArea> geographicalScope, java.util.Set<MarkerType> markerTypes, java.util.Set<DescriptionType> descriptionTypes, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- scopes
- geographicalScope
- pageSize
- pageNumber
- propertyPaths
- #pageMarkedTaxonDescriptions(Taxon, Set, Set, Set, Integer, Integer, List)}
java.util.List<Media> listTaxonDescriptionMedia(java.util.UUID taxonUuid, boolean limitToGalleries, java.util.Set<MarkerType> markerTypes, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
Media
attached to a taxon via TaxonDescription.elements.media.taxonUuid
- the taxons uuid, if null media for all taxa are returnedlimitToGalleries
- if true only media in TaxonDescriptions with imageGallery flag=true are returnedmarkerTypes
- only media for TaxonDescriptions with marker of type markerType and marker.flag=true are returned, one matching marker type is sufficientpageSize
- pageNumber
- propertyPaths
- Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)
int countTaxonDescriptionMedia(java.util.UUID taxonUuid, boolean limitToGalleries, java.util.Set<MarkerType> markerTypes)
Media
attached to a taxon via TaxonDescription.elements.media.taxonUuid
- the taxons uuid, if null media for all taxa are returnedlimitToGalleries
- if true only media in TaxonDescriptions with imageGallery flag=true are returnedmarkerTypes
- only media for TaxonDescriptions with marker of type markerType and marker.flag=true are returned, one matching marker type is sufficientPager<TaxonNameDescription> getTaxonNameDescriptions(TaxonName name, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
name
- Restrict the results to those descriptions that refer to a specific name (can be null for all TaxonNameDescription instances)pageSize
- The maximum number of descriptions returned (can be null for all descriptions)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)
Pager<TaxonDescription> searchDescriptionByDistribution(java.util.Set<NamedArea> namedAreas, PresenceAbsenceTerm presence, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<OrderHint> orderHints, java.util.List<java.lang.String> propertyPaths)
namedAreas
- The set of NamedArea instancespresence
- Restrict the descriptions to those which have Distribution elements are of this status (can be null)pageSize
- The maximum number of descriptions returned (can be null for all descriptions)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)
<S extends DescriptionElementBase> Pager<S> searchElements(java.lang.Class<S> clazz, java.lang.String queryString, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<OrderHint> orderHints, java.util.List<java.lang.String> propertyPaths)
clazz
- filter the results by class (or pass null to return all DescriptionElementBase instances)queryString
- pageSize
- The maximum number of descriptionElements returned (can be null for all matching descriptionElements)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints
- Supports path like orderHints.propertyNames
which
include *-to-one properties like createdBy.username or
authorTeam.persistentTitleCachepropertyPaths
- properties to be initializedPager<Media> getMedia(DescriptionElementBase descriptionElement, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
descriptionElement
- the description element associated with these mediapageSize
- The maximum number of media returned (can be null for all related media)pageNumber
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- properties to initialize - see IBeanInitializer.initialize(Object, List)
@Deprecated <T extends DescriptionElementBase> java.util.List<T> getDescriptionElementsForTaxon(Taxon taxon, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
listDescriptionElementsForTaxon(Taxon, Set, Class, Integer, Integer, List)
insteadtaxon
- The Taxon to return Description elements forfeatures
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
<T extends DescriptionElementBase> java.util.List<T> listDescriptionElementsForTaxon(Taxon taxon, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- The Taxon to return Description elements forfeatures
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returned (can be
null for all description elements)pageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
<T extends DescriptionElementBase> Pager<T> pageDescriptionElementsForTaxon(Taxon taxon, java.util.Set<Feature> features, java.lang.Class<T> type, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths)
taxon
- The Taxon to return Description elements forfeatures
- Restrict the results to those description elements which are
scoped by one of the Features passed (can be null or empty)type
- A filter for DescriptionElements of a specific classpageSize
- The maximum number of description elements returnedpageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
@Deprecated DistributionTree getOrderedDistributions(java.util.Set<TaxonDescription> taxonDescriptions, boolean subAreaPreference, boolean statusOrderPreference, java.util.Set<MarkerType> hideMarkedAreas, java.util.Set<NamedAreaLevel> omitLevels, java.util.List<java.lang.String> propertyPaths)
IEditGeoService#composeDistributionInfoFor()
insteadtaxonDescriptions
- subAreaPreference
- enables the Sub area preference rule if set to true,
see DescriptionUtility#filterDistributions(Collection,
boolean, boolean
statusOrderPreference
- enables the Status order preference rule if set to
true, see DescriptionUtility#filterDistributions(Collection, boolean,
boolean
hideMarkedAreas
- distributions where the area has a Marker
with one of
the specified MarkerType
s will be skipped, see
DescriptionUtility#filterDistributions(Collection, boolean, boolean, Set)
omitLevels
- A Set NamedArea levels to omit - optionalpropertyPaths
- the initialization strategyjava.lang.String generateNaturalLanguageDescription(TermTree featureTree, TaxonDescription description, java.util.List<Language> preferredLanguages, java.lang.String separator)
description
supplied in natural language
The featureTree
will be used to structure the NaturalLanguageDescription.
This method does not require a initialization strategy so there is no propertyPaths
parameter.featureTree
- description
- preferredLanguages
- separator
- @Deprecated boolean hasStructuredData(DescriptionBase<?> description)
description
- UpdateResult moveDescriptionElementsToDescription(java.util.Collection<DescriptionElementBase> descriptionElements, DescriptionBase targetDescription, boolean isPaste, boolean setNameInSource)
description elements
to the targetDescription
.
Remove the description elements from the description they are currently associated with.descriptionElements
- targetDescription
- isPaste
- if true, the elements are only copied (cloned) and not removed from the
old descriptionPager<TermDto> pageNamedAreasInUse(boolean includeAllParents, java.lang.Integer pageSize, java.lang.Integer pageNumber)
NamedAreas
instances which are currently used
by Distribution
elements.pageSize
- The maximum number of description elements returnedpageNumber
- The offset (in pageSize chunks) from the start of the result
set (0 - based)propertyPaths
- Properties to initialize in the returned entities, following
the syntax described in
IBeanInitializer.initialize(Object, List)
DeleteResult deleteDescription(DescriptionBase description)
DeleteResult deleteDescription(java.util.UUID descriptionUuid)
UpdateResult moveTaxonDescriptions(Taxon sourceTaxon, Taxon targetTaxon, boolean setNameInSource)
sourceTaxon
- targetTaxon
- UpdateResult moveTaxonDescriptions(java.util.UUID sourceTaxonUuid, java.util.UUID targetTaxonUuid, boolean setNameInSource)
sourceTaxonUuid
- targetTaxonUuid
- UpdateResult moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs, java.util.UUID targetDescriptionUuid, boolean isCopy, boolean setNameInSource)
descriptionElementUUIDs
- targetDescriptionUuid
- isCopy
- UpdateResult moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs, java.util.UUID targetTaxonUuid, java.lang.String moveMessage, boolean isCopy, boolean setNameInSource)
descriptionElementUUIDs
- targetTaxonUuid
- moveMessage
- isCopy
- UpdateResult moveTaxonDescription(java.util.UUID descriptionUuid, java.util.UUID targetTaxonUuid, boolean setNameInSource)
descriptionUUID
- targetTaxonUuid
- java.util.List<MergeResult<DescriptionBase>> mergeDescriptionElements(java.util.Collection<TaxonDistributionDTO> descriptionElements, boolean returnTransientEntity)
descriptionElements
- returnTransientEntity
- UpdateResult moveDescriptionElementsToDescription(java.util.Set<java.util.UUID> descriptionElementUUIDs, DescriptionBase targetDescription, boolean isCopy, boolean setNameInSource)
descriptionElementUUIDs
- targetDescription
- isCopy
- DeleteResult isDeletable(java.util.UUID descriptionUuid)
Copyright © 2007-2020 EDIT. All Rights Reserved.