import eu.etaxonomy.cdm.api.service.config.FindOccurrencesConfigurator;\r
import eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator;\r
import eu.etaxonomy.cdm.api.service.config.SpecimenDeleteConfigurator;\r
+import eu.etaxonomy.cdm.api.service.dto.DerivedUnitDTO;\r
import eu.etaxonomy.cdm.api.service.dto.FieldUnitDTO;\r
-import eu.etaxonomy.cdm.api.service.dto.PreservedSpecimenDTO;\r
+import eu.etaxonomy.cdm.api.service.dto.SpecimenOrObservationBaseDTO;\r
import eu.etaxonomy.cdm.api.service.pager.Pager;\r
import eu.etaxonomy.cdm.api.service.search.LuceneParseException;\r
import eu.etaxonomy.cdm.api.service.search.SearchResult;\r
import eu.etaxonomy.cdm.model.description.DescriptionElementBase;\r
import eu.etaxonomy.cdm.model.description.IndividualsAssociation;\r
import eu.etaxonomy.cdm.model.description.TaxonDescription;\r
-import eu.etaxonomy.cdm.model.location.Country;\r
+import eu.etaxonomy.cdm.model.location.Point;\r
import eu.etaxonomy.cdm.model.media.Media;\r
import eu.etaxonomy.cdm.model.molecular.DnaSample;\r
import eu.etaxonomy.cdm.model.molecular.Sequence;\r
\r
/**\r
* @author a.babadshanjan\r
- * @created 01.09.2008\r
+ * @since 01.09.2008\r
*/\r
-public interface IOccurrenceService extends IIdentifiableEntityService<SpecimenOrObservationBase> {\r
-\r
- public Country getCountryByIso(String iso639);\r
-\r
- public List<Country> getCountryByName(String name);\r
+public interface IOccurrenceService\r
+ extends IIdentifiableEntityService<SpecimenOrObservationBase> {\r
\r
/**\r
* Returns a paged list of occurrences that have been determined to belong\r
* @param taxonbase the taxon concept associated with these determinations (can be null for all taxon concepts)\r
* @return a count of determination events\r
*/\r
- public int countDeterminations(SpecimenOrObservationBase occurence,TaxonBase taxonbase);\r
+ public long countDeterminations(SpecimenOrObservationBase occurence,TaxonBase taxonbase);\r
\r
/**\r
* Returns a List of determinations that have been made for a given occurence\r
* a list of {@link UUID}s of the taxon nodes\r
* @param limit\r
* @param start\r
- * @param orderHints\r
* @return a collection of {@link SpecimenNodeWrapper} containing the\r
* {@link TaxonNode} and the corresponding {@link UuidAndTitleCache}\r
* object for the specimen found for this taxon node\r
*/\r
public Collection<SpecimenNodeWrapper> listUuidAndTitleCacheByAssociatedTaxon(List<UUID> taxonNodeUuids,\r
- Integer limit, Integer start, List<OrderHint> orderHints);\r
+ Integer limit, Integer start);\r
\r
\r
/**\r
- * Lists all instances of {@link FieldUnit} which are\r
+ * Lists all root units which are\r
* associated <b>directly or indirectly</b>with the <code>taxon</code> specified\r
* as parameter. "Indirectly" means that a sub derivate of the FieldUnit is\r
* directly associated with the given taxon.\r
*\r
* @param <T>\r
* @param type\r
+ * Restriction to a specific subtype, may be null.\r
* @param associatedTaxon\r
* @param Set<TaxonRelationshipVector> includeRelationships. TaxonRelationships will not be taken into account if this is <code>NULL</code>.\r
* @param maxDepth TODO\r
* @param propertyPaths\r
* @return\r
*/\r
- public Collection<SpecimenOrObservationBase> listFieldUnitsByAssociatedTaxon(Taxon associatedTaxon, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ public <T extends SpecimenOrObservationBase> Collection<T> listRootUnitsByAssociatedTaxon(Class<T> type, Taxon associatedTaxon, List<OrderHint> orderHints, List<String> propertyPaths);\r
+\r
+\r
+ /**\r
+ * @deprecated replace by {@link #listRootUnitsByAssociatedTaxon(Class, Taxon, List, List)}\r
+ */\r
+ @Deprecated\r
+ public Collection<FieldUnit> listFieldUnitsByAssociatedTaxon(Taxon associatedTaxon, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* See {@link #listFieldUnitsByAssociatedTaxon(Set, Taxon, Integer, Integer, Integer, List, List)}\r
*/\r
- public Pager<SpecimenOrObservationBase> pageFieldUnitsByAssociatedTaxon(Set<TaxonRelationshipEdge> includeRelationships,\r
+ public <T extends SpecimenOrObservationBase> Pager<T> pageRootUnitsByAssociatedTaxon(Class<T> type, Set<TaxonRelationshipEdge> includeRelationships,\r
Taxon associatedTaxon, Integer maxDepth, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* See {@link #listByAssociatedTaxon(Class, Set, Taxon, Integer, Integer, Integer, List, List)}\r
*\r
* @param type\r
+ * Restriction to subtype of <code>SpecimenOrObservationBase</code>, can be NULL.\r
* @param includeRelationships\r
* @param associatedTaxon\r
* @param maxDepth\r
* @return either a collection of FieldUnits this specimen was derived from, the FieldUnit itself\r
* if this was a FieldUnit or an empty collection if no FieldUnits were found\r
*/\r
- public Collection<FieldUnit> getFieldUnits(UUID specimenUuid, List<String> propertyPaths);\r
+ public Collection<FieldUnit> findFieldUnits(UUID specimenUuid, List<String> propertyPaths);\r
+\r
+ /**\r
+ * Retrieves top most originals for a {@link SpecimenOrObservationBase} in the derivation graph by recursively\r
+ * walking all {@link DerivationEvent}s.\r
+ * In most cases item in the returned collection will be {@link FieldUnit FieldUnits} but also DerivedUnits are possible, in\r
+ * cases where no FieledUnit exists.\r
+ *\r
+ * @param specimenUuid the UUID of the specimen\r
+ * @param propertyPaths the property path\r
+ * @return either a collection of root units\r
+ */\r
+ public Collection<SpecimenOrObservationBase> findRootUnits(UUID specimenUuid, List<String> propertyPaths);\r
\r
/**\r
* @param clazz\r
public boolean moveDerivate(SpecimenOrObservationBase<?> from, SpecimenOrObservationBase<?> to, DerivedUnit derivate);\r
\r
/**\r
- * Assembles a {@link FieldUnitDTO} for the given field unit uuid which is associated to the {@link Taxon}.<br>\r
- * <br>\r
- * For the meaning of "associated" see also {@link #listFieldUnitsByAssociatedTaxon(Set, Taxon, Integer, Integer, Integer, List, List)}\r
+ * Assembles a {@link FieldUnitDTO} for the given field unit.<br>\r
+ *\r
* @param fieldUnit\r
- * @param associatedTaxonUuid\r
* @return a DTO with all the assembled information\r
*/\r
- public FieldUnitDTO assembleFieldUnitDTO(FieldUnit fieldUnit, UUID associatedTaxonUuid);\r
+ public FieldUnitDTO assembleFieldUnitDTO(FieldUnit fieldUnit);\r
\r
/**\r
- * Assembles a {@link PreservedSpecimenDTO} for the given derived unit.\r
+ * Assembles a {@link DerivedUnitDTO} for the given derived unit.\r
* @param derivedUnit\r
* @return a DTO with all the assembled information\r
*/\r
- public PreservedSpecimenDTO assemblePreservedSpecimenDTO(DerivedUnit derivedUnit);\r
+ public DerivedUnitDTO assembleDerivedUnitDTO(DerivedUnit derivedUnit);\r
\r
/**\r
* Deletes the specified specimen according to the setting in the {@link SpecimenDeleteConfigurator}.<br>\r
* @param propertyPaths\r
* @return a collection of associated taxa\r
*/\r
- public Collection<TaxonBase<?>> listIndividualsAssociationTaxa(SpecimenOrObservationBase<?> specimen, Integer limit,\r
- Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ public Collection<TaxonBase<?>> listIndividualsAssociationTaxa(SpecimenOrObservationBase<?> specimen,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ /**\r
+ * @see #listIndividualsAssociationTaxa(SpecimenOrObservationBase, Integer, Integer, List, List)\r
+ */\r
+ public Collection<TaxonBase<?>> listIndividualsAssociationTaxa(SpecimenOrObservationBase<?> specimen, boolean includeUnpublished,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* Retrieves all associated taxa for the given specimen (via type designations, determination, individuals associations)\r
* @param propertyPaths\r
* @return\r
*/\r
- public Collection<TaxonBase<?>> listAssociatedTaxa(SpecimenOrObservationBase<?> specimen, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ public Collection<TaxonBase<?>> listAssociatedTaxa(SpecimenOrObservationBase<?> specimen, boolean includeUnpublished,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ /**\r
+ * @see #listAssociatedTaxa(SpecimenOrObservationBase, Integer, Integer, List, List)axa\r
+ */\r
+ public Collection<TaxonBase<?>> listAssociatedTaxa(SpecimenOrObservationBase<?> specimen,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* Retrieves all taxa that the given specimen is determined as\r
* @param propertyPaths\r
* @return collection of all taxa the given specimen is determined as\r
*/\r
- public Collection<TaxonBase<?>> listDeterminedTaxa(SpecimenOrObservationBase<?> specimen, Integer limit, Integer start,\r
- List<OrderHint> orderHints, List<String> propertyPaths);\r
+ public Collection<TaxonBase<?>> listDeterminedTaxa(SpecimenOrObservationBase<?> specimen, boolean includeUnpublished,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ /**\r
+ * @see #listDeterminedTaxa(SpecimenOrObservationBase, Integer, Integer, List, List)\r
+ */\r
+ public Collection<TaxonBase<?>> listDeterminedTaxa(SpecimenOrObservationBase<?> specimen,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* Retrieves all {@link DeterminationEvent}s which have the given specimen set as identified unit.\r
* @param propertyPaths\r
* @return a collection of all taxa where the given specimen is the type specimen\r
*/\r
- public Collection<TaxonBase<?>> listTypeDesignationTaxa(DerivedUnit specimen, Integer limit,\r
- Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ public Collection<TaxonBase<?>> listTypeDesignationTaxa(DerivedUnit specimen,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
+ /**\r
+ * @see #listTypeDesignationTaxa(DerivedUnit, Integer, Integer, List, List)a\r
+ */\r
+ public Collection<TaxonBase<?>> listTypeDesignationTaxa(DerivedUnit specimen, boolean includeUnpublished,\r
+ Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
/**\r
* Retrieves all {@link SpecimenTypeDesignation}s which have the given specimens as a type specimen.\r
*/\r
public Collection<DescriptionBase<?>> listDescriptionsWithDescriptionSpecimen(SpecimenOrObservationBase<?> specimen, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);\r
\r
- /**\r
- * Gets all description elements that are used for describing the character\r
- * states of the given specimen\r
- *\r
- * @param specimen\r
- * the specimen for which the character state description\r
- * elements should be retrieved\r
- * @return a collection of all character state description elements for this\r
- * specimen\r
- */\r
- public Collection<DescriptionElementBase> getCharacterDataForSpecimen(SpecimenOrObservationBase<?> specimen);\r
-\r
/**\r
* Gets all description elements that are used for describing the character\r
* states of the given specimen\r
* Returns the most significant identifier for the given {@link DerivedUnit}.\r
* @param derivedUnit the derived unit to check\r
* @return the identifier string\r
+ * @deprecated use {@link DerivedUnit#getMostSignificantIdentifier()} instead\r
*/\r
+ @Deprecated\r
public String getMostSignificantIdentifier(DerivedUnit derivedUnit);\r
\r
/**\r
* authorTeam.persistentTitleCache\r
* @return the number of found specimens\r
*/\r
- public int countOccurrences(IIdentifiableEntityServiceConfigurator<SpecimenOrObservationBase> config);\r
+ public long countOccurrences(IIdentifiableEntityServiceConfigurator<SpecimenOrObservationBase> config);\r
\r
/**\r
* Return the all {@link SpecimenOrObservationBase}s of the complete\r
* @param gatheringEventUuid the {@link UUID} of the gathering event\r
* @return a list of field units referencing the gathering event\r
*/\r
- public List<FieldUnit> getFieldUnitsForGatheringEvent(UUID gatheringEventUuid);\r
+ public List<FieldUnit> findFieldUnitsForGatheringEvent(UUID gatheringEventUuid);\r
\r
\r
/**\r
public Pager<UuidAndTitleCache<SpecimenOrObservationBase>> findByTitleUuidAndTitleCache(\r
FindOccurrencesConfigurator config);\r
\r
+ /**\r
+ * Returns a list of {@link DerivedUnitDTO} for the specimens found with the\r
+ * given configurator\r
+ * @param config the configurator for the search\r
+ * @return a list of {@link DerivedUnitDTO} object\r
+ */\r
+ @Transactional(readOnly = true)\r
+ public List<DerivedUnitDTO> findByTitleDerivedUnitDTO(\r
+ FindOccurrencesConfigurator config);\r
+\r
+\r
+ /**\r
+ * Collects the <code>FieldUnits</code> which are at the root of the derivation event\r
+ * graph in which the {@link DerivedUnit} with the specified <code>findByAccessionNumber</code>\r
+ * is found.\r
+ */\r
+ SpecimenOrObservationBaseDTO findByAccessionNumber(String accessionNumberString, List<OrderHint> orderHints);\r
+\r
+\r
+ List<SpecimenOrObservationBaseDTO> listRootUnitDTOsByAssociatedTaxon(Set<TaxonRelationshipEdge> includedRelationships,\r
+ UUID associatedTaxonUuid, List<String> propertyPaths);\r
+\r
+ public List<Point> findPointsForFieldUnitList(List<UUID> fieldUnitUuids);\r
+\r
+ /**\r
+ * Load the FieldUnitDTO for the given <code>derivedUnitUuid</code> with all intermediate derivatives and {@link eu.etaxonomy.cdm.api.service.dto.GatheringEventDTO}\r
+\r
+ * @param derivedUnitUuid\r
+ * @return\r
+ */\r
+ FieldUnitDTO loadFieldUnitDTO(UUID derivedUnitUuid);\r
+\r
}\r
BGBM BDI Projects / cdmlib.git / blobdiff