task #9975
openCreate new UML diagramms for the CDM
Added by Andreas Müller over 2 years ago. Updated over 1 year ago.
70%
Description
tools, e.g. https://en.wikipedia.org/wiki/List_of_Unified_Modeling_Language_tools
Tools:
UML Designer (https://www.umldesigner.org/ ): integrated into Eclipse, still unclear how to create diagrams
- reverse engineering java->uml: https://www.umldesigner.org/ref-doc/umlgen.html
UModel (Altova, https://www.altova.com/umodel ): we may check if this is offered by ZEDAT as there is also a licence for xmlspy
Draw.io (https://www.diagrams.net/ - formerly draw.io): good online tool for many types of diagrams, not sure if reverse engineering from java classes works
Other possibilities: https://marketplace.eclipse.org/content/objectaid-uml-explorer (looks like not supported anymore => no option) or https://www.eclipse.org/papyrus/ (both eclipse based)
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
Related issues
Updated by Andreas Müller over 2 years ago
There are a few tickets in the UML 5.X milestone that are related.
Updated by Andreas Müller over 2 years ago
- Due date set to 04/29/2022
- Start date set to 04/01/2022
Updated by Andreas Müller over 2 years ago
- Target version changed from Release 5.51 to Release 5.32
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
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.
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)
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.
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)
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)
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.
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/
Updated by Andreas Müller almost 2 years ago
- Related to bug #5284: [UML] Replace Scope by DefinedTerm in PolytomousKey UML added
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
Updated by Andreas Müller over 1 year ago
- File clipboard-202303201631-yexpw.png clipboard-202303201631-yexpw.png added
- File clipboard-202303201639-wupm1.png clipboard-202303201639-wupm1.png added
- File clipboard-202303201640-w1tsk.png clipboard-202303201640-w1tsk.png added
- File clipboard-202303201642-io4jl.png clipboard-202303201642-io4jl.png added
- File clipboard-202303201645-yxlca.png clipboard-202303201645-yxlca.png added
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
...
Updated by Andreas Müller over 1 year ago
- File clipboard-202303201701-16jcd.png clipboard-202303201701-16jcd.png added
- File clipboard-202303201705-ss1hh.png clipboard-202303201705-ss1hh.png added
- File clipboard-202303201743-prll7.png clipboard-202303201743-prll7.png added
- File clipboard-202303201758-ousx7.png clipboard-202303201758-ousx7.png added
- 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
Updated by Andreas Müller over 1 year ago
- Status changed from Resolved to Feedback
- Assignee changed from Andreas Müller to Belen Escobari
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)
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
The new diagrams were updated
https://cybertaxonomy.org/cdm-uml/v532/webpage/Diagrams.html
Updated by Belen Escobari over 1 year ago
- Target version changed from Release 5.49 to Release 5.37
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