search

cimug-org / CIMTool

CIMug's CIMTool for the Common Information Model (CIM).
http://cimtool.ucaiug.io/
GNU Lesser General Public License v2.1
43 stars 5 forks source link

PlantUML class diagram builders are needed for diagrams that represent XSD profiles #176

Open tviegut opened 3 weeks ago

tviegut commented 3 weeks ago

In the 2.2.0 release the puml-l2r.xsl and puml-t2b.xsl builders were introduced to support class diagrams representing RDFS profiles. Comparable to these builders we need class diagrams that represent the profiles that correspond to XSDs. As a part of this task the following should be performed:

Special note that thought needs to be put into how to represent both XSD choices (i.e. UML unions) and XOR as part of the implementation of the XSD diagram builders.

Sveino commented 3 weeks ago

We should also make it ready to support RDF - the instance data. CIMTool do today support validation of the CIM XML. I am not sure that CIMTool targeted is to support full install data support, but for doing DevOps or rather SchemaOps we would need to have test data in RDF that we can test the creation of the Schema / Profile against. In this we need to be able to visualise (and most like develop) the test data. The development could be done in LinkML but the visualisation would be very useful to include in CIMTool. Fist stage would just be to make it ready. We should investigate the repo: https://github.com/VladimirAlexiev/rdf2rml

tviegut commented 2 weeks ago

We should also make it ready to support RDF - the instance data. CIMTool do today support validation of the CIM XML. I am not sure that CIMTool targeted is to support full install data support, but for doing DevOps or rather SchemaOps we would need to have test data in RDF that we can test the creation of the Schema / Profile against. In this we need to be able to visualise (and most like develop) the test data. The development could be done in LinkML but the visualisation would be very useful to include in CIMTool. Fist stage would just be to make it ready. We should investigate the repo: https://github.com/VladimirAlexiev/rdf2rml

@Sveino : This is a great suggestion and makes sense for the use cases you highlight above. I just took a peek at the link you provided to Vladimir's site. That's excellent and looks like it could be the very thing we could integrate to render those diagrams. Thanks for the heads up on that as I had not seen that previously. On a side note, I had experimented just a little bit at what existing options for PlantUML for rendering the JSON-LD instance data. I did a really simplistic conversion (not necessarily accurate but usable for my purposes to render something). Below was a sample of JSON data. We'll have to take a look down the road and put our collective heads together to see what may seem best.

image

Sveino commented 2 weeks ago

Maybe this issue is resolving #183