Annotations #84

ftomassetti · 2023-09-08T08:54:32Z

With this PR:

We introduce annotations in the language (i.e., the meta-metamodel)
We introduce annotations in the model API. To do this we create a common ancestor for annotations and nodes as annotations can target both. We call this ancestor "Element" for lack of a better name
We start revising the serialization support not to explode if "annotations" is encountered
Wrote tests regarding the model API
Added support for actually exporting annotations in the serialization format

What we still need to do:

Write tests add support in the EMF importer/exporter (Support annotations in the EMF importer/exporter #85)

enikao · 2023-09-11T07:43:19Z

We introduce annotations in the model API. To do this we create a common ancestor for annotations and nodes as annotations can target both. We call this ancestor "Element" for lack of a better name

Isn't the common ancestor Classifier? (See https://lionweb-org.github.io/organization/metametamodel/metametamodel.html#_overview)

ftomassetti · 2023-09-11T11:18:19Z

We introduce annotations in the model API. To do this we create a common ancestor for annotations and nodes as annotations can target both. We call this ancestor "Element" for lack of a better name

Isn't the common ancestor Classifier? (See https://lionweb-org.github.io/organization/metametamodel/metametamodel.html#_overview)

It would be the equivalent on Classifier on the model level. I.e., it would have the thing that represent an instance of a Classifier, in the same way that Node is an instance on Concept and AnnotationInstance is an instance of Annotation

ftomassetti · 2023-09-14T05:56:20Z

I renamed Element into ClassifierInstance, because @enikao is right, is connected to Classifier

ftomassetti · 2023-09-14T15:02:11Z

Discussion in LionWeb-io/specification#164 could affect this

…fier instance

ftomassetti · 2023-09-14T15:24:02Z

This is a very big PR because a lot of code had to be changed to deal with Classifiers (and not just Concepts) and with Classifier Instances (which are either Nodes or Annotation Instances, while before we dealt only with Node).

I do not expect anyone to have the time to read this whole PR, but perhaps @enikao and/or @dslmeinte have the time to take a look at some part and provide some feedback.

Otherwise I can merge and then react to issues and inconsistencies with the TS implementation as they emerge :)

dslmeinte · 2023-09-14T18:57:47Z

It's indeed a big PR. What I'm sort of missing is a persisted serialization chunk with some actual annotation instances. I only see the key-value-pair "annotations": [] having been added everywhere: that might be something to add - or likely explicitly deserialize a language + model in it that's built up in some of the tests.

core/src/main/java/io/lionweb/lioncore/java/serialization/ClassifierResolver.java

enikao · 2023-09-14T22:22:13Z

.../src/main/java/io/lionweb/lioncore/java/serialization/data/SerializedClassifierInstance.java

@@ -160,4 +164,12 @@ public String toString() {
    public void setAnnotations(List<String> annotationIDs) {
      this.annotations = annotationIDs;
    }
+
+    public String getAnnotated() {


Why do we have this method? This must be the same as getParent(), according to https://lionweb-org.github.io/organization/serialization/serialization.html#parent

This came as a surprise to me. When I think about the model I imagine a tree (or a forest) which is composed by nodes, each one with their own position within the tree. Each one (besides roots) having a parent. Annotation instances are instances something else: they are not node, they are not part of the tree. They are attached to nodes. Some consumers are interested in the tree (so just the nodes), some others are interested in the tree and the attached annotation instances.

So it seems strange to me that an annotation instance has a parent, as it is not part of the tree. From may point of view it has a pointer to the node that it is attached to, which it is not its parent, as the annotation instance is not a children of the node (it is not part of any containment).

The rationale was: Every node must be contained in a Partition. We can always find the partition by moving up to the root of the containment hierarchy.
If not the annotated node, who else is the parent of an annotation instance? Which partition does it belong to?

If we wanted completely independent annotations (i.e. stored somewhere outside the annotated node), they would be provided by a processor as a derived model. This processor might have its own internal storage, or ask the repository for a "special" partition that contains all the annotations.

I think that the partition containing the annotation is the same partition which is containing the annotated node, on that we agree. My problem is with the term "parent" to indicate what it seems to me are two different relationship.

I think that the children of a node do not contain the annotations attached to that node. Is that right?

If it is right, then it is surprising that the annotation can have as a parent the annotated node. It means that parent is not the inverse relationship of children.

That's what we decided in LionWeb-io/specification#150

Understood, I will comply

I hope this was our understanding, not only my understanding -- shall we raise the issue again in the next meeting?

I think that once @dslmeinte implements annotations for TS it could be useful to compare ideas regarding annotations at the model level, because I think we discussed annotations mostly at the metamodel level, and he may also find certain inconsistencies/weird naming. However for getAnnotated I agree and I will remove it

enikao · 2023-09-14T22:25:14Z

.../src/main/java/io/lionweb/lioncore/java/serialization/data/SerializedClassifierInstance.java

@@ -11,6 +11,7 @@ public class SerializedClassifierInstance {
  private String id;


What's the difference to a SerializedNode?

In my understanding we have annotation instances and nodes, which are similar but not the same. So the common ancestor (grouping the similarities) is called Classifier Instance. Also when serializing them they are very similar but not the same. For example, an annotation instance has no concept, it has an annotation instead. It has no parent but an annotated node instead (see previous comment). For this reason also on the serialization level I find useful to distinguish them.

enikao · 2023-09-14T22:30:59Z

core/src/main/java/io/lionweb/lioncore/java/model/AnnotationInstance.java

  Annotation getAnnotationDefinition();
+
+  ClassifierInstance getAnnotated();


same as getParent()

ftomassetti · 2023-09-15T09:02:41Z

TODO: let annotations have containments

ftomassetti · 2023-09-20T09:20:13Z

Merging to avoid conflicts with other work (lke renaming LIonWeb into LionWeb).

Some changes may be done later, to ensure adherence with the "standard"

ftomassetti added 7 commits September 8, 2023 09:56

initial definition of the annotations

9489565

define annotation in metamodel

2025305

revisit annotation tests

56a1116

update tests

7c26435

add support for annotations instances in model API

9fb7b13

update organization commit used for checks

69c99ab

remove most experimental features

1965d15

ftomassetti added 8 commits September 14, 2023 07:56

rename Element into ClassifierInstance

dbcf1c8

adding tests on Annotation

5f034c8

introducing DynamicAnnotationInstance

c96eb03

working on serialization annotations

f800e1c

formatting

109b38f

working on serializing annotations

7f8ce57

serialization of annotations

8cd4933

correct serialization of annotations

78ff8b8

ftomassetti added 4 commits September 14, 2023 17:03

linting

3166032

correcting names due to the introduction of Classifier Instances

194a82b

more renaming to take into account generalization from node to classi…

c606229

…fier instance

minor

5b66f43

ftomassetti marked this pull request as ready for review September 14, 2023 15:21

dslmeinte approved these changes Sep 14, 2023

View reviewed changes

enikao reviewed Sep 14, 2023

View reviewed changes

fix typo

f26fd6e

merge getAnnotated and getParent

17adee0

ftomassetti merged commit f41a642 into master Sep 20, 2023

ftomassetti deleted the annotations branch September 20, 2023 09:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Annotations #84

Annotations #84

ftomassetti commented Sep 8, 2023 •

edited

Loading

enikao commented Sep 11, 2023

ftomassetti commented Sep 11, 2023

ftomassetti commented Sep 14, 2023

ftomassetti commented Sep 14, 2023

ftomassetti commented Sep 14, 2023

dslmeinte commented Sep 14, 2023

enikao Sep 14, 2023

ftomassetti Sep 15, 2023

enikao Sep 15, 2023

ftomassetti Sep 18, 2023

enikao Sep 18, 2023

ftomassetti Sep 18, 2023

enikao Sep 18, 2023

ftomassetti Sep 19, 2023

enikao Sep 14, 2023

ftomassetti Sep 15, 2023

enikao Sep 14, 2023

ftomassetti commented Sep 15, 2023

ftomassetti commented Sep 20, 2023

		@@ -11,6 +11,7 @@ public class SerializedClassifierInstance {
		private String id;

		Annotation getAnnotationDefinition();

		ClassifierInstance getAnnotated();

Annotations #84

Annotations #84

Conversation

ftomassetti commented Sep 8, 2023 • edited Loading

enikao commented Sep 11, 2023

ftomassetti commented Sep 11, 2023

ftomassetti commented Sep 14, 2023

ftomassetti commented Sep 14, 2023

ftomassetti commented Sep 14, 2023

dslmeinte commented Sep 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ftomassetti commented Sep 15, 2023

ftomassetti commented Sep 20, 2023

ftomassetti commented Sep 8, 2023 •

edited

Loading