import java.util.Map;
import java.util.UUID;
-import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;
+import eu.etaxonomy.cdm.api.service.config.CreateHierarchyForClassificationConfigurator;
+import eu.etaxonomy.cdm.api.service.pager.Pager;
import eu.etaxonomy.cdm.model.media.MediaRepresentation;
import eu.etaxonomy.cdm.model.name.Rank;
-import eu.etaxonomy.cdm.model.taxon.ITreeNode;
+import eu.etaxonomy.cdm.model.taxon.Classification;
+import eu.etaxonomy.cdm.model.taxon.ITaxonTreeNode;
import eu.etaxonomy.cdm.model.taxon.Taxon;
import eu.etaxonomy.cdm.model.taxon.TaxonNode;
-import eu.etaxonomy.cdm.model.taxon.Classification;
+import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
import eu.etaxonomy.cdm.persistence.query.OrderHint;
/**
* @author n.hoffmann
* @created Sep 21, 2009
- * @version 1.0
*/
public interface IClassificationService extends IIdentifiableEntityService<Classification> {
* @param uuid
* @return
*/
- public ITreeNode getTreeNodeByUuid(UUID uuid);
+ public ITaxonTreeNode getTreeNodeByUuid(UUID uuid);
/**
*
* @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
*/
+ @Deprecated
public TaxonNode loadTaxonNodeByTaxon(Taxon taxon, UUID classificationUuid, List<String> propertyPaths);
/**
* @return
* @deprecated use TaxonNodeService instead
*/
+ @Deprecated
public TaxonNode loadTaxonNode(TaxonNode taxonNode, List<String> propertyPaths);
/**
*
* @param classification may be null for all classifications
* @param rank the set to null for to get the root nodes of classifications
+ * @param limit The maximum number of objects returned (can be null for all matching objects)
+ * @param start The offset from the start of the result set (0 - based, can be null -
+ * equivalent of starting at the beginning of the recordset)
+ * @param propertyPaths
+ * @return
+ * @deprecated use {@link #listRankSpecificRootNodes(Classification, Rank, Integer, Integer, List)} instead
+ */
+ @Deprecated
+ public List<TaxonNode> loadRankSpecificRootNodes(Classification classification, Rank rank, Integer limit, Integer start, 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 <code>rank</code> is null the absolute root nodes will be returned.
+ *
+ * @param classification may be null for all classifications
+ * @param rank the set to null for to get the root nodes of classifications
+ * @param pageSize The maximum number of relationships returned (can be null for all relationships)
+ * @param pageIndex The offset (in pageSize chunks) from the start of the result set (0 - based)
* @param propertyPaths
* @return
+ *
*/
- public List<TaxonNode> loadRankSpecificRootNodes(Classification classification, Rank rank, List<String> propertyPaths);
+ public 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 <code>rank</code> is null the absolute root nodes will be returned.
+ *
+ * @param classification may be null for all classifications
+ * @param rank the set to null for to get the root nodes of classifications
+ * @param pageSize The maximum number of relationships returned (can be null for all relationships)
+ * @param pageIndex The offset (in pageSize chunks) from the start of the result set (0 - based)
+ * @param propertyPaths
+ * @return
+ *
+ */
+ public Pager<TaxonNode> pageRankSpecificRootNodes(Classification classification, Rank rank, Integer pageSize, Integer pageIndex, List<String> propertyPaths);
/**
* @param taxonNode
/**
- * Although this method seems to be a redundant alternative to {@link #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.
- * @param taxon
- * @param classification
+ * @param taxonUuid
+ * @param classificationUuid
* @param propertyPaths
* @return
*/
- public List<TaxonNode> loadChildNodesOfTaxon(Taxon taxon, Classification classification, List<String> propertyPaths);
+ public List<TaxonNode> listChildNodesOfTaxon(UUID taxonUuid, UUID classificationUuid, Integer pageSize, Integer pageIndex, List<String> propertyPaths);
/**
* @param taxonNode
* @deprecated move to TaxonNodeService
* @return
*/
+ @Deprecated
public List<TaxonNode> loadChildNodesOfTaxonNode(TaxonNode taxonNode, List<String> propertyPaths);
/**
* @param widthOrDuration
* @param mimeTypes
* @return
- * @deprecated use getAllMediaForChildNodes(TaxonNode taxonNode, ...) instead
+ *
+ * @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
*/
+ @Deprecated
public Map<UUID, List<MediaRepresentation>> getAllMediaForChildNodes(Taxon taxon, Classification taxTree, List<String> propertyPaths, int size, int height, int widthOrDuration, String[] mimeTypes);
/**
* @return
* @deprecated use TaxonNodeService instead
*/
+ @Deprecated
public UUID removeTaxonNode(TaxonNode taxonNode);
/**
* @return
* @deprecated use TaxonNodeService instead
*/
+ @Deprecated
public UUID saveTaxonNode(TaxonNode taxonNode);
/**
* @return
* @deprecated use TaxonNodeService instead
*/
+ @Deprecated
public Map<UUID, TaxonNode> saveTaxonNodeAll(Collection<TaxonNode> taxonNodeCollection);
/**
* @param treeNode
* @return
*/
- public UUID removeTreeNode(ITreeNode treeNode);
+
+ public UUID removeTreeNode(ITaxonTreeNode treeNode);
/**
*
* @param treeNode
* @return
*/
- public UUID saveTreeNode(ITreeNode treeNode);
+ public UUID saveTreeNode(ITaxonTreeNode treeNode);
public List<TaxonNode> getAllNodes();
+ public UpdateResult createHierarchyInClassification(Classification classification, CreateHierarchyForClassificationConfigurator configurator);
+
}
BGBM BDI Projects / cdmlib.git / blobdiff