Initials encoded from ontouml.org

Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = OntoUMLspecification
+SPHINXPROJ    = OntoUML-Specification
 SOURCEDIR     = .
 BUILDDIR      = _build
 

README.md

@@ -1,2 +1,3 @@
 # OntoUML
+
 Evolvable OntoUML metamodel specification

classes/aspects/mode/constraints.rst

@@ -0,0 +1,38 @@
+Constraints
+-----------
+
+**C1:** Every «Mode» must be (directly or indirectly) connected to an
+association end of at least one «characterization» relation.
+
+.. container:: figure
+
+   |Mode application 1|
+
+**C2:** The multiplicity of the characterized end (opposite to the Mode)
+must be exactly one. Therefore, the following examples are forbidden.
+
+.. container:: figure
+
+   |Mode forbidden 3|
+
+**C3:** Modes cannot have as ancestors the following types: «Kind»,
+«Quantiy», «Collective», «Subkind», «Role», «RoleMixin», «Phase»,
+«Relator», «Quality».
+
+.. container:: figure
+
+   |Mode forbidden 2|
+
+**C4:** Modes cannot have as descendants the following types: «Kind»,
+«Quantity», «Collective», «RoleMixin», «Category», «Mixin», «Relator»,
+«Quality».
+
+.. container:: figure
+
+   |Mode forbidden 1|
+
+
+.. |Mode application 1| image:: _images/ontouml_mode-application-1.png
+.. |Mode forbidden 3| image:: _images/ontouml_mode-forbidden-3.png
+.. |Mode forbidden 2| image:: _images/ontouml_mode-forbidden-2.png
+.. |Mode forbidden 1| image:: _images/ontouml_mode-forbidden-1.png

classes/aspects/mode/definition.rst

@@ -0,0 +1,13 @@
+Definition
+----------
+
+A **«Mode»** is a particular type of intrinsic property that has no
+structured value. Like qualities, modes are also individuals that
+existentially depend on their bearers. Types stereotyped as «Mode» are
+also **rigid**. You can find some examples of modes below:
+
+.. container:: figure
+
+   |Mode examples|
+
+.. |Mode examples| image:: _images/ontouml_mode-examples.png

classes/aspects/mode/examples.rst

@@ -0,0 +1,20 @@
+Examples
+--------
+
+**EX1:** Fragment from the Configuration Management Task Ontology (`see
+more <http://www.menthor.net/cmto.html>`__):
+
+.. container:: figure
+
+   |Example CMT|
+
+**EX2:** Fragment from the OntoUML Org Ontology (O3) (`see
+more <http://www.menthor.net/o3.html>`__):
+
+.. container:: figure
+
+   |Example O3|
+
+
+.. |Example CMT| image:: _images/6216663_orig.png
+.. |Example O3| image:: _images/4611138_orig.png

classes/aspects/mode/faq.rst

@@ -0,0 +1,4 @@
+Common questions
+----------------
+
+Ask us some question if something is not clear ...

classes/aspects/mode/index.rst

@@ -0,0 +1,12 @@
+Mode
+====
+
+
+.. include:: definition.rst
+
+.. include:: constraints.rst
+
+.. include:: faq.rst
+
+.. include:: examples.rst
+

classes/aspects/mode/meta.yml

@@ -0,0 +1,23 @@
+class_stereotype:
+  name: Mode
+  parent: Aspect
+  provides_identity: ?
+  identity_principle: single
+  rigidity: rigid
+  dependency: mandatory
+  supertypes:
+  - Category
+  - Mixin
+  subtypes:
+  - Subkind
+  - Role
+  - Phase
+  - Mode
+  forbidden_associations:
+  - Structuration
+  - ComponentOf
+  - SubCollectionOf
+  - MemberOf
+  - SubQuantityOf
+  - Derivation
+  abstract: true

classes/aspects/quality/constraints.rst

@@ -0,0 +1,39 @@
+Constraints
+-----------
+
+**C1:** A Quality must always be connected, through a characterization
+to another type.
+
+.. container:: figure
+
+   |Quality application 1|
+
+**C2:** The multiplicity of the characterized end (opposite to the
+quality) must be exactly one. Therefore, the following examples are
+forbidden.
+
+.. container:: figure
+
+   |Quality forbidden 1|
+
+**C3:** Qualtities cannot have as ancestors the following types: «Kind»,
+«Quantiy», «Collective», «Subkind», «Role», «RoleMixin», «Phase»,
+«Relator», «Mode».
+
+.. container:: figure
+
+   |Quality forbidden 2|
+
+**C4:** Qualtities cannot have as descendants the following types:
+«Kind», «Quantiy», «Collective», «RoleMixin», «Category», «Mixin»,
+«Relator», «Mode».
+
+.. container:: figure
+
+   |Quality forbidden 3|
+
+
+.. |Quality application 1| image:: _images/ontouml_quality-application-1.png
+.. |Quality forbidden 1| image:: _images/ontouml_quality-forbidden-1.png
+.. |Quality forbidden 2| image:: _images/ontouml_quality-forbidden-2.png
+.. |Quality forbidden 3| image:: _images/ontouml_quality-forbidden-3.png

classes/aspects/quality/definition.rst

@@ -0,0 +1,32 @@
+Definition
+----------
+
+A **«Quality»** is a particular type of intrinsic property which has a
+structured value. Qualities are things that are existentially dependent
+on the things they characterize, called their bearers. Types stereotyped
+as «Quality» are also **rigid**. OntoUML differentiates between three
+types of qualities:
+
+-  **Perceivable**, which capture qualities that could be measured by an
+   agent with the appropriate instrument, like weight, height, color and
+   speed.
+-  **Non-Perceivable**, which represent properties which cannot be
+   directly measured by an instrument, like currency.
+-  **Nominal**, which are used to make reference to an individual, like
+   one's name, a book's ISBN or a credit card number.
+
+Notice some examples of qualities in the next figure:
+
+.. container:: figure
+
+   |Quality examples|
+
+You can define different types of geometrical structures for a quality
+value using dimensions and domains. Here is an example:
+
+.. container:: figure
+
+   |Quality application 2|
+
+.. |Quality examples| image:: _images/ontouml_quality-examples.png
+.. |Quality application 2| image:: _images/ontouml_quality-application-2.png

classes/aspects/quality/examples.rst

@@ -0,0 +1,4 @@
+Examples
+--------
+
+To be added ...

classes/aspects/quality/faq.rst

@@ -0,0 +1,17 @@
+Common questions
+----------------
+
+**Q1:** Can I represent the property "height" as an attribute instead of
+a Quality?
+**A1:** Yes. The decision to represent attributes or
+qualities is entirely up to you. It is useful to represent properties as
+qualities when you want to define different escales for the same
+characteristic. For instance, if you want to model that a Person has a
+"height" property, which can be measured in meters or centimeters you
+should explicitly represent the Height quality.
+
+.. container:: figure
+
+   |Quality application 4|
+
+.. |Quality application 4| image:: _images/ontouml_quality-application-4.png

classes/aspects/quality/index.rst

@@ -0,0 +1,12 @@
+Quality
+=======
+
+
+.. include:: definition.rst
+
+.. include:: constraints.rst
+
+.. include:: faq.rst
+
+.. include:: examples.rst
+

classes/aspects/quality/meta.yml

@@ -0,0 +1,21 @@
+class_stereotype:
+  name: Quality
+  parent: Aspect
+  provides_identity: ?
+  identity_principle: single
+  rigidity: rigid
+  dependency: mandatory
+  supertypes:
+  - Category
+  - Mixin
+  subtypes:
+  - Subkind
+  - Role
+  - Phase
+  forbidden_associations:
+  - ComponentOf
+  - SubCollectionOf
+  - MemberOf
+  - SubQuantityOf
+  - Derivation
+  abstract: true

classes/index.rst

@@ -0,0 +1,29 @@
+Class stereotypes
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Sortals:
+
+   sortals/kind/index
+   sortals/subkind/index
+   sortals/phase/index
+   sortals/role/index
+   sortals/collective/index
+   sortals/quantity/index
+   sortals/relator/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: NonSortals:
+
+   nonsortals/category/index
+   nonsortals/rolemixin/index
+   nonsortals/mixin/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Aspects:
+
+   aspects/mode/index
+   aspects/quality/index

classes/nonsortals/category/constraints.rst

@@ -0,0 +1,38 @@
+Constraints
+-----------
+
+**C1:** A «Category» is always abstract. Notice that abstract classes
+are represented with an *italic* label.
+
+.. container:: figure
+
+   |Category application 1|
+
+**C2:** A «Category» aggregate individuals that follow different
+identity principles, therefore it may not have as ancestor the following
+constructs: «Kind», «Quantity», «Collective», «Subkind», «Role»,
+«Phase», «Relator», «Mode», «Quality».
+
+.. container:: figure
+
+   |Category forbidden 1|
+
+**C3:** A «Category» is a rigid construct, therefore it cannot have as
+ancestor an anti-rigid type, as: «Role», «RoleMixin», «Phase».
+
+.. container:: figure
+
+   |Category forbidden 2|
+
+**C4:** Categories cannot have as descendants the following types:
+«Mixin», «Role», «Phase».
+
+.. container:: figure
+
+   |Category forbidden 3|
+
+
+.. |Category application 1| image:: _images/ontouml_category-application-1.png
+.. |Category forbidden 1| image:: _images/ontouml_category-forbidden-1.png
+.. |Category forbidden 2| image:: _images/ontouml_category-forbidden-3.png
+.. |Category forbidden 3| image:: _images/ontouml_category-forbidden-2.png

classes/nonsortals/category/definition.rst

@@ -0,0 +1,19 @@
+Definition
+----------
+
+A **«Category»** is a **rigid** mixin that does not require a dependency
+to be specified. It is used to aggregate essential properties to
+individuals which following **different identity principles**. Let's see
+some examples:
+
+.. container:: figure
+
+   |Category examples|
+
+Categories are usually used in a refactoring process. For example, let's
+suppose that you defined two classes in your model, Person and Animal.
+Now you want to state that either people and animals have a weight. You
+than create a «Category», which has weight, and generalize the existing
+classes into it.
+
+.. |Category examples| image:: _images/ontouml_category-examples.png

classes/nonsortals/category/examples.rst

@@ -0,0 +1,20 @@
+Examples
+--------
+
+**EX1:** Fragment from the ECG Ontology (`see
+more <http://www.menthor.net/ecg.html>`__):
+
+.. container:: figure
+
+   |Example ECG|
+
+**EX2:** Fragment from UFO-S, a commitment-based service ontology (`see
+more <http://www.menthor.net/ufo-s.html>`__):
+
+.. container:: figure
+
+   |Example UFO-S|
+
+
+.. |Example ECG| image:: _images/792282_orig.png
+.. |Example UFO-S| image:: _images/4586621_orig.png

classes/nonsortals/category/faq.rst

@@ -0,0 +1,4 @@
+Common questions
+----------------
+
+Ask us some question if something is not clear ...

classes/nonsortals/category/index.rst

@@ -0,0 +1,12 @@
+Category
+========
+
+
+.. include:: definition.rst
+
+.. include:: constraints.rst
+
+.. include:: faq.rst
+
+.. include:: examples.rst
+