Project

General

Profile

feature request #7695

web service providing compact TypeDesignation representation for homotypic groups and individual taxa

Added by Andreas Kohlbecker about 1 year ago. Updated about 1 month ago.

Status:
In Progress
Priority:
Highest
Category:
cdmlib-remote
Target version:
Start date:
08/28/2018
Due date:
% Done:

30%

Severity:
normal

Description

The webservice path:

  • typedesignations/byTaxon/{taxon_uuid}, typedesignations/byHomotypicalGroup/{group_uuid} (optinal) rejected
  • /name/{uuid}/homotypicGroupTypeDesignationsDTO --> returns a TaggedText List and /name/{uuid}/homotypicGroupTypeDesignations returns a list of TypeDesignations

implementation of the controller method:

  1. get all typedesignations of all names in the homotypic group to which the taxon belongs
  2. pass the typedesignations to the TypeDesignationSetManager constructor TypeDesignationSetManager(Collection typeDesignations)
  3. return toTaggedText()

TODO:


Related issues

Related to Edit - feature request #6718: Constistent TypeDesignation representation creation New 06/12/2017
Related to Edit - feature request #7700: use TypeDesignationSetManager for creating typedesignation string in cdmlightExport Resolved 08/29/2018
Blocked by Edit - task #7553: move TypeDesignationSetManagerIT to cdmlib Closed 07/12/2018
Precedes Edit - feature request #7696: use compact type representations in the synonymy as provided by the typedesignations/byTaxon/{taxon_uuid} service New 08/29/2018
Copied to Edit - feature request #7863: /homotypicGroup/{uuid}/homotypicGroupTypeDesignationsDTO webservice implemented New 10/24/2018

Associated revisions

Revision 0f793f18 (diff)
Added by Andreas Kohlbecker about 1 year ago

ref #7695 initial implementation of the /name/{uuid}/homotypicGroupTypeDesignationsDTO webservice - with problems

History

#1 Updated by Andreas Kohlbecker about 1 year ago

  • Precedes feature request #7696: use compact type representations in the synonymy as provided by the typedesignations/byTaxon/{taxon_uuid} service added

#2 Updated by Andreas Kohlbecker about 1 year ago

#3 Updated by Andreas Kohlbecker about 1 year ago

  • Description updated (diff)

changing the controller endpoint to /name/{uuid}/homotypicGroupTypeDesignationsDTO, issue description updated.

#4 Updated by Andreas Kohlbecker about 1 year ago

The TypeDesignationSetManager needs to be modified, so that it can be used for multiple usecases. By default it validates the typified names for consistency which only makes sense in the context of Registrations:

eu.etaxonomy.cdm.api.service.exception.RegistrationValidationException: Inconsistent type designations - Problems:- Multiple typifiedName in SpecimenTypeDesignation#46<79b05729-27b3-4f81-aaf4-0e51d5bca0a6>|- Multiple typifiedName in SpecimenTypeDesignation#48<21e16eb9-11c8-40a6-aa49-af63a3a4c2e7>|- Multiple typifiedName in SpecimenTypeDesignation#49<a7b518b8-56c8-413b-8a1c-27b00a6851e3>|- Multiple typifiedName in SpecimenTypeDesignation#50<20e1f899-7135-488d-b44d-64ccafc14268>|- Multiple typifiedName in SpecimenTypeDesignation#47<66708678-eeb6-4fe0-8938-4dc8b8f6f233>|- Multiple typifiedName in SpecimenTypeDesignation#51<4bb431e9-0a86-47e2-b5f9-53edb11a964a>|- Multiple typifiedName in SpecimenTypeDesignation#52<b56ee71c-e842-4f28-9c44-5157dcd522cc>|- Multiple typifiedName in SpecimenTypeDesignation#53<af89b6d8-89e2-4a4f-864a-49b63e83cdae>|- Multiple typifiedName in SpecimenTypeDesignation#54<bf0fc5f6-0593-4f44-ae45-7b5c2007a688>|
    at eu.etaxonomy.cdm.api.service.name.TypeDesignationSetManager.findTypifiedName(TypeDesignationSetManager.java:393)
    at eu.etaxonomy.cdm.api.service.name.TypeDesignationSetManager.<init>(TypeDesignationSetManager.java:114)
    at eu.etaxonomy.cdm.remote.controller.NameController.doHomotypicGroupTypeDesignations(NameController.java:145)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
  1. This validation needs to be optional, see findTypifiedName()
  2. The properties typifiedName and typifiedNameRef only make sense in the context of registrations

#5 Updated by Andreas Müller about 1 year ago

  • Status changed from New to In Progress

I wonder if we should really require a single name uuid as obligatory input parameter. The semantics of the service should be

  • input: homotypicGroup uuid
  • output: formatted type designations for the given group as TaggedText and maybe some additional information

The requirement to also have some name uuid as input is not necessary.

#6 Updated by Andreas Müller about 1 year ago

  • Related to feature request #7700: use TypeDesignationSetManager for creating typedesignation string in cdmlightExport added

#7 Updated by Andreas Kohlbecker about 1 year ago

  • Blocked by task #7553: move TypeDesignationSetManagerIT to cdmlib added

#8 Updated by Andreas Kohlbecker about 1 year ago

  • Target version changed from Release 5.3 to Release 5.4

#9 Updated by Andreas Kohlbecker 12 months ago

Andreas Müller wrote:

I wonder if we should really require a single name uuid as obligatory input parameter. The semantics of the service should be

  • input: homotypicGroup uuid
  • output: formatted type designations for the given group as TaggedText and maybe some additional information

The requirement to also have some name uuid as input is not necessary.

In a past discussion during a standup of the whole edit developer team, we came to the conclusion that it is useful to keep the name uuid as parameter but to also add the homotypicGroup uuid as additional parameter.

#10 Updated by Andreas Kohlbecker 12 months ago

currently we don't have a web service controller with /homotypicGroup/ as base path. This would be a requirement for the above feature request. I will copy the feature request to a new ticket ...

#11 Updated by Andreas Kohlbecker 12 months ago

  • Copied to feature request #7863: /homotypicGroup/{uuid}/homotypicGroupTypeDesignationsDTO webservice implemented added

#12 Updated by Andreas Kohlbecker 12 months ago

  • Status changed from In Progress to Feedback
  • Assignee changed from Andreas Kohlbecker to Andreas Müller
  • % Done changed from 0 to 30

... #7863

the last open issue regarding this is mentioned in #7695#note-4

who needs this and will continue the work?

#13 Updated by Andreas Müller 12 months ago

  • Target version changed from Release 5.4 to Release 5.5

#14 Updated by Andreas Müller 9 months ago

  • Status changed from Feedback to Resolved
  • Assignee changed from Andreas Müller to Katja Luther

Katja, you already have worked on the type designation manager. Could you have a look on the open issue?

#15 Updated by Katja Luther 9 months ago

  • Target version changed from Release 5.5 to Release 5.6

yes, but I move it to the next release.

#16 Updated by Andreas Müller 8 months ago

  • Status changed from Resolved to In Progress

#17 Updated by Andreas Müller 8 months ago

  • Target version changed from Release 5.6 to Reviewed Next Major Release

#18 Updated by Andreas Kohlbecker about 1 month ago

  • Assignee changed from Katja Luther to Andreas Kohlbecker

The TextualTypeDesignation also need to be handled by the TypeDesignationSetManager currently the controller method gets all type designations for a taxon name and passes this list to the TypeDesignationSetManager. This list can also include TextualTypeDesignations:

TypeDesignationSetManager manager = new TypeDesignationSetManager(typeDesignations);
return manager.toTaggedText();

#19 Updated by Andreas Kohlbecker about 1 month ago

  • Description updated (diff)

#20 Updated by Andreas Kohlbecker about 1 month ago

  • Target version changed from Reviewed Next Major Release to Release 5.10

moving to release 5.10 as this is prerequisite for #7696

#21 Updated by Andreas Kohlbecker about 1 month ago

  • Target version changed from Release 5.10 to Release 5.11

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 40 MB)