Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UML diagram #404

Closed
nicholascar opened this issue Sep 24, 2018 · 35 comments
Closed

UML diagram #404

nicholascar opened this issue Sep 24, 2018 · 35 comments
Assignees
Labels
due for closing Issue that is going to be closed if there are no objection within 6 days profiles-vocabulary For discussion of profile description vocabulary

Comments

@nicholascar
Copy link
Contributor

nicholascar commented Sep 24, 2018

This issue was created in the Profiles Ontology document and is listed in it. Once consensus on addressing it is reached here in comments below, the results will be added to the document and the issue closed.

Is a non-OWL, UML/class diagram needed here?

@nicholascar nicholascar added the profiles-vocabulary For discussion of profile description vocabulary label Sep 24, 2018
@dr-shorthair
Copy link
Contributor

Where?

@riccardoAlbertoni
Copy link
Contributor

The choice between an OWL or UML diagram might depend on the kind of user target we want to address.

A UML diagram addresses a larger audience and it is probably more effective in giving an overview of the data properties to use but it might also be a source of misunderstanding (e.g. OWA /CWA interpretations). So I am quite split about this.

@agbeltran
Copy link
Member

This is for the conceptual model section: https://w3c.github.io/dxwg/profilesont/#conceptualmodel

I think that if clearly stated that the UML diagram is for visualization purposes and that it should be interpreted within the open world assumption (as it was done in the revised DCAT spec), the UML diagram could be effective for a wider audience.

@aisaac
Copy link
Contributor

aisaac commented Oct 22, 2018

I guess I don't have a strong preference, except that it doesn't matter as long as it's easy to read. Recent specs have gone for many variants:
https://www.w3.org/TR/vocab-dcat/#vocabulary-overview
https://www.w3.org/TR/odrl-model/#infoModel
https://www.w3.org/TR/vocab-duv/#Vocab_Overview
(and of course this one by @riccardoAlbertoni and I: https://www.w3.org/TR/vocab-dqv/#model ;-) )

These are somewhere UML and OWL. Maybe they look more like (abridged) UML, especially the DCAT one. In any case I'd be struggling to identify what counts as an 'OWL diagram', anyway. Is there a standard way to make one?

@rob-metalinkage
Copy link
Contributor

Likewise, I'm agnostic - UML has special types of arrows to shortcut subclassing relationships but the whole thing is so simple it shouldnt be a big deal.

@dr-shorthair
Copy link
Contributor

I used a UML IDE for the DCAT diagram. That makes it easy to layout and maintain, but means that some UML aspects cannot be adjusted.

If someone wants to re-draft it to be less UMLy then you are welcome.

@rob-metalinkage
Copy link
Contributor

note i deleted my comment here about sequence diagrams - that was for the conneg document :-)

@rob-metalinkage
Copy link
Contributor

but then again - this is assigned to me - and there isnt for for the conneg document - so maybe it was the right place and this is mis-labelled?

@nicholascar
Copy link
Contributor Author

nicholascar commented Oct 23, 2018

@aisaac "...what counts as an 'OWL diagram', anyway..."
Just diagram using OWL classes and properties, as your DQV diagram does and the current diagram is this already.

Perhaps all I've not done so far then is to add in some colour!

@aisaac
Copy link
Contributor

aisaac commented Oct 23, 2018

@nicholascar ok then I guess I'm fine with an "OWL diagram" if it's whatever renders the OWL ontology in a clear way - it's not very different from the UML diagrams after all.

I guess a conclusion to the issue is that yes there needs to be a diagram, and until further guidance it can be in whatever the editors feel appropriate?

@nicholascar nicholascar added the due for closing Issue that is going to be closed if there are no objection within 6 days label Nov 1, 2018
@nicholascar
Copy link
Contributor Author

Due for closing as we are using an improved version of the current 'OWL' diagram for now.

@aisaac
Copy link
Contributor

aisaac commented Nov 7, 2018

Fine with me. Maybe one suggestion (which I'd let you editors decide on, freely) to use UML style for subclass arrows.

@agbeltran
Copy link
Member

+1 to using UML style for subclass arrows, I think it would make the diagram clearer

@nicholascar
Copy link
Contributor Author

@agbeltran agree in principle, it's only a practical thing preventing me from implementing this: I can't make open arrowheads in PowerPoint easily! I'll work out how to do this or ultimately use another diagramming tool in final versions if I can't.

@aisaac
Copy link
Contributor

aisaac commented Nov 13, 2018

@nicholascar maybe you can send us the source and we see whether we can fix it? Different versions of powerpoint offer different features. Who knows, maybe I have this in mine :-).

@larsgsvensson
Copy link
Contributor

I think there is an error in the diagram: Shouldn't the property arrow isProfileOf between Profile and BaseSpecification go from Profile to BaseSpecification similarly to the relation between Profile and dct:Standard?

@nicholascar
Copy link
Contributor Author

nicholascar commented Nov 13, 2018

How about this redraw! Open subClassOf arrows + a few other fixes (consistent property naming) Grey classes are those declared in PROF:

profilesont

@nicholascar
Copy link
Contributor Author

nicholascar commented Nov 13, 2018

@larsgsvensson:

"Shouldn't the property arrow isProfileOf between Profile and BaseSpecification go from Profile to BaseSpecification..."

No, the cardinality on this arrow, [0] shows that a Base Standard is just a Profile (or, more generally, a dct:Standard) that doesn't profile anything else.

"...similarly to the relation between Profile and dct:Standard?"

No again, sorry! A prof:Profile should be prof:isProfileOf of a dct:Standard. Since prof:Profile is also rdfs:subClassOf of a dct:Standard, a prof:Profile could happily be prof:isProfileOf another prof:Profile.

@larsgsvensson
Copy link
Contributor

@nicholascar scripsit:

No, the cardinality on this arrow, [0] shows that a Base Standard is just a Profile (or, more generally, a dct:Standard) that doesn't profile anything else.

Ah, I didn't catch the cardinality constraint. Thanks for your clarification!

@makxdekkers
Copy link
Contributor

I note that the Usage Note of prof:BaseSpecification says: "This may not be a useful class: documents of any specification can be regarded as a trivial profile, so applications only need to be concerned with Profile conformance". If it is not useful, why should it be there?

@aisaac
Copy link
Contributor

aisaac commented Nov 13, 2018

@nicholascar this looks better.
And I'm wondering: is there an issue somewhere to discuss the cardinality of isProfileOf? If our official definition implies that a profile is always a profile of something then the min cardinality of isProfileOf can't be 0.

@kcoyle
Copy link
Contributor

kcoyle commented Nov 13, 2018

And I was wondering if ResourceDescriptor should have dct:format or if that should be on the Resource artifact.

That said, I find "ResourceDescriptor" quite confusing because I always read it as "something (a descriptor) that describes the Resource" not "A resource that defines an aspect of a Profile". The adjective "resource" is what is confusing. I think it needs to be "ProfileDescriptor" because it describes the profile not the resource.

@kcoyle
Copy link
Contributor

kcoyle commented Nov 13, 2018

Not to mention that Resource Description is 2/3 of Resource Description Framework and in that context it means the description of resources.

@makxdekkers
Copy link
Contributor

I agree with @kcoyle that Resource Descriptor is really a bad name. I read in the document: "can have Resource Descriptors associated with them that define rules for implementing it" (btw "it" should be "them"). Maybe a better name could be Implementing Rules? Because that is what they are defined to be.

@aisaac
Copy link
Contributor

aisaac commented Nov 13, 2018

I too have plenty comments on the ontology, but I think they will be for later. This issue is just about the diagram anyway :-)

@rob-metalinkage
Copy link
Contributor

rob-metalinkage commented Nov 13, 2018 via email

@smrgeoinfo
Copy link
Contributor

smrgeoinfo commented Nov 13, 2018

Related suggestion about ResourceDescriptor: #529

@dr-shorthair
Copy link
Contributor

The diagram appears to show that Profile is a sub-class of skos:Concept - is that intended?

@nicholascar
Copy link
Contributor Author

@dr-shorthair: that's a mistake, removed in a re-issue of the diagram

@andrea-perego
Copy link
Contributor

Just an editorial consideration (and not about the entities and relationships in the schema...), but cannot we have the diagram as SVG? Using a Web-friendly vector format would improve readability and it can be easily resized without being blurred (and maybe we could also provide a zoom-in option...).

@nicholascar
Copy link
Contributor Author

Sure, I'll switch the PNG for an SVG. I produce SVG anyway. This will appear in the https://github.com/w3c/dxwg/tree/fpwd-sprint branch which will contain all these small editorial things.

@andrea-perego
Copy link
Contributor

Grand! Thanks, @nicholascar .

@nicholascar
Copy link
Contributor Author

Here is an rendered version of the updated image (and other edits): https://raw.githack.com/w3c/dxwg/fpwd-sprint/profilesont/index.html

@aisaac
Copy link
Contributor

aisaac commented Nov 14, 2018

Discussion on Resource Description happens now on #573

@rob-metalinkage
Copy link
Contributor

Due for closing, diagram included in FWPD. Reopen specific issues about diagram content as needed,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
due for closing Issue that is going to be closed if there are no objection within 6 days profiles-vocabulary For discussion of profile description vocabulary
Projects
None yet
Development

No branches or pull requests