package eu.etaxonomy.cdm.api.service;
+import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
+import eu.etaxonomy.cdm.api.service.config.DescriptionAggregationConfiguration;
import eu.etaxonomy.cdm.api.service.dto.RowWrapperDTO;
import eu.etaxonomy.cdm.api.service.dto.SpecimenRowWrapperDTO;
import eu.etaxonomy.cdm.api.service.dto.TaxonRowWrapperDTO;
import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
-import eu.etaxonomy.cdm.model.common.MarkerType;
import eu.etaxonomy.cdm.model.description.DescriptionBase;
import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
+import eu.etaxonomy.cdm.model.description.DescriptionType;
import eu.etaxonomy.cdm.model.description.DescriptiveDataSet;
import eu.etaxonomy.cdm.model.description.DescriptiveSystemRole;
import eu.etaxonomy.cdm.model.description.Feature;
/**
* Returns a collection of {@link RowWrapperDTO} objects for the given {@link DescriptiveDataSet}.<br>
* A RowWrapper represents on row in the character matrix.
- * @param descriptiveDataSet the working set for which the row wrapper objects should be fetched
+ * @param descriptiveDataSetUuid the working set for which the row wrapper objects should be fetched
* @param the progress monitor
* @return a list of row wrapper objects
*/
- public Collection<RowWrapperDTO> getRowWrapper(DescriptiveDataSet descriptiveDataSet, IProgressMonitor monitor);
-
- /**
- * Monitored invocation of {@link IDescriptiveDataSetService#getRowWrapper(DescriptiveDataSet, IProgressMonitor)}
- * @param descriptiveDataSet the working set for which getRowWrapper() is invoked
- * @return the uuid of the monitor
- */
- public UUID monitGetRowWrapper(DescriptiveDataSet descriptiveDataSet);
+ public ArrayList<RowWrapperDTO> getRowWrapper(UUID descriptiveDataSetUuid, IProgressMonitor monitor);
/**
* Loads all available specimens wrapped in a {@link SpecimenNodeWrapper} object for
* Creates a specimen row wrapper object for the given description
* @param description the specimen description for which the wrapper should be created
* @param descriptiveDataSet the data set it should be used in
- * @param if <code>true</code> a default taxon description will be created for the taxon
- * this wrapper belongs to
* @return the created row wrapper
*/
- public SpecimenRowWrapperDTO createSpecimenRowWrapper(SpecimenDescription description, DescriptiveDataSet descriptiveDataSet,
- boolean createDefaultTaxonDescription);
+ public SpecimenRowWrapperDTO createSpecimenRowWrapper(SpecimenDescription description, DescriptiveDataSet descriptiveDataSet);
+
+ /**
+ * Returns a {@link TaxonDescription} for a given taxon node with corresponding
+ * features according to the {@link DescriptiveDataSet} and the having the given {@link DescriptionType}.<br>
+ * @param descriptiveDataSetUuid the uuid of the dataset defining the features
+ * @param taxonNodeUuid the uuid of the taxon node that links to the taxon
+ * @param descriptionType the {@link DescriptionType} that the description should have
+ * @return the found taxon description or <code>null</code>
+ */
+ public TaxonDescription findTaxonDescriptionByDescriptionType(UUID dataSetUuid, UUID taxonNodeUuid, DescriptionType descriptionType);
/**
* Creates a taxon row wrapper object for the given description
- * @param description the taxon description for which the wrapper should be created
+ * @param taxonDescriptionUuid the taxon description for which the wrapper should be created
* @param descriptiveDataSet the data set it should be used in
* @return the created row wrapper
*/
- public TaxonRowWrapperDTO createTaxonRowWrapper(TaxonDescription description, DescriptiveDataSet descriptiveDataSet);
+ public TaxonRowWrapperDTO createTaxonRowWrapper(UUID taxonDescriptionUuid, UUID descriptiveDataSetUuid);
/**
* Returns a {@link SpecimenDescription} for a given specimen with corresponding
* will be returned. A new one will be created otherwise.
* @param descriptiveDataSetUuid the uuid of the dataset defining the features
* @param specimenUuid the uuid of the specimen
+ * @param addDatasetSource if <code>true</code> the source(s) of the descriptive dataset
+ * will be added to the description <b>if</b> a new one is created
* @return either the found specimen description or a newly created one
*/
- public SpecimenDescription findSpecimenDescription(UUID descriptiveDataSetUuid, UUID specimenUuid);
-
- /**
- * Returns a {@link TaxonDescription} for a given taxon node with corresponding
- * features according to the {@link DescriptiveDataSet}.<br>
- * If a description is found that matches all features of the data set this description
- * will be returned. Otherwise a new one will be created if specified.
- * @param descriptiveDataSetUuid the uuid of the dataset defining the features
- * @param taxonNodeUuid the uuid of the taxon node that links to the taxon
- * @param create if <code>true</code> a new description will be created
- * if none could be found
- * @return either the found taxon description or a newly created one
- */
- public TaxonDescription findDefaultTaxonDescription(UUID descriptiveDataSetUuid, UUID taxonNodeUuid, boolean create);
+ public SpecimenDescription findSpecimenDescription(UUID descriptiveDataSetUuid, UUID specimenUuid, boolean addDatasetSource);
/**
* Creates a new taxon description with the features defined in the dataset for the
* taxon associated with the given taxon node.
* @param descriptiveDataSetUuid the uuid of the dataset defining the features
* @param taxonNodeUuid the uuid of the taxon node that links to the taxon
- * @param markerType the type of the description
- * @param markerFlag the flag of the marker
+ * @param descriptionType the type of the description
* @return a taxon row wrapper of the description with the features defined in the data set
*/
- public TaxonRowWrapperDTO createTaxonDescription(UUID dataSetUuid, UUID taxonNodeUuid, MarkerType markerType, boolean markerFlag);
+ public TaxonRowWrapperDTO createTaxonDescription(UUID dataSetUuid, UUID taxonNodeUuid, DescriptionType descriptionType);
+
+ /**
+ * Removes the description specified by the given {@link UUID} from the given {@link DescriptiveDataSet}.
+ * @param descriptionUuid the UUID of the description to delete
+ * @param descriptiveDataSetUuid the UUID of the data set to delete
+ * @return the result of the operation
+ */
+ public DeleteResult removeDescription(UUID descriptionUuid, UUID descriptiveDataSetUuid);
/**
* Loads all taxon nodes that match the filter set defined in the
*
*/
public List<TaxonNode> loadFilteredTaxonNodes(DescriptiveDataSet descriptiveDataSet, List<String> propertyPaths);
+
+ /**
+ * Aggregates the character data of the given {@link DescriptiveDataSet}.<br>
+ * <br>
+ * For all {@link SpecimenDescription}s belonging to this data set new,
+ * aggregated {@link TaxonDescription}s are created for every taxon the specimens are
+ * directly associated with.
+ * @param descriptiveDataSetUuid the uuid of the descriptive data set to which the
+ * aggregated descriptions will be added to
+ * @param config the aggregation configuration
+ * @param monitor the progress monitor
+ * @return the result of the operation
+ */
+ public UpdateResult aggregate(UUID descriptiveDataSetUuid, DescriptionAggregationConfiguration config, IProgressMonitor monitor);
+
}
BGBM BDI Projects / cdmlib.git / blobdiff