eu.etaxonomy.cdm.api.service
Interface IClassificationService

All Superinterfaces:

IAnnotatableService<Classification>, IIdentifiableEntityService<Classification>, IService<Classification>, IVersionableService<Classification>

All Known Implementing Classes:

ClassificationServiceImpl

public interface IClassificationService
extends IIdentifiableEntityService<Classification>

Version:

1.0

Author:

n.hoffmann

Method Summary

Map<UUID,List<MediaRepresentation>>	getAllMediaForChildNodes(Taxon taxon, Classification taxTree, List<String> propertyPaths, int size, int height, int widthOrDuration, String[] mimeTypes) Deprecated. use getAllMediaForChildNodes(TaxonNode taxonNode, ...) instead if you have a classification and a taxon that is in it, you should also have the according taxonNode
Map<UUID,List<MediaRepresentation>>	getAllMediaForChildNodes(TaxonNode taxonNode, List<String> propertyPaths, int size, int height, int widthOrDuration, String[] mimeTypes)
List<TaxonNode>	getAllNodes()
TaxonNode	getTaxonNodeByUuid(UUID uuid)
List<UuidAndTitleCache<TaxonNode>>	getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification)
ITreeNode	getTreeNodeByUuid(UUID uuid)
List<Classification>	listClassifications(Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths)
List<TaxonNode>	listRankSpecificRootNodes(Classification classification, Rank rank, Integer pageSize, Integer pageIndex, List<String> propertyPaths) Loads all TaxonNodes of the specified classification for a given Rank or lower.
List<TaxonNode>	loadChildNodesOfTaxon(Taxon taxon, Classification classification, List<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.
List<TaxonNode>	loadChildNodesOfTaxonNode(TaxonNode taxonNode, List<String> propertyPaths) Deprecated. move to TaxonNodeService
List<TaxonNode>	loadRankSpecificRootNodes(Classification classification, Rank rank, Integer limit, Integer start, List<String> propertyPaths) Deprecated. use listRankSpecificRootNodes(Classification, Rank, Integer, Integer, List) instead
TaxonNode	loadTaxonNode(TaxonNode taxonNode, List<String> propertyPaths) Deprecated. use TaxonNodeService instead
TaxonNode	loadTaxonNodeByTaxon(Taxon taxon, UUID classificationUuid, List<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
List<TaxonNode>	loadTreeBranch(TaxonNode taxonNode, Rank baseRank, List<String> propertyPaths)
List<TaxonNode>	loadTreeBranchToTaxon(Taxon taxon, Classification classification, Rank baseRank, List<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, Integer pageSize, Integer pageIndex, List<String> propertyPaths) Loads all TaxonNodes of the specified classification for a given Rank or lower.
UUID	removeTaxonNode(TaxonNode taxonNode) Deprecated. use TaxonNodeService instead
UUID	removeTreeNode(ITreeNode treeNode)
UUID	saveTaxonNode(TaxonNode taxonNode) Deprecated. use TaxonNodeService instead
Map<UUID,TaxonNode>	saveTaxonNodeAll(Collection<TaxonNode> taxonNodeCollection) Deprecated. use TaxonNodeService instead
UUID	saveTreeNode(ITreeNode treeNode)

Methods inherited from interface eu.etaxonomy.cdm.api.service.IIdentifiableEntityService

countByTitle, countByTitle, deduplicate, find, findByTitle, findByTitle, findTitleCache, getRights, getSourcedObjectByIdInSource, getSources, getUuidAndTitleCache, listByReferenceTitle, listByTitle, replace, search, updateTitleCache, updateTitleCache

Methods inherited from interface eu.etaxonomy.cdm.api.service.IAnnotatableService

countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.api.service.IVersionableService

getNextAuditEvent, getPreviousAuditEvent, pageAuditEvents, pageAuditEvents

Methods inherited from interface eu.etaxonomy.cdm.api.service.IService

clear, count, delete, exists, find, find, find, findById, getSession, group, list, list, load, load, lock, merge, page, refresh, refresh, rows, save, save, saveOrUpdate, saveOrUpdate, update

Method Detail

getTaxonNodeByUuid

TaxonNode getTaxonNodeByUuid(UUID uuid)

Parameters:

uuid -

Returns:

getTreeNodeByUuid

ITreeNode getTreeNodeByUuid(UUID uuid)

Parameters:

uuid -

Returns:

listClassifications

List<Classification> listClassifications(Integer limit,
                                         Integer start,
                                         List<OrderHint> orderHints,
                                         List<String> propertyPaths)

Parameters:

limit -

start -

orderHints -

propertyPaths -

Returns:

loadTaxonNodeByTaxon

@Deprecated
TaxonNode loadTaxonNodeByTaxon(Taxon taxon,
                                          UUID classificationUuid,
                                          List<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

Parameters:

taxon -

classificationUuid -

propertyPaths -

Returns:

loadTaxonNode

@Deprecated
TaxonNode loadTaxonNode(TaxonNode taxonNode,
                                   List<String> propertyPaths)

Deprecated. use TaxonNodeService instead

Parameters:

taxonNode -

propertyPaths -

Returns:

loadRankSpecificRootNodes

@Deprecated
List<TaxonNode> loadRankSpecificRootNodes(Classification classification,
                                                     Rank rank,
                                                     Integer limit,
                                                     Integer start,
                                                     List<String> propertyPaths)

Deprecated. use listRankSpecificRootNodes(Classification, Rank, Integer, Integer, List) instead

Loads all TaxonNodes of the specified classification for a given Rank or lower. If a branch of the classification tree is not containing a TaxonNode with a Taxon at the given Rank the according node associated with the next lower Rank is taken as root node in this case. So the nodes returned may reference Taxa with different Ranks. If the rank is null the absolute root nodes will be returned.

Parameters:

classification - may be null for all classifications

rank - the set to null for to get the root nodes of classifications

limit - The maximum number of objects returned (can be null for all matching objects)

start - The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)

propertyPaths -

Returns:

listRankSpecificRootNodes

List<TaxonNode> listRankSpecificRootNodes(Classification classification,
                                          Rank rank,
                                          Integer pageSize,
                                          Integer pageIndex,
                                          List<String> propertyPaths)

Loads all TaxonNodes of the specified classification for a given Rank or lower. If a branch of the classification tree is not containing a TaxonNode with a Taxon at the given Rank the according node associated with the next lower Rank is taken as root node in this case. So the nodes returned may reference Taxa with different Ranks. If the rank is null the absolute root nodes will be returned.

Parameters:

classification - may be null for all classifications

rank - the set to null for to get the root nodes of classifications

pageSize - 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 -

Returns:

pageRankSpecificRootNodes

Pager<TaxonNode> pageRankSpecificRootNodes(Classification classification,
                                           Rank rank,
                                           Integer pageSize,
                                           Integer pageIndex,
                                           List<String> propertyPaths)

Loads all TaxonNodes of the specified classification for a given Rank or lower. If a branch of the classification tree is not containing a TaxonNode with a Taxon at the given Rank the according node associated with the next lower Rank is taken as root node in this case. So the nodes returned may reference Taxa with different Ranks. If the rank is null the absolute root nodes will be returned.

Parameters:

classification - may be null for all classifications

rank - the set to null for to get the root nodes of classifications

pageSize - 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 -

Returns:

loadTreeBranch

List<TaxonNode> loadTreeBranch(TaxonNode taxonNode,
                               Rank baseRank,
                               List<String> propertyPaths)

Parameters:

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.

Returns:

the path of nodes from the base node to the node of the specified taxon.

loadTreeBranchToTaxon

List<TaxonNode> loadTreeBranchToTaxon(Taxon taxon,
                                      Classification classification,
                                      Rank baseRank,
                                      List<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. 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.

Parameters:

taxon -

classification - the classification to be used

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 as root node for this rank henceforth called the base node.

propertyPaths - the initialization strategy for the returned TaxonNode instances.

Returns:

the path of nodes from the base node to the node of the specified taxon.

loadChildNodesOfTaxon

List<TaxonNode> loadChildNodesOfTaxon(Taxon taxon,
                                      Classification classification,
                                      List<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. 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.

Parameters:

taxon -

classification -

propertyPaths -

Returns:

loadChildNodesOfTaxonNode

@Deprecated
List<TaxonNode> loadChildNodesOfTaxonNode(TaxonNode taxonNode,
                                                     List<String> propertyPaths)

Deprecated. move to TaxonNodeService

Parameters:

taxonNode -

propertyPaths -

Returns:

getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification

List<UuidAndTitleCache<TaxonNode>> getTaxonNodeUuidAndTitleCacheOfAcceptedTaxaByClassification(Classification classification)

Parameters:

classification -

Returns:

getAllMediaForChildNodes

@Deprecated
Map<UUID,List<MediaRepresentation>> getAllMediaForChildNodes(Taxon taxon,
                                                                        Classification taxTree,
                                                                        List<String> propertyPaths,
                                                                        int size,
                                                                        int height,
                                                                        int widthOrDuration,
                                                                        String[] mimeTypes)

Deprecated. use getAllMediaForChildNodes(TaxonNode taxonNode, ...) instead if you have a classification and a taxon that is in it, you should also have the according taxonNode

Parameters:

taxon -

taxTree -

propertyPaths -

size -

height -

widthOrDuration -

mimeTypes -

Returns:

getAllMediaForChildNodes

Map<UUID,List<MediaRepresentation>> getAllMediaForChildNodes(TaxonNode taxonNode,
                                                             List<String> propertyPaths,
                                                             int size,
                                                             int height,
                                                             int widthOrDuration,
                                                             String[] mimeTypes)

Parameters:

taxonNode -

propertyPaths -

size -

height -

widthOrDuration -

mimeTypes -

Returns:

removeTaxonNode

@Deprecated
UUID removeTaxonNode(TaxonNode taxonNode)

Deprecated. use TaxonNodeService instead

Parameters:

taxonNode -

Returns:

saveTaxonNode

@Deprecated
UUID saveTaxonNode(TaxonNode taxonNode)

Deprecated. use TaxonNodeService instead

Parameters:

taxonNode -

Returns:

saveTaxonNodeAll

@Deprecated
Map<UUID,TaxonNode> saveTaxonNodeAll(Collection<TaxonNode> taxonNodeCollection)

Deprecated. use TaxonNodeService instead

Parameters:

taxonNodeCollection -

Returns:

removeTreeNode

UUID removeTreeNode(ITreeNode treeNode)

Parameters:

treeNode -

Returns:

saveTreeNode

UUID saveTreeNode(ITreeNode treeNode)

Parameters:

treeNode -

Returns:

getAllNodes

List<TaxonNode> getAllNodes()