Project

General

Profile

Actions

task #9975

open

Create new UML diagramms for the CDM

Added by Andreas Müller over 2 years ago. Updated over 1 year ago.

Status:
Resolved
Priority:
New
Category:
documentation
Target version:
Start date:
05/04/2022
Due date:
08/15/2022 (over 2 years late)
% Done:

70%

Estimated time:
Severity:
normal

Description

tools, e.g. https://en.wikipedia.org/wiki/List_of_Unified_Modeling_Language_tools

Tools:

UPDATE:

  • for now we decided to use UML Designer

Maybe also interesting: http://doctoolchain.org/docToolchain/v2.0.x/ , https://www.heise.de/news/software-architektur-tv-Mehr-als-Pfeile-und-Kaesten-Architekturdiagramme-7380252.html , https://plantuml.com/de/


Files

clipboard-202303201631-yexpw.png (505 Bytes) clipboard-202303201631-yexpw.png Andreas Müller, 03/20/2023 04:31 PM
clipboard-202303201639-wupm1.png (16.9 KB) clipboard-202303201639-wupm1.png Andreas Müller, 03/20/2023 04:39 PM
clipboard-202303201640-w1tsk.png (6.71 KB) clipboard-202303201640-w1tsk.png Andreas Müller, 03/20/2023 04:40 PM
clipboard-202303201642-io4jl.png (1.43 KB) clipboard-202303201642-io4jl.png Andreas Müller, 03/20/2023 04:42 PM
clipboard-202303201645-yxlca.png (2.34 KB) clipboard-202303201645-yxlca.png Andreas Müller, 03/20/2023 04:45 PM
clipboard-202303201701-16jcd.png (1.93 KB) clipboard-202303201701-16jcd.png Andreas Müller, 03/20/2023 05:01 PM
clipboard-202303201705-ss1hh.png (1.71 KB) clipboard-202303201705-ss1hh.png Andreas Müller, 03/20/2023 05:05 PM
clipboard-202303201743-prll7.png (3.11 KB) clipboard-202303201743-prll7.png Andreas Müller, 03/20/2023 05:43 PM
clipboard-202303201758-ousx7.png (756 Bytes) clipboard-202303201758-ousx7.png Andreas Müller, 03/20/2023 05:58 PM

Related issues

Related to EDIT - bug #5284: [UML] Replace Scope by DefinedTerm in PolytomousKey UMLDuplicateAndreas Müller

Actions
Actions #1

Updated by Andreas Müller over 2 years ago

There are a few tickets in the UML 5.X milestone that are related.

Actions #2

Updated by Andreas Müller over 2 years ago

  • Due date set to 04/29/2022
  • Start date set to 04/01/2022
Actions #3

Updated by Andreas Müller over 2 years ago

  • Target version changed from Release 5.51 to Release 5.32
Actions #4

Updated by Andreas Müller over 2 years ago

  • Description updated (diff)
Actions #5

Updated by Andreas Müller over 2 years ago

  • Due date changed from 04/29/2022 to 05/10/2022
  • Start date changed from 04/01/2022 to 05/04/2022
Actions #6

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #7

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #8

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #9

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #10

Updated by Andreas Müller about 2 years ago

  • Due date changed from 05/10/2022 to 08/15/2022
  • Status changed from New to Discussed
  • Assignee changed from Katja Luther to Belen Escobari
  • Target version changed from Release 5.32 to Release 5.49

There is a new repository for all platform UML documentation at ssh://git@dev.e-taxonomy.eu/var/git/platform.git .

I discussed this with Belen E. today and we decided that she will try to implement this. Therefore I change the ticket assignee to her.

Actions #11

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #12

Updated by Andreas Müller about 2 years ago

java->uml generation is documented at: https://www.umldesigner.org/ref-doc/umlgen.html (Java to UML)

Actions #13

Updated by Andreas Müller about 2 years ago

  • % Done changed from 0 to 10
Actions #14

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #15

Updated by Andreas Müller about 2 years ago

  • Description updated (diff)
Actions #16

Updated by Belen Escobari about 2 years ago

UPDATE:

three tools were reconsidered:

UML_Designer(alignt center) Papyrus(align center) Modelio (align center)
Version 9.0 6.2.0 5.1
Open source yes yes yes
Reverse Engineering yes (not managed yet) yes (not managed yet) yes
Export HTML file yes (requieres OBEOnot tried yet) yes (not tried yet) yes

Modelio (https://www.eclipse.org/papyrus/documentation.html):
Easy to manage. Well documented.

Papyrus (https://www.eclipse.org/papyrus/documentation.html):
Not very intuitive and some features are not shown in the documentation.

For now we decide to try to install the Modelio 5.1 in Eclipse and resolve whether RE and HTML is possible with the other two softares.

Actions #17

Updated by Andreas Müller about 2 years ago

  • Tags set to documentation

Can you still format the above comment as real table (see https://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingMarkdown#Tables for how to)

Actions #18

Updated by Belen Escobari about 2 years ago

UPDATE:

We decided to use UML Lab (https://www.yatta.de/products/uml-lab/de/download/)

Pros:

  • Easy to handle
  • Revers Engineering very straightforward
  • Nice diagrams
  • Can be implemented in Eclipse

Contras:

  • no HTML file possible
  • not free of charge (apparently a institutional account can be used to get it for free)
Actions #19

Updated by Belen Escobari almost 2 years ago

Diagrams are now available in edit-community (160.45.63.172) /var/www/wp5.e-taxonomy.eu/cdm-uml/2022-09-13/model&Diagrams.

It includes the whole code on which the diagrams were generated (only model folder). Each folder has its respective(s) diagram(s) as .umlcd and .png files.

Additionally, a diagram with all the unused classes is included.

Actions #20

Updated by Andreas Müller almost 2 years ago

  • Status changed from Discussed to Feedback
  • Target version changed from Release 5.49 to Release 5.35
  • % Done changed from 10 to 50

Diagrams currently available at https://cybertaxonomy.org/cdm-uml/v532/

Actions #21

Updated by Andreas Müller almost 2 years ago

  • Related to bug #5284: [UML] Replace Scope by DefinedTerm in PolytomousKey UML added
Actions #23

Updated by Andreas Müller over 1 year ago

  • Status changed from Feedback to Resolved
  • Assignee changed from Belen Escobari to Andreas Müller
  • Target version changed from Release 5.35 to Release 5.49

please review

Actions #24

Updated by Andreas Müller over 1 year ago

  • Description updated (diff)
Actions #25

Updated by Andreas Müller over 1 year ago

  • Description updated (diff)
Actions #26

Updated by Andreas Müller over 1 year ago

  • Description updated (diff)
Actions #27

Updated by Andreas Müller over 1 year ago

Some issues:

  • root node should not expandable/collapsable

  • the following symbol does not seem to have an (important) meaning, can we remove it

  • cardinality often is not correct, e.g. cardinality between team and person is

but should be

  • termMap relationships are generally not needed and should be removed everywhere

  • also for sets and lists cardinality are not correct, usually they be 0..* not 1..*

  • termMap should also be removed from TextFormat and PresenceAbsenceTerm

...

Actions #28

Updated by Andreas Müller over 1 year ago

  • clicking 2x on the diagram symbol should not remove the diagram
  • the clicked diagram should get a focus indication so one knows which diagram is selected, e.g.
  • the "source" needs better ordering
  • CdmBase and VersionableEntity are missing in User diagram
  • the "common" diagram can be removed
  • change order "descriptions"<->"keys" diagram
  • add available NamedAreaLevels to NamedAreaLevel in location diagram
  • remove termMap, labelMap, isoA2Map from Country
  • add IMediaDocumented and IMediaEntity to the media diagram
  • remove STRING_LIST_SEPARATOR and VALUE_LENGTH from CdmPreference (in metadata)
  • remove all unlinked classes from "metadata" except for PreferenceSubject and CdmVersion
  • remove SequenceDirection from molecular
  • add a name interface diagram for all name interfaces (like IBotancialName, ITaxonName, IViralName, ...) similary to the interfaces in the references package
  • remove all methods/attributes in rank table above EMPIRE() and below UNRANKED_INFRAGENERIC()
  • remove all methods from NomenclaturalCode and add (again?) all methods representing a nomenclatural code (ICNB, ICNAFP, OCNCP, ICZN, ICVCN, Fungi)
  • cardinality for "exactLocation" in GatheringEvent
  • remove the explicit language handling in occurrence diagram, e.g.
  • remove all methods from ITaxonTreeNode
  • add TeamOrPersonBase to "Taxon" and link to TaxonNodeAgentRelation
  • ... also add DefinedTerm with methods AUTHOR and LAST_SCRUTINY and link to TaxonNodeAgentRelation
  • remove all xxxException and TermLoader, DefaultTermInitializer and VocabularyEnum from Term diagram
  • remove all methods form DefinedTerm in Term diagram
  • discuss, if we need TermBase and Term diagram
  • remove all "code" symbols:
  • remove default values like " = modeThreadLocal" or " = new ThreadLocal" from tables in Audit diagram
Actions #29

Updated by Andreas Müller over 1 year ago

  • Status changed from Resolved to Feedback
  • Assignee changed from Andreas Müller to Belen Escobari
Actions #30

Updated by Andreas Müller over 1 year ago

Remove all not necessary files from https://cybertaxonomy.org/cdm-uml/v532/ (e.g. all java files)

Actions #31

Updated by Belen Escobari over 1 year ago

  • Status changed from Feedback to Resolved
  • Assignee changed from Belen Escobari to Andreas Müller
  • % Done changed from 50 to 70
Actions #32

Updated by Belen Escobari over 1 year ago

  • Target version changed from Release 5.49 to Release 5.37
Actions #33

Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 5.37 to Release 5.49

We will need further finetuning and also commit + installation so there is further work to do and we keep in 5.38

Actions

Also available in: Atom PDF