public interface IClassificationService extends IIdentifiableEntityService<Classification>
Modifier and Type | Method and Description |
---|---|
ClassificationLookupDTO |
classificationLookup(Classification classification) |
UpdateResult |
cloneClassification(java.util.UUID classificationUuid,
java.lang.String name,
Reference sec,
TaxonRelationshipType relationshipType)
Clones an existing classification including all taxa and taxon nodes.
|
UpdateResult |
createHierarchyInClassification(Classification classification,
CreateHierarchyForClassificationConfigurator configurator) |
DeleteResult |
delete(java.util.UUID classificationUuid,
TaxonDeletionConfigurator config) |
java.util.Map<java.util.UUID,java.util.List<MediaRepresentation>> |
getAllMediaForChildNodes(TaxonNode taxonNode,
java.util.List<java.lang.String> propertyPaths,
int size,
int height,
int widthOrDuration,
java.lang.String[] mimeTypes) |
java.util.List<TaxonNode> |
getAllNodes() |
TaxonNode |
getRootNode(java.util.UUID classificationUuid)
Returns the root node of the the given classification (specified by its UUID)
|
TaxonInContextDTO |
getTaxonInContext(java.util.UUID classificationUuid,
java.util.UUID taxonUuid,
java.lang.Boolean doChildren,
java.lang.Boolean doSynonyms,
boolean includeUnpublished,
java.util.List<java.util.UUID> ancestorMarkers,
NodeSortMode sortMode)
Returns the most relevant data of a taxon/taxon node, including children, synonyms
and certain ancestors if required.
|
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification,
boolean searchForClassifications) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification,
java.lang.Integer limit,
java.lang.String pattern) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification,
java.lang.Integer limit,
java.lang.String pattern,
boolean searchForClassifications) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid,
boolean searchForClassifications) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid,
java.lang.Integer limit,
java.lang.String pattern) |
java.util.List<UuidAndTitleCache<TaxonNode>> |
getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid,
java.lang.Integer limit,
java.lang.String pattern,
boolean searchForClassifications) |
java.util.UUID |
getTaxonNodeUuidByTaxonUuid(java.util.UUID classificationUuid,
java.util.UUID taxonUuid) |
ITaxonTreeNode |
getTreeNodeByUuid(java.util.UUID uuid) |
java.util.List<GroupedTaxonDTO> |
groupTaxaByHigherTaxon(java.util.List<java.util.UUID> taxonUuids,
java.util.UUID classificationUuid,
Rank minRank,
Rank maxRank)
Returns the higher taxon id for each taxon in taxonUuids.
|
java.util.List<GroupedTaxonDTO> |
groupTaxaByMarkedParents(java.util.List<java.util.UUID> taxonUuids,
java.util.UUID classificationUuid,
MarkerType markerType,
java.lang.Boolean value) |
java.util.List<TaxonNode> |
listChildNodesOfTaxon(java.util.UUID taxonUuid,
java.util.UUID classificationUuid,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
listChildNodesOfTaxon(java.util.UUID taxonUuid,
java.util.UUID classificationUuid,
java.util.UUID subtreeUuid,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<Classification> |
listClassifications(java.lang.Integer limit,
java.lang.Integer start,
java.util.List<OrderHint> orderHints,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
listRankSpecificRootNodes(Classification classification,
TaxonNode subtree,
Rank rank,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths)
Loads all TaxonNodes of the specified classification for a given Rank or lower.
|
java.util.List<TaxonNode> |
listSiblingsOfTaxon(java.util.UUID taxonUuid,
java.util.UUID classificationUuid,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
loadChildNodesOfTaxonNode(TaxonNode taxonNode,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
move to TaxonNodeService
|
TaxonNode |
loadTaxonNodeByTaxon(Taxon taxon,
java.util.UUID classificationUuid,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
use loadTaxonNode(TaxonNode taxonNode, ...) instead
if you have a classification and a taxon that is in it, you should also have the according taxonNode
|
java.util.List<TaxonNode> |
loadTreeBranch(TaxonNode taxonNode,
Rank baseRank,
boolean includeUnpublished,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
loadTreeBranch(TaxonNode taxonNode,
TaxonNode subtree,
Rank baseRank,
boolean includeUnpublished,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
loadTreeBranchToTaxon(Taxon taxon,
Classification classification,
Rank baseRank,
boolean includeUnpublished,
java.util.List<java.lang.String> propertyPaths) |
java.util.List<TaxonNode> |
loadTreeBranchToTaxon(Taxon taxon,
Classification classification,
TaxonNode subtree,
Rank baseRank,
boolean includeUnpublished,
java.util.List<java.lang.String> propertyPaths)
Although this method seems to be a redundant alternative to
loadChildNodesOfTaxonNode(TaxonNode, List) it is an important
alternative from which web services benefit. |
Pager<TaxonNode> |
pageRankSpecificRootNodes(Classification classification,
Rank rank,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths)
Deprecated.
keep this for compatibility to older versions, might be removed in versions >5.3
|
Pager<TaxonNode> |
pageRankSpecificRootNodes(Classification classification,
TaxonNode subtree,
Rank rank,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths)
Loads all TaxonNodes of the specified classification for a given Rank or lower.
|
Pager<TaxonNode> |
pageSiblingsOfTaxon(java.util.UUID taxonUuid,
java.util.UUID classificationUuid,
boolean includeUnpublished,
java.lang.Integer pageSize,
java.lang.Integer pageIndex,
java.util.List<java.lang.String> propertyPaths) |
java.util.UUID |
removeTaxonNode(TaxonNode taxonNode)
Deprecated.
use TaxonNodeService instead
|
java.util.UUID |
removeTreeNode(ITaxonTreeNode treeNode) |
java.util.UUID |
saveClassification(Classification classification) |
java.util.UUID |
saveTaxonNode(TaxonNode taxonNode)
Deprecated.
use TaxonNodeService instead
|
java.util.Map<java.util.UUID,TaxonNode> |
saveTaxonNodeAll(java.util.Collection<TaxonNode> taxonNodeCollection)
Deprecated.
use TaxonNodeService instead
|
java.util.UUID |
saveTreeNode(ITaxonTreeNode treeNode) |
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
ITaxonTreeNode getTreeNodeByUuid(java.util.UUID uuid)
uuid
- TaxonNode getRootNode(java.util.UUID classificationUuid)
classificationUuid
- the uuid of the classificationjava.util.UUID getTaxonNodeUuidByTaxonUuid(java.util.UUID classificationUuid, java.util.UUID taxonUuid)
UpdateResult cloneClassification(java.util.UUID classificationUuid, java.lang.String name, Reference sec, TaxonRelationshipType relationshipType)
name
- sec
- relationshipType
- java.util.List<Classification> listClassifications(java.lang.Integer limit, java.lang.Integer start, java.util.List<OrderHint> orderHints, java.util.List<java.lang.String> propertyPaths)
limit
- start
- orderHints
- propertyPaths
- @Deprecated TaxonNode loadTaxonNodeByTaxon(Taxon taxon, java.util.UUID classificationUuid, java.util.List<java.lang.String> propertyPaths)
taxon
- classificationUuid
- propertyPaths
- java.util.List<TaxonNode> listRankSpecificRootNodes(Classification classification, TaxonNode subtree, Rank rank, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
rank
is null the absolute root nodes will be returned.classification
- may be null for all classificationssubtree
- filter on a taxonomic subtreerank
- the set to null for to get the root nodes of classificationsincludeUnpublished
- if true
unpublished taxa are also exportedpageSize
- The maximum number of relationships returned (can be null for all relationships)pageIndex
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- pageRankSpecificRootNodes(Classification, TaxonNode, Rank, boolean, Integer, Integer, List)
Pager<TaxonNode> pageRankSpecificRootNodes(Classification classification, TaxonNode subtree, Rank rank, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
rank
is null the absolute root nodes will be returned.classification
- may be null for all classificationssubtree
- the taxonomic subtree filterrank
- the set to null for to get the root nodes of classificationsincludeUnpublished
- if true
unpublished taxa are also exportedpageSize
- The maximum number of relationships returned (can be null for all relationships)pageIndex
- The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths
- listRankSpecificRootNodes(Classification, TaxonNode, Rank, boolean, Integer, Integer, List)
@Deprecated Pager<TaxonNode> pageRankSpecificRootNodes(Classification classification, Rank rank, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
java.util.List<TaxonNode> loadTreeBranch(TaxonNode taxonNode, TaxonNode subtree, Rank baseRank, boolean includeUnpublished, java.util.List<java.lang.String> propertyPaths) throws UnpublishedException
taxonNode
- baseRank
- specifies the root level of the classification, may be null.
Nodes of this rank or in case this rank does not exist in the
current branch the next lower rank is taken as root node for
this rank henceforth called the base node.propertyPaths
- the initialization strategy for the returned TaxonNode
instances.includeUnpublished
- if true
no UnpublishedException
is thrown if any of the taxa in the branch are unpublishedUnpublishedException
- if any of the taxa in the path is unpublished an UnpublishedException
is thrown.java.util.List<TaxonNode> loadTreeBranch(TaxonNode taxonNode, Rank baseRank, boolean includeUnpublished, java.util.List<java.lang.String> propertyPaths) throws UnpublishedException
UnpublishedException
java.util.List<TaxonNode> loadTreeBranchToTaxon(Taxon taxon, Classification classification, TaxonNode subtree, Rank baseRank, boolean includeUnpublished, java.util.List<java.lang.String> propertyPaths) throws UnpublishedException
loadChildNodesOfTaxonNode(TaxonNode, List)
it is an important
alternative from which web services benefit. Without this method the web service controller method, which operates outside of the
transaction, would have to initialize the full taxon tree with all nodes of the taxon.
This would be rather slow compared to using this method.taxon
- classification
- the classification to be usedbaseRank
- specifies the root level of the classification, may be null.
Nodes of this rank or in case this rank does not exist in the
current branch the next lower rank is taken as as root node for
this rank henceforth called the base node.includeUnpublished
- if true
no UnpublishedException
is thrown if any of the taxa in the branch are unpublishedpropertyPaths
- the initialization strategy for the returned TaxonNode
instances.UnpublishedException
- if any of the taxa in the path is unpublished an UnpublishedException
is thrownjava.util.List<TaxonNode> loadTreeBranchToTaxon(Taxon taxon, Classification classification, Rank baseRank, boolean includeUnpublished, java.util.List<java.lang.String> propertyPaths) throws UnpublishedException
UnpublishedException
java.util.List<TaxonNode> listChildNodesOfTaxon(java.util.UUID taxonUuid, java.util.UUID classificationUuid, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
java.util.List<TaxonNode> listChildNodesOfTaxon(java.util.UUID taxonUuid, java.util.UUID classificationUuid, java.util.UUID subtreeUuid, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths) throws FilterException
FilterException
@Deprecated java.util.List<TaxonNode> loadChildNodesOfTaxonNode(TaxonNode taxonNode, java.util.List<java.lang.String> propertyPaths)
taxonNode
- propertyPaths
- java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification)
classification
- java.util.Map<java.util.UUID,java.util.List<MediaRepresentation>> getAllMediaForChildNodes(TaxonNode taxonNode, java.util.List<java.lang.String> propertyPaths, int size, int height, int widthOrDuration, java.lang.String[] mimeTypes)
@Deprecated java.util.UUID removeTaxonNode(TaxonNode taxonNode)
taxonNode
- @Deprecated java.util.UUID saveTaxonNode(TaxonNode taxonNode)
taxonNode
- @Deprecated java.util.Map<java.util.UUID,TaxonNode> saveTaxonNodeAll(java.util.Collection<TaxonNode> taxonNodeCollection)
taxonNodeCollection
- java.util.UUID removeTreeNode(ITaxonTreeNode treeNode)
java.util.UUID saveTreeNode(ITaxonTreeNode treeNode)
java.util.List<TaxonNode> getAllNodes()
UpdateResult createHierarchyInClassification(Classification classification, CreateHierarchyForClassificationConfigurator configurator)
java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid)
java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid, java.lang.Integer limit, java.lang.String pattern)
java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification, java.lang.Integer limit, java.lang.String pattern)
java.util.List<TaxonNode> listSiblingsOfTaxon(java.util.UUID taxonUuid, java.util.UUID classificationUuid, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
Pager<TaxonNode> pageSiblingsOfTaxon(java.util.UUID taxonUuid, java.util.UUID classificationUuid, boolean includeUnpublished, java.lang.Integer pageSize, java.lang.Integer pageIndex, java.util.List<java.lang.String> propertyPaths)
ClassificationLookupDTO classificationLookup(Classification classification)
DeleteResult delete(java.util.UUID classificationUuid, TaxonDeletionConfigurator config)
java.util.List<GroupedTaxonDTO> groupTaxaByHigherTaxon(java.util.List<java.util.UUID> taxonUuids, java.util.UUID classificationUuid, Rank minRank, Rank maxRank)
taxonUuids
- minRank
- maxRank
- java.util.List<GroupedTaxonDTO> groupTaxaByMarkedParents(java.util.List<java.util.UUID> taxonUuids, java.util.UUID classificationUuid, MarkerType markerType, java.lang.Boolean value)
taxonUuids
- classificationUuid
- markerType
- value
- TaxonInContextDTO getTaxonInContext(java.util.UUID classificationUuid, java.util.UUID taxonUuid, java.lang.Boolean doChildren, java.lang.Boolean doSynonyms, boolean includeUnpublished, java.util.List<java.util.UUID> ancestorMarkers, NodeSortMode sortMode)
classificationUuid
- taxonUuid
- doSynonyms
- includeUnpublished
- ancestorMarkers
- java.util.UUID saveClassification(Classification classification)
classification
- java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid, java.lang.Integer limit, java.lang.String pattern, boolean searchForClassifications)
classificationUuid
- limit
- pattern
- searchForClassifications
- java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification, java.lang.Integer limit, java.lang.String pattern, boolean searchForClassifications)
classification
- limit
- pattern
- searchForClassifications
- java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(java.util.UUID classificationUuid, boolean searchForClassifications)
classificationUuid
- searchForClassifications
- java.util.List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification, boolean searchForClassifications)
classification
- searchForClassifications
- Copyright © 2007-2020 EDIT. All Rights Reserved.