gCubeSystem
/
information-system-model-documentation-generator
15
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added cross-references to documentation

This commit is contained in:
Luca Frosini 2023-05-12 14:59:25 +02:00
parent 7cbb1754e5
commit 89c291c0c3
9 changed files with 1895 additions and 1648 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

560
gcube-model-consistsof.rst
View File

@ -1,35 +1,39 @@
.. _ConsistsOf:
ConsistsOf ConsistsOf
========== ==========
.. _HasAction:
HasAction HasAction
--------- ---------
Relation among a {@link Service} and its {@link ActionFacet} Relation among a :ref:`Service <Service>` and its :ref:`ActionFacet <ActionFacet>`
.. table:: **HasAction** ``extends`` **ConsistsOf** .. table:: **HasAction** ``extends`` **ConsistsOf**
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+==============================================================+ +======================================================+==============================+==================+==================================+====================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| Service | HasAction | 0..n | ActionFacet | Relation among a {@link Service} and its {@link ActionFacet} | | :ref:`Service <Service>` | :ref:`HasAction <HasAction>` | 0..n | :ref:`ActionFacet <ActionFacet>` | Relation among a :ref:`Service <Service>` and its :ref:`ActionFacet <ActionFacet>` |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------+
The **HasAction** current version is 1.0.0. The **HasAction** current version is 1.0.0.
@ -39,33 +43,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasAddAction:
HasAddAction HasAddAction
^^^^^^^^^^^^ ^^^^^^^^^^^^
An action triggered when a {@link Service} is activated. An action triggered when a :ref:`Service <Service>` is activated.
.. table:: **HasAddAction** ``extends`` **HasAction** .. table:: **HasAddAction** ``extends`` **HasAction**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+==========================================================+ +======================================================+====================================+==================+==================================+===================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| Service | HasAddAction | 0..n | ActionFacet | An action triggered when a {@link Service} is activated. | | :ref:`Service <Service>` | :ref:`HasAddAction <HasAddAction>` | 0..n | :ref:`ActionFacet <ActionFacet>` | An action triggered when a :ref:`Service <Service>` is activated. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+----------------------------------+-------------------------------------------------------------------+
The **HasAddAction** current version is 1.0.0. The **HasAddAction** current version is 1.0.0.
@ -75,33 +81,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasRemoveAction:
HasRemoveAction HasRemoveAction
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
An action triggered when a {@link Service} is deactivated. An action triggered when a :ref:`Service <Service>` is deactivated.
.. table:: **HasRemoveAction** ``extends`` **HasAction** .. table:: **HasRemoveAction** ``extends`` **HasAction**
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+=================+==================+=================+============================================================+ +======================================================+==========================================+==================+==================================+=====================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| Service | HasRemoveAction | 0..n | ActionFacet | An action triggered when a {@link Service} is deactivated. | | :ref:`Service <Service>` | :ref:`HasRemoveAction <HasRemoveAction>` | 0..n | :ref:`ActionFacet <ActionFacet>` | An action triggered when a :ref:`Service <Service>` is deactivated. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+----------------------------------+---------------------------------------------------------------------+
The **HasRemoveAction** current version is 1.0.0. The **HasRemoveAction** current version is 1.0.0.
@ -111,37 +119,39 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasContact:
HasContact HasContact
---------- ----------
HasContact is a base relation type to capture the diverse points of contact associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target {@link ContactFacet}. Instead, every specialisation refines the reason of using the {@link ContactFacet} allowing to discriminate between two or more {@link ContactFacet} attached to the same resource.The identified specialisations are: {@link HasContributor}, {@link HasCreator}, {@link HasCurator}, {@link HasDeveloper}, {@link HasMaintainer}, {@link HasManager} and {@link HasOwner}. HasContact is a base relation type to capture the diverse points of contact associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target :ref:`ContactFacet <ContactFacet>`. Instead, every specialisation refines the reason of using the :ref:`ContactFacet <ContactFacet>` allowing to discriminate between two or more :ref:`ContactFacet <ContactFacet>` attached to the same resource.The identified specialisations are: :ref:`HasContributor <HasContributor>`, :ref:`HasCreator <HasCreator>`, :ref:`HasCurator <HasCurator>`, :ref:`HasDeveloper <HasDeveloper>`, :ref:`HasMaintainer <HasMaintainer>`, :ref:`HasManager <HasManager>` and :ref:`HasOwner <HasOwner>`.
.. table:: **HasContact** ``extends`` **ConsistsOf** .. table:: **HasContact** ``extends`` **ConsistsOf**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+================================+==================+====================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasContact | 0..n | ContactFacet | HasContact is a base relation type to capture the diverse points of contact associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target {@link ContactFacet}. Instead, every specialisation refines the reason of using the {@link ContactFacet} allowing to discriminate between two or more {@link ContactFacet} attached to the same resource.The identified specialisations are: {@link HasContributor}, {@link HasCreator}, {@link HasCurator}, {@link HasDeveloper}, {@link HasMaintainer}, {@link HasManager} and {@link HasOwner}. | | :ref:`Resource <Resource>` | :ref:`HasContact <HasContact>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasContact is a base relation type to capture the diverse points of contact associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target :ref:`ContactFacet <ContactFacet>`. Instead, every specialisation refines the reason of using the :ref:`ContactFacet <ContactFacet>` allowing to discriminate between two or more :ref:`ContactFacet <ContactFacet>` attached to the same resource.The identified specialisations are: :ref:`HasContributor <HasContributor>`, :ref:`HasCreator <HasCreator>`, :ref:`HasCurator <HasCurator>`, :ref:`HasDeveloper <HasDeveloper>`, :ref:`HasMaintainer <HasMaintainer>`, :ref:`HasManager <HasManager>` and :ref:`HasOwner <HasOwner>`. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasContact | 1..n | ContactFacet | The contact information of the entity responsible for the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Schema | HasContact | 1..n | ContactFacet | | | :ref:`Schema <Schema>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | HasContact | 1..n | ContactFacet | The main contact for the Site. | | :ref:`Site <Site>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The main contact for the Site. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasContact** current version is 1.0.0. The **HasContact** current version is 1.0.0.
@ -151,33 +161,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasContributor:
HasContributor HasContributor
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
HasContributor indicates that the target {@link ContactFacet} contains the information related to a contributor to the source resource, e.g., the contact points of the contributor of software or the contributor of a dataset. HasContributor indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a contributor to the source resource, e.g., the contact points of the contributor of software or the contributor of a dataset.
.. table:: **HasContributor** ``extends`` **HasContact** .. table:: **HasContributor** ``extends`` **HasContact**
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=================+==================================================================================================================================================================================================================================+ +======================================================+========================================+==================+====================================+================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasContributor | 0..n | ContactFacet | HasContributor indicates that the target {@link ContactFacet} contains the information related to a contributor to the source resource, e.g., the contact points of the contributor of software or the contributor of a dataset. | | :ref:`Resource <Resource>` | :ref:`HasContributor <HasContributor>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasContributor indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a contributor to the source resource, e.g., the contact points of the contributor of software or the contributor of a dataset. |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasContributor | 0..n | ContactFacet | The contact information on contributors supporting the creation and development of the Dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasContributor <HasContributor>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information on contributors supporting the creation and development of the Dataset. |
+------------------------------------------------------+----------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasContributor** current version is 1.0.0. The **HasContributor** current version is 1.0.0.
@ -187,33 +199,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasCreator:
HasCreator HasCreator
^^^^^^^^^^ ^^^^^^^^^^
HasCreator indicates that the target {@link ContactFacet} contains the information related to a creator of the source resource, e.g., the contact points of the creator of a dataset. HasCreator indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a creator of the source resource, e.g., the contact points of the creator of a dataset.
.. table:: **HasCreator** ``extends`` **HasContact** .. table:: **HasCreator** ``extends`` **HasContact**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================================================================================================================+ +======================================================+================================+==================+====================================+=====================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasCreator | 0..n | ContactFacet | HasCreator indicates that the target {@link ContactFacet} contains the information related to a creator of the source resource, e.g., the contact points of the creator of a dataset. | | :ref:`Resource <Resource>` | :ref:`HasCreator <HasCreator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasCreator indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a creator of the source resource, e.g., the contact points of the creator of a dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCreator | 0..n | ContactFacet | The contact information of the creator of the Dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCreator <HasCreator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the creator of the Dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasCreator** current version is 1.0.0. The **HasCreator** current version is 1.0.0.
@ -223,33 +237,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasCurator:
HasCurator HasCurator
^^^^^^^^^^ ^^^^^^^^^^
HasCurator indicates that the target {@link ContactFacet} contains the information related to a curator of the source resource, e.g., the contact points of the curator of a dataset. HasCurator indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a curator of the source resource, e.g., the contact points of the curator of a dataset.
.. table:: **HasCurator** ``extends`` **HasContact** .. table:: **HasCurator** ``extends`` **HasContact**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================================================================================================================+ +======================================================+================================+==================+====================================+=====================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasCurator | 0..n | ContactFacet | HasCurator indicates that the target {@link ContactFacet} contains the information related to a curator of the source resource, e.g., the contact points of the curator of a dataset. | | :ref:`Resource <Resource>` | :ref:`HasCurator <HasCurator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasCurator indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a curator of the source resource, e.g., the contact points of the curator of a dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCurator | 0..n | ContactFacet | The contact information of the entity responsible for the curation of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCurator <HasCurator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the curation of the dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasCurator** current version is 1.0.0. The **HasCurator** current version is 1.0.0.
@ -259,33 +275,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasDeveloper:
HasDeveloper HasDeveloper
^^^^^^^^^^^^ ^^^^^^^^^^^^
HasDeveloper indicates that the target {@link ContactFacet} contains the information related to a developer of the source resource e.g., the contact points ofthe developer of a software. HasDeveloper indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a developer of the source resource e.g., the contact points ofthe developer of a software.
.. table:: **HasDeveloper** ``extends`` **HasContact** .. table:: **HasDeveloper** ``extends`` **HasContact**
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+============================================================================================================================================================================================+ +======================================================+====================================+==================+====================================+==========================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasDeveloper | 0..n | ContactFacet | HasDeveloper indicates that the target {@link ContactFacet} contains the information related to a developer of the source resource e.g., the contact points ofthe developer of a software. | | :ref:`Resource <Resource>` | :ref:`HasDeveloper <HasDeveloper>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasDeveloper indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a developer of the source resource e.g., the contact points ofthe developer of a software. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------+------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasDeveloper** current version is 1.0.0. The **HasDeveloper** current version is 1.0.0.
@ -295,37 +313,39 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasMaintainer:
HasMaintainer HasMaintainer
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
HasDeveloper indicates that the target {@link ContactFacet} contains the information related to a developer of the source resource, e.g., the contact points of the developer of a software. HasDeveloper indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a developer of the source resource, e.g., the contact points of the developer of a software.
.. table:: **HasMaintainer** ``extends`` **HasContact** .. table:: **HasMaintainer** ``extends`` **HasContact**
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+===============+==================+=================+==============================================================================================================================================================================================+ +======================================================+======================================+==================+====================================+============================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasMaintainer | 0..n | ContactFacet | HasDeveloper indicates that the target {@link ContactFacet} contains the information related to a developer of the source resource, e.g., the contact points of the developer of a software. | | :ref:`Resource <Resource>` | :ref:`HasMaintainer <HasMaintainer>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasDeveloper indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a developer of the source resource, e.g., the contact points of the developer of a software. |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConcreteDataset | HasMaintainer | 1..n | ContactFacet | The contact information of the entity responsible for the maintenance of the concrete dataset | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`HasMaintainer <HasMaintainer>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the maintenance of the concrete dataset |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasMaintainer | 0..n | ContactFacet | The contact information of the entity responsible for the maintenance of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasMaintainer <HasMaintainer>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the maintenance of the dataset. |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | HasMaintainer | 1..n | ContactFacet | Contact information of the maintainer of the Site. | | :ref:`Site <Site>` | :ref:`HasMaintainer <HasMaintainer>` | 1..n | :ref:`ContactFacet <ContactFacet>` | Contact information of the maintainer of the Site. |
+------------------------------------------------------+---------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------+------------------+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasMaintainer** current version is 1.0.0. The **HasMaintainer** current version is 1.0.0.
@ -335,33 +355,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasManager:
HasManager HasManager
^^^^^^^^^^ ^^^^^^^^^^
HasManager indicates that the target {@link ContactFacet} contains the information related to a manager of the source resource, e.g., the contact points of the manager of a research infrastructure or a data centre. HasManager indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a manager of the source resource, e.g., the contact points of the manager of a research infrastructure or a data centre.
.. table:: **HasManager** ``extends`` **HasContact** .. table:: **HasManager** ``extends`` **HasContact**
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+========================================================================================================================================================================================================================+ +======================================================+================================+==================+====================================+======================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasManager | 0..n | ContactFacet | HasManager indicates that the target {@link ContactFacet} contains the information related to a manager of the source resource, e.g., the contact points of the manager of a research infrastructure or a data centre. | | :ref:`Resource <Resource>` | :ref:`HasManager <HasManager>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasManager indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to a manager of the source resource, e.g., the contact points of the manager of a research infrastructure or a data centre. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | HasManager | 1..n | ContactFacet | Contact information of the Site Manager. | | :ref:`Site <Site>` | :ref:`HasManager <HasManager>` | 1..n | :ref:`ContactFacet <ContactFacet>` | Contact information of the Site Manager. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasManager** current version is 1.0.0. The **HasManager** current version is 1.0.0.
@ -371,33 +393,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasOwner:
HasOwner HasOwner
^^^^^^^^ ^^^^^^^^
HasOwner indicates that the target {@link ContactFacet} contains the information related to the owner of the source resource, e.g., the contact points of the owner of dataset. HasOwner indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to the owner of the source resource, e.g., the contact points of the owner of dataset.
.. table:: **HasOwner** ``extends`` **HasContact** .. table:: **HasOwner** ``extends`` **HasContact**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=================================================================================================================================================================================+ +======================================================+============================+==================+====================================+===============================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasOwner | 0..n | ContactFacet | HasOwner indicates that the target {@link ContactFacet} contains the information related to the owner of the source resource, e.g., the contact points of the owner of dataset. | | :ref:`Resource <Resource>` | :ref:`HasOwner <HasOwner>` | 0..n | :ref:`ContactFacet <ContactFacet>` | HasOwner indicates that the target :ref:`ContactFacet <ContactFacet>` contains the information related to the owner of the source resource, e.g., the contact points of the owner of dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasOwner | 0..n | ContactFacet | The contact information of the entity having the ownership of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasOwner <HasOwner>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity having the ownership of the dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasOwner** current version is 1.0.0. The **HasOwner** current version is 1.0.0.
@ -407,33 +431,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasCoverage:
HasCoverage HasCoverage
----------- -----------
HasCoverage represents the type of coverage that is provided by the CoverageFacet.Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the Information System isnot representing the data of the salinity. Instead, to specify the temporal period and the ocean area the dataset is valid. This information is captured using the same schema, i.e., the {@link CoverageFacet} but using different relations to distinguish between them with no need to understand the value or the schema of the coverage. For such a reason it has been defined the abstract HasCoverage relation and the specialisation {@link HasTemporalCoverage} and {@link HasSpatialCoverage} have been defined to refines the reason of using the {@link CoverageFacet}. HasCoverage represents the type of coverage that is provided by the CoverageFacet.Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the Information System isnot representing the data of the salinity. Instead, to specify the temporal period and the ocean area the dataset is valid. This information is captured using the same schema, i.e., the :ref:`CoverageFacet <CoverageFacet>` but using different relations to distinguish between them with no need to understand the value or the schema of the coverage. For such a reason it has been defined the abstract HasCoverage relation and the specialisation :ref:`HasTemporalCoverage <HasTemporalCoverage>` and :ref:`HasSpatialCoverage <HasSpatialCoverage>` have been defined to refines the reason of using the :ref:`CoverageFacet <CoverageFacet>`.
.. table:: **HasCoverage** ``extends`` **ConsistsOf** .. table:: **HasCoverage** ``extends`` **ConsistsOf**
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+==================================+==================+======================================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasCoverage | 0..n | CoverageFacet | HasCoverage represents the type of coverage that is provided by the CoverageFacet.Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the Information System isnot representing the data of the salinity. Instead, to specify the temporal period and the ocean area the dataset is valid. This information is captured using the same schema, i.e., the {@link CoverageFacet} but using different relations to distinguish between them with no need to understand the value or the schema of the coverage. For such a reason it has been defined the abstract HasCoverage relation and the specialisation {@link HasTemporalCoverage} and {@link HasSpatialCoverage} have been defined to refines the reason of using the {@link CoverageFacet}. | | :ref:`Resource <Resource>` | :ref:`HasCoverage <HasCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | HasCoverage represents the type of coverage that is provided by the CoverageFacet.Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the Information System isnot representing the data of the salinity. Instead, to specify the temporal period and the ocean area the dataset is valid. This information is captured using the same schema, i.e., the :ref:`CoverageFacet <CoverageFacet>` but using different relations to distinguish between them with no need to understand the value or the schema of the coverage. For such a reason it has been defined the abstract HasCoverage relation and the specialisation :ref:`HasTemporalCoverage <HasTemporalCoverage>` and :ref:`HasSpatialCoverage <HasSpatialCoverage>` have been defined to refines the reason of using the :ref:`CoverageFacet <CoverageFacet>`. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCoverage | 1..n | CoverageFacet | Any coverage related information (e.g. topic, species) characterising the content of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCoverage <HasCoverage>` | 1..n | :ref:`CoverageFacet <CoverageFacet>` | Any coverage related information (e.g. topic, species) characterising the content of the dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasCoverage** current version is 1.0.0. The **HasCoverage** current version is 1.0.0.
@ -443,33 +469,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasSpatialCoverage:
HasSpatialCoverage HasSpatialCoverage
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
HasSpatialCoverage indicates that the target {@link CoverageFacet} indicates a spatial coverage information, e.g., the geographic area indication for the dataset. HasSpatialCoverage indicates that the target :ref:`CoverageFacet <CoverageFacet>` indicates a spatial coverage information, e.g., the geographic area indication for the dataset.
.. table:: **HasSpatialCoverage** ``extends`` **HasCoverage** .. table:: **HasSpatialCoverage** ``extends`` **HasCoverage**
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+====================+==================+=================+====================================================================================================================================================================+ +======================================================+================================================+==================+======================================+===================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasSpatialCoverage | 0..n | CoverageFacet | HasSpatialCoverage indicates that the target {@link CoverageFacet} indicates a spatial coverage information, e.g., the geographic area indication for the dataset. | | :ref:`Resource <Resource>` | :ref:`HasSpatialCoverage <HasSpatialCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | HasSpatialCoverage indicates that the target :ref:`CoverageFacet <CoverageFacet>` indicates a spatial coverage information, e.g., the geographic area indication for the dataset. |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasSpatialCoverage | 0..n | CoverageFacet | Any geo-spatial coverage information characterising the content of the dataset, e.g. the area covered by the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasSpatialCoverage <HasSpatialCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | Any geo-spatial coverage information characterising the content of the dataset, e.g. the area covered by the dataset. |
+------------------------------------------------------+--------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------------+------------------+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasSpatialCoverage** current version is 1.0.0. The **HasSpatialCoverage** current version is 1.0.0.
@ -479,33 +507,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasTemporalCoverage:
HasTemporalCoverage HasTemporalCoverage
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
HasTemporalCoverage indicates that the target {@link CoverageFacet} indicates a temporal coverage information e.g., the temporal period indication for the dataset. HasTemporalCoverage indicates that the target :ref:`CoverageFacet <CoverageFacet>` indicates a temporal coverage information e.g., the temporal period indication for the dataset.
.. table:: **HasTemporalCoverage** ``extends`` **HasCoverage** .. table:: **HasTemporalCoverage** ``extends`` **HasCoverage**
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+=====================+==================+=================+=====================================================================================================================================================================+ +======================================================+==================================================+==================+======================================+====================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasTemporalCoverage | 0..n | CoverageFacet | HasTemporalCoverage indicates that the target {@link CoverageFacet} indicates a temporal coverage information e.g., the temporal period indication for the dataset. | | :ref:`Resource <Resource>` | :ref:`HasTemporalCoverage <HasTemporalCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | HasTemporalCoverage indicates that the target :ref:`CoverageFacet <CoverageFacet>` indicates a temporal coverage information e.g., the temporal period indication for the dataset. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasTemporalCoverage | 0..n | CoverageFacet | Any temporal coverage information characterising the content of the dataset, e.g. the time-span covered by the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasTemporalCoverage <HasTemporalCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | Any temporal coverage information characterising the content of the dataset, e.g. the time-span covered by the dataset. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasTemporalCoverage** current version is 1.0.0. The **HasTemporalCoverage** current version is 1.0.0.
@ -515,33 +545,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasMemory:
HasMemory HasMemory
--------- ---------
HasMemory is a base relation type to capture the diverse type of memories associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target {@link MemoryFacet}. It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} to clarify the semantics of the memory (any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile).We do not exclude other specialisation required by services to select the appropriated memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. HasMemory is a base relation type to capture the diverse type of memories associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target :ref:`MemoryFacet <MemoryFacet>`. It is in charge of the specialisation :ref:`HasVolatileMemory <HasVolatileMemory>` and :ref:`HasPersistentMemory <HasPersistentMemory>` to clarify the semantics of the memory (any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile).We do not exclude other specialisation required by services to select the appropriated memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative.
.. table:: **HasMemory** ``extends`` **ConsistsOf** .. table:: **HasMemory** ``extends`` **ConsistsOf**
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+==============================+==================+==================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasMemory | 0..n | MemoryFacet | HasMemory is a base relation type to capture the diverse type of memories associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target {@link MemoryFacet}. It is in charge of the specialisation {@link HasVolatileMemory} and {@link HasPersistentMemory} to clarify the semantics of the memory (any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile).We do not exclude other specialisation required by services to select the appropriated memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. | | :ref:`Resource <Resource>` | :ref:`HasMemory <HasMemory>` | 0..n | :ref:`MemoryFacet <MemoryFacet>` | HasMemory is a base relation type to capture the diverse type of memories associated with a resource. This relation is abstract because if not specialised it does not add any semantic of relating the resource with the target :ref:`MemoryFacet <MemoryFacet>`. It is in charge of the specialisation :ref:`HasVolatileMemory <HasVolatileMemory>` and :ref:`HasPersistentMemory <HasPersistentMemory>` to clarify the semantics of the memory (any resource describing a computing machine must have at least two types of memories, i.e., persistent and volatile).We do not exclude other specialisation required by services to select the appropriated memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasMemory** current version is 1.0.0. The **HasMemory** current version is 1.0.0.
@ -551,35 +583,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasPersistentMemory:
HasPersistentMemory HasPersistentMemory
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
HasPersistentMemory indicates that the target {@link MemoryFacet} indicates a non-volatile memory, i.e., a memory which does not lose the data when the device is powered down. This type of memory is also known as secondary memory, external memory, auxiliary storage, or secondary storage. Of course more than one MemoryFacet related with HasPersistentMemory can be attached to the same resource, but actually from an infrastructure management point of view, we did not find any reason to further specialise the HasPersistentMemory relation. Anyway, we do not exclude other specialisation required by services to select the appropriated persistent memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. HasPersistentMemory indicates that the target :ref:`MemoryFacet <MemoryFacet>` indicates a non-volatile memory, i.e., a memory which does not lose the data when the device is powered down. This type of memory is also known as secondary memory, external memory, auxiliary storage, or secondary storage. Of course more than one MemoryFacet related with HasPersistentMemory can be attached to the same resource, but actually from an infrastructure management point of view, we did not find any reason to further specialise the HasPersistentMemory relation. Anyway, we do not exclude other specialisation required by services to select the appropriated persistent memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative.
.. table:: **HasPersistentMemory** ``extends`` **HasMemory** .. table:: **HasPersistentMemory** ``extends`` **HasMemory**
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+=====================+==================+=================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+==================================================+==================+==================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasPersistentMemory | 0..n | MemoryFacet | HasPersistentMemory indicates that the target {@link MemoryFacet} indicates a non-volatile memory, i.e., a memory which does not lose the data when the device is powered down. This type of memory is also known as secondary memory, external memory, auxiliary storage, or secondary storage. Of course more than one MemoryFacet related with HasPersistentMemory can be attached to the same resource, but actually from an infrastructure management point of view, we did not find any reason to further specialise the HasPersistentMemory relation. Anyway, we do not exclude other specialisation required by services to select the appropriated persistent memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. | | :ref:`Resource <Resource>` | :ref:`HasPersistentMemory <HasPersistentMemory>` | 0..n | :ref:`MemoryFacet <MemoryFacet>` | HasPersistentMemory indicates that the target :ref:`MemoryFacet <MemoryFacet>` indicates a non-volatile memory, i.e., a memory which does not lose the data when the device is powered down. This type of memory is also known as secondary memory, external memory, auxiliary storage, or secondary storage. Of course more than one MemoryFacet related with HasPersistentMemory can be attached to the same resource, but actually from an infrastructure management point of view, we did not find any reason to further specialise the HasPersistentMemory relation. Anyway, we do not exclude other specialisation required by services to select the appropriated persistent memory better. For example, to discriminate between Solid State Disk and Magnetic Rotative. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | HasPersistentMemory | 1..n | MemoryFacet | The Disk Space Capacity of the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`HasPersistentMemory <HasPersistentMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The Disk Space Capacity of the Hosting Node. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | HasPersistentMemory | 1..n | MemoryFacet | The Disk Space Capacity of the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`HasPersistentMemory <HasPersistentMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The Disk Space Capacity of the Virtual Machine. |
+------------------------------------------------------+---------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------------------------+------------------+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasPersistentMemory** current version is 1.0.0. The **HasPersistentMemory** current version is 1.0.0.
@ -589,35 +623,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HasVolatileMemory:
HasVolatileMemory HasVolatileMemory
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
HasVolatileMemory indicates that the target {@link MemoryFacet} is a volatile memory, i.e., a memory which requires power to maintain the stored information. Volatile memory is also known as main memory, internal memory or primary storage. HasVolatileMemory indicates that the target :ref:`MemoryFacet <MemoryFacet>` is a volatile memory, i.e., a memory which requires power to maintain the stored information. Volatile memory is also known as main memory, internal memory or primary storage.
.. table:: **HasVolatileMemory** ``extends`` **HasMemory** .. table:: **HasVolatileMemory** ``extends`` **HasMemory**
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+===================+==================+=================+=================================================================================================================================================================================================================================================+ +======================================================+==============================================+==================+==================================+==============================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | HasVolatileMemory | 0..n | MemoryFacet | HasVolatileMemory indicates that the target {@link MemoryFacet} is a volatile memory, i.e., a memory which requires power to maintain the stored information. Volatile memory is also known as main memory, internal memory or primary storage. | | :ref:`Resource <Resource>` | :ref:`HasVolatileMemory <HasVolatileMemory>` | 0..n | :ref:`MemoryFacet <MemoryFacet>` | HasVolatileMemory indicates that the target :ref:`MemoryFacet <MemoryFacet>` is a volatile memory, i.e., a memory which requires power to maintain the stored information. Volatile memory is also known as main memory, internal memory or primary storage. |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | HasVolatileMemory | 1..n | MemoryFacet | The RAM Capacity of the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`HasVolatileMemory <HasVolatileMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The RAM Capacity of the Hosting Node. |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | HasVolatileMemory | 1..n | MemoryFacet | The RAM Capacity of the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`HasVolatileMemory <HasVolatileMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The RAM Capacity of the Virtual Machine. |
+------------------------------------------------------+-------------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------------+------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HasVolatileMemory** current version is 1.0.0. The **HasVolatileMemory** current version is 1.0.0.
@ -627,53 +663,55 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsIdentifiedBy:
IsIdentifiedBy IsIdentifiedBy
-------------- --------------
Each {@link GCubeResource} has been defined to have at least a facet linked with an IsIdentifiedBy relation. IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource. For instance, a software can consist of one or more {@link SoftwareFacet} but the one related with IsIdentifiedBy represents the identify of the software. Each :ref:`GCubeResource <GCubeResource>` has been defined to have at least a facet linked with an IsIdentifiedBy relation. IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource. For instance, a software can consist of one or more :ref:`SoftwareFacet <SoftwareFacet>` but the one related with IsIdentifiedBy represents the identify of the software.
.. table:: **IsIdentifiedBy** ``extends`` **ConsistsOf** .. table:: **IsIdentifiedBy** ``extends`` **ConsistsOf**
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=================+=====================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+========================================+==================+==========================================+===================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Resource | IsIdentifiedBy | 0..n | Facet | Each {@link GCubeResource} has been defined to have at least a facet linked with an IsIdentifiedBy relation. IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource. For instance, a software can consist of one or more {@link SoftwareFacet} but the one related with IsIdentifiedBy represents the identify of the software. | | :ref:`Resource <Resource>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 0..n | :ref:`Facet <Facet>` | Each :ref:`GCubeResource <GCubeResource>` has been defined to have at least a facet linked with an IsIdentifiedBy relation. IsIdentifiedBy indicates that the target facet represents a sort of identification for the source resource. For instance, a software can consist of one or more :ref:`SoftwareFacet <SoftwareFacet>` but the one related with IsIdentifiedBy represents the identify of the software. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. | | :ref:`Actor <Actor>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`ContactFacet <ContactFacet>` | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConfigurationTemplate | IsIdentifiedBy | 1..1 | IdentifierFacet | | | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsIdentifiedBy | 1..1 | IdentifierFacet | The set of Identifiers associated with the Dataset instance. | | :ref:`Dataset <Dataset>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | The set of Identifiers associated with the Dataset instance. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EService | IsIdentifiedBy | 1..1 | SoftwareFacet | The main software enabling the EService capabilities. | | :ref:`EService <EService>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SoftwareFacet <SoftwareFacet>` | The main software enabling the EService capabilities. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| GCubeResource | IsIdentifiedBy | 1..1 | Facet | Any Resource has at least one Facet which in some way allow to identify the Resource per se. | | :ref:`GCubeResource <GCubeResource>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`Facet <Facet>` | Any Resource has at least one Facet which in some way allow to identify the Resource per se. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | IsIdentifiedBy | 1..1 | NetworkingFacet | The Network ID characterising the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`NetworkingFacet <NetworkingFacet>` | The Network ID characterising the Hosting Node. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Schema | IsIdentifiedBy | 1..1 | SchemaFacet | | | :ref:`Schema <Schema>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SchemaFacet <SchemaFacet>` | |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | IsIdentifiedBy | 1..1 | IdentifierFacet | The Site Identifier. | | :ref:`Site <Site>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | The Site Identifier. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | IsIdentifiedBy | 1..1 | SoftwareFacet | Software coordinates which identify the Software per se. | | :ref:`Software <Software>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SoftwareFacet <SoftwareFacet>` | Software coordinates which identify the Software per se. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | IsIdentifiedBy | 1..1 | NetworkingFacet | The Network ID characterising the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`NetworkingFacet <NetworkingFacet>` | The Network ID characterising the Virtual Machine. |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualService | IsIdentifiedBy | 1..n | SoftwareFacet | | | :ref:`VirtualService <VirtualService>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..n | :ref:`SoftwareFacet <SoftwareFacet>` | |
+------------------------------------------------------+----------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **IsIdentifiedBy** current version is 1.0.0. The **IsIdentifiedBy** current version is 1.0.0.

624
gcube-model-facet.rst
View File

File diff suppressed because it is too large Load Diff

578
gcube-model-isrelatedto.rst
View File

@ -1,35 +1,39 @@
.. _IsRelatedTo:
IsRelatedTo IsRelatedTo
=========== ===========
.. _Activates:
Activates Activates
--------- ---------
Activates has a {@link Service} instance both as source and target as well as {@link CallsFor} but with a complete different semantic. Activates is used to indicates that the source {@link Service} of the relation enable the operation of the target Service. Examples are between a {@link VirtualMachine} and an {@link HostingNode} to capture the {@link VirtualMachine} is operating the {@link HostingNode}. Another example is between a {@link VirtualMachine} and an {@link EService}, e.g., between a {@link VirtualMachine} and a database instance. This relation can be created also between an {@link HostingNode} and one {@link EService}, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an {@link EService} and a {@link RunningPlugin} which enrich the functionality offered by the source service. Activates has a :ref:`Service <Service>` instance both as source and target as well as :ref:`CallsFor <CallsFor>` but with a complete different semantic. Activates is used to indicates that the source :ref:`Service <Service>` of the relation enable the operation of the target Service. Examples are between a :ref:`VirtualMachine <VirtualMachine>` and an :ref:`HostingNode <HostingNode>` to capture the :ref:`VirtualMachine <VirtualMachine>` is operating the :ref:`HostingNode <HostingNode>`. Another example is between a :ref:`VirtualMachine <VirtualMachine>` and an :ref:`EService <EService>`, e.g., between a :ref:`VirtualMachine <VirtualMachine>` and a database instance. This relation can be created also between an :ref:`HostingNode <HostingNode>` and one :ref:`EService <EService>`, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an :ref:`EService <EService>` and a :ref:`RunningPlugin <RunningPlugin>` which enrich the functionality offered by the source service.
.. table:: **Activates** ``extends`` **IsRelatedTo** .. table:: **Activates** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+==============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+==============================+==================+==========================+==============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Activates | 0..n | Service | Activates has a {@link Service} instance both as source and target as well as {@link CallsFor} but with a complete different semantic. Activates is used to indicates that the source {@link Service} of the relation enable the operation of the target Service. Examples are between a {@link VirtualMachine} and an {@link HostingNode} to capture the {@link VirtualMachine} is operating the {@link HostingNode}. Another example is between a {@link VirtualMachine} and an {@link EService}, e.g., between a {@link VirtualMachine} and a database instance. This relation can be created also between an {@link HostingNode} and one {@link EService}, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an {@link EService} and a {@link RunningPlugin} which enrich the functionality offered by the source service. | | :ref:`Service <Service>` | :ref:`Activates <Activates>` | 0..n | :ref:`Service <Service>` | Activates has a :ref:`Service <Service>` instance both as source and target as well as :ref:`CallsFor <CallsFor>` but with a complete different semantic. Activates is used to indicates that the source :ref:`Service <Service>` of the relation enable the operation of the target Service. Examples are between a :ref:`VirtualMachine <VirtualMachine>` and an :ref:`HostingNode <HostingNode>` to capture the :ref:`VirtualMachine <VirtualMachine>` is operating the :ref:`HostingNode <HostingNode>`. Another example is between a :ref:`VirtualMachine <VirtualMachine>` and an :ref:`EService <EService>`, e.g., between a :ref:`VirtualMachine <VirtualMachine>` and a database instance. This relation can be created also between an :ref:`HostingNode <HostingNode>` and one :ref:`EService <EService>`, e.g., to represent a container e.g., Tomcat and the web-service(s) is operating. Activates is also used between an :ref:`EService <EService>` and a :ref:`RunningPlugin <RunningPlugin>` which enrich the functionality offered by the source service. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Activates | 0..n | Service | The source Service enables the target Service to be running. Examples are an Hosting Node which enables an EService; A VirtualMachine enabling an EService or an HostingNode; An EService enabling a RunningPlugin; A VirtualMachine enabling an HostingNode etc | | :ref:`Service <Service>` | :ref:`Activates <Activates>` | 0..n | :ref:`Service <Service>` | The source Service enables the target Service to be running. Examples are an Hosting Node which enables an EService; A VirtualMachine enabling an EService or an HostingNode; An EService enabling a RunningPlugin; A VirtualMachine enabling an HostingNode etc |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Activates** current version is 1.0.0. The **Activates** current version is 1.0.0.
@ -39,33 +43,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _BelongsTo:
BelongsTo BelongsTo
--------- ---------
BelongsTo indicates that a {@link Person} belong to the target {@link LegalBody}. BelongsTo indicates that a :ref:`Person <Person>` belong to the target :ref:`LegalBody <LegalBody>`.
.. table:: **BelongsTo** ``extends`` **IsRelatedTo** .. table:: **BelongsTo** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+===================================================================================+ +======================================================+==============================+==================+==============================+======================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| Person | BelongsTo | 0..n | LegalBody | BelongsTo indicates that a {@link Person} belong to the target {@link LegalBody}. | | :ref:`Person <Person>` | :ref:`BelongsTo <BelongsTo>` | 0..n | :ref:`LegalBody <LegalBody>` | BelongsTo indicates that a :ref:`Person <Person>` belong to the target :ref:`LegalBody <LegalBody>`. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
| Person | BelongsTo | 0..n | LegalBody | | | :ref:`Person <Person>` | :ref:`BelongsTo <BelongsTo>` | 0..n | :ref:`LegalBody <LegalBody>` | |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+------------------------------+------------------------------------------------------------------------------------------------------+
The **BelongsTo** current version is 1.0.0. The **BelongsTo** current version is 1.0.0.
@ -75,33 +81,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _CallsFor:
CallsFor CallsFor
-------- --------
A {@link Service} instance can require another {@link Service} instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for {@link Requires} relation conducted to the definition for this relation. A :ref:`Service <Service>` instance can require another :ref:`Service <Service>` instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for :ref:`Requires <Requires>` relation conducted to the definition for this relation.
.. table:: **CallsFor** ``extends`` **IsRelatedTo** .. table:: **CallsFor** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+===============================================================================================================================================================================================================================================+ +======================================================+============================+==================+==========================+===========================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | CallsFor | 0..n | Service | A {@link Service} instance can require another {@link Service} instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for {@link Requires} relation conducted to the definition for this relation. | | :ref:`Service <Service>` | :ref:`CallsFor <CallsFor>` | 0..n | :ref:`Service <Service>` | A :ref:`Service <Service>` instance can require another :ref:`Service <Service>` instance to properly operate and this is indicated with CallsFor. Motivations similar to the ones for :ref:`Requires <Requires>` relation conducted to the definition for this relation. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | CallsFor | 0..n | Service | A reference to the Services needed by the target instance to work. | | :ref:`Service <Service>` | :ref:`CallsFor <CallsFor>` | 0..n | :ref:`Service <Service>` | A reference to the Services needed by the target instance to work. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **CallsFor** current version is 1.0.0. The **CallsFor** current version is 1.0.0.
@ -111,33 +119,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Discovers:
Discovers Discovers
^^^^^^^^^ ^^^^^^^^^
Any {@link EService} or its specialisations can be related with another {@link EService} with Discovers relation. Discovers relation inform that the source {@link EService} discovers the target through the information system.Discovers relation specialise the semantic of {@link CallsFor}. Any :ref:`EService <EService>` or its specialisations can be related with another :ref:`EService <EService>` with Discovers relation. Discovers relation inform that the source :ref:`EService <EService>` discovers the target through the information system.Discovers relation specialise the semantic of :ref:`CallsFor <CallsFor>`.
.. table:: **Discovers** ``extends`` **CallsFor** .. table:: **Discovers** ``extends`` **CallsFor**
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+==================================================================================================================================================================================================================================================================================================+ +======================================================+==============================+==================+============================+==========================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EService | Discovers | 0..n | EService | Any {@link EService} or its specialisations can be related with another {@link EService} with Discovers relation. Discovers relation inform that the source {@link EService} discovers the target through the information system.Discovers relation specialise the semantic of {@link CallsFor}. | | :ref:`EService <EService>` | :ref:`Discovers <Discovers>` | 0..n | :ref:`EService <EService>` | Any :ref:`EService <EService>` or its specialisations can be related with another :ref:`EService <EService>` with Discovers relation. Discovers relation inform that the source :ref:`EService <EService>` discovers the target through the information system.Discovers relation specialise the semantic of :ref:`CallsFor <CallsFor>`. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EService | Discovers | 0..n | EService | A reference to any other EService, the EService instance is discovering through query on IS. | | :ref:`EService <EService>` | :ref:`Discovers <Discovers>` | 0..n | :ref:`EService <EService>` | A reference to any other EService, the EService instance is discovering through query on IS. |
+------------------------------------------------------+--------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Discovers** current version is 1.0.0. The **Discovers** current version is 1.0.0.
@ -147,33 +157,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Uses:
Uses Uses
^^^^ ^^^^
Uses relation inform regarding the network invocation of the target{@link EService} by the source. Uses relation specialises the semantic of {@link CallsFor}. Uses relation inform regarding the network invocation of the target:ref:`EService <EService>` by the source. Uses relation specialises the semantic of :ref:`CallsFor <CallsFor>`.
.. table:: **Uses** ``extends`` **CallsFor** .. table:: **Uses** ``extends`` **CallsFor**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+================================================================================================================================================================+ +======================================================+====================+==================+============================+====================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EService | Uses | 0..n | EService | Uses relation inform regarding the network invocation of the target{@link EService} by the source. Uses relation specialises the semantic of {@link CallsFor}. | | :ref:`EService <EService>` | :ref:`Uses <Uses>` | 0..n | :ref:`EService <EService>` | Uses relation inform regarding the network invocation of the target:ref:`EService <EService>` by the source. Uses relation specialises the semantic of :ref:`CallsFor <CallsFor>`. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EService | Uses | 0..n | EService | A reference to any other EService, the EService instance is invoking. | | :ref:`EService <EService>` | :ref:`Uses <Uses>` | 0..n | :ref:`EService <EService>` | A reference to any other EService, the EService instance is invoking. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------+------------------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Uses** current version is 1.0.0. The **Uses** current version is 1.0.0.
@ -183,33 +195,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Demands:
Demands Demands
------- -------
Demands is used to properly support to share a {@link VirtualService} with another context. Demands is used to properly support to share a :ref:`VirtualService <VirtualService>` with another context.
.. table:: **Demands** ``extends`` **IsRelatedTo** .. table:: **Demands** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=============================================================================================+ +======================================================+==========================+==================+============================+=============================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| VirtualService | Demands | 0..n | Software | Demands is used to properly support to share a {@link VirtualService} with another context. | | :ref:`VirtualService <VirtualService>` | :ref:`Demands <Demands>` | 0..n | :ref:`Software <Software>` | Demands is used to properly support to share a :ref:`VirtualService <VirtualService>` with another context. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
| VirtualService | Demands | 0..n | Software | | | :ref:`VirtualService <VirtualService>` | :ref:`Demands <Demands>` | 0..n | :ref:`Software <Software>` | |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------+
The **Demands** current version is 1.0.0. The **Demands** current version is 1.0.0.
@ -219,33 +233,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _DependsOn:
DependsOn DependsOn
--------- ---------
DependsOn indicates that a {@link Software} requires another one to work. This relation must not be confused with {@link Requires}. DependsOn indicates that a :ref:`Software <Software>` requires another one to work. This relation must not be confused with :ref:`Requires <Requires>`.
.. table:: **DependsOn** ``extends`` **IsRelatedTo** .. table:: **DependsOn** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=====================================================================================================================================+ +======================================================+==============================+==================+============================+=========================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | DependsOn | 0..n | Software | DependsOn indicates that a {@link Software} requires another one to work. This relation must not be confused with {@link Requires}. | | :ref:`Software <Software>` | :ref:`DependsOn <DependsOn>` | 0..n | :ref:`Software <Software>` | DependsOn indicates that a :ref:`Software <Software>` requires another one to work. This relation must not be confused with :ref:`Requires <Requires>`. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | DependsOn | 0..n | Software | To capture any dependency between two software artifacts. | | :ref:`Software <Software>` | :ref:`DependsOn <DependsOn>` | 0..n | :ref:`Software <Software>` | To capture any dependency between two software artifacts. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
The **DependsOn** current version is 1.0.0. The **DependsOn** current version is 1.0.0.
@ -255,35 +271,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsPluginOf:
IsPluginOf IsPluginOf
^^^^^^^^^^ ^^^^^^^^^^
A {@link Plugin} is a piece of Software extending the capabilities of another {@link Software} (main) and requiring the main {@link Software} to be executed. The relation between the main {@link Software} and the {@link Plugin} is expressed by IsPluginOf relation. IsPluginOf is an extension of {@link DependsOn}. A :ref:`Plugin <Plugin>` is a piece of Software extending the capabilities of another :ref:`Software <Software>` (main) and requiring the main :ref:`Software <Software>` to be executed. The relation between the main :ref:`Software <Software>` and the :ref:`Plugin <Plugin>` is expressed by IsPluginOf relation. IsPluginOf is an extension of :ref:`DependsOn <DependsOn>`.
.. table:: **IsPluginOf** ``extends`` **DependsOn** .. table:: **IsPluginOf** ``extends`` **DependsOn**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+============================================================================================================================================================================================================================================================================================================================+ +======================================================+================================+==================+============================+=====================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | A {@link Plugin} is a piece of Software extending the capabilities of another {@link Software} (main) and requiring the main {@link Software} to be executed. The relation between the main {@link Software} and the {@link Plugin} is expressed by IsPluginOf relation. IsPluginOf is an extension of {@link DependsOn}. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | A :ref:`Plugin <Plugin>` is a piece of Software extending the capabilities of another :ref:`Software <Software>` (main) and requiring the main :ref:`Software <Software>` to be executed. The relation between the main :ref:`Software <Software>` and the :ref:`Plugin <Plugin>` is expressed by IsPluginOf relation. IsPluginOf is an extension of :ref:`DependsOn <DependsOn>`. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | A reference to the Software this Plugin is conceived to extend the capabilities. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | A reference to the Software this Plugin is conceived to extend the capabilities. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | To capture the relation between a Software and its Plugins. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | To capture the relation between a Software and its Plugins. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **IsPluginOf** current version is 1.0.0. The **IsPluginOf** current version is 1.0.0.
@ -293,33 +311,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Enables:
Enables Enables
------- -------
Any {@link Service} representing running code of a specific software has the relation Enables targeted to the corresponding {@link Software}. Enables is used for example by {@link EService} to indicates the running software; from {@link HostingNode} to indicate the running software container; within {@link RunningPlugin} and the software represented as {@link Plugin}. Any :ref:`Service <Service>` representing running code of a specific software has the relation Enables targeted to the corresponding :ref:`Software <Software>`. Enables is used for example by :ref:`EService <EService>` to indicates the running software; from :ref:`HostingNode <HostingNode>` to indicate the running software container; within :ref:`RunningPlugin <RunningPlugin>` and the software represented as :ref:`Plugin <Plugin>`.
.. table:: **Enables** ``extends`` **IsRelatedTo** .. table:: **Enables** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+====================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+==========================+==================+============================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Enables | 0..n | Software | Any {@link Service} representing running code of a specific software has the relation Enables targeted to the corresponding {@link Software}. Enables is used for example by {@link EService} to indicates the running software; from {@link HostingNode} to indicate the running software container; within {@link RunningPlugin} and the software represented as {@link Plugin}. | | :ref:`Service <Service>` | :ref:`Enables <Enables>` | 0..n | :ref:`Software <Software>` | Any :ref:`Service <Service>` representing running code of a specific software has the relation Enables targeted to the corresponding :ref:`Software <Software>`. Enables is used for example by :ref:`EService <EService>` to indicates the running software; from :ref:`HostingNode <HostingNode>` to indicate the running software container; within :ref:`RunningPlugin <RunningPlugin>` and the software represented as :ref:`Plugin <Plugin>`. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Enables | 0..n | Software | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). | | :ref:`Service <Service>` | :ref:`Enables <Enables>` | 0..n | :ref:`Software <Software>` | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Enables** current version is 1.0.0. The **Enables** current version is 1.0.0.
@ -329,33 +349,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Hosts:
Hosts Hosts
----- -----
Hosts relation is used from a {@link Site} a {@link Service} instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a {@link Site} to a {@link VirtualMachine}. When, instead a Site provides web-services, Hosts relation is created with {@link EService}. If a site provides container facilities Hosts relation is created with {@link HostingNode}. By defining Hosts relation with target {@link Service}, the model is capable of representing the diverse type of federated systems and service. Hosts relation is used from a :ref:`Site <Site>` a :ref:`Service <Service>` instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a :ref:`Site <Site>` to a :ref:`VirtualMachine <VirtualMachine>`. When, instead a Site provides web-services, Hosts relation is created with :ref:`EService <EService>`. If a site provides container facilities Hosts relation is created with :ref:`HostingNode <HostingNode>`. By defining Hosts relation with target :ref:`Service <Service>`, the model is capable of representing the diverse type of federated systems and service.
.. table:: **Hosts** ``extends`` **IsRelatedTo** .. table:: **Hosts** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+======================+==================+==========================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | Hosts | 0..n | Service | Hosts relation is used from a {@link Site} a {@link Service} instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a {@link Site} to a {@link VirtualMachine}. When, instead a Site provides web-services, Hosts relation is created with {@link EService}. If a site provides container facilities Hosts relation is created with {@link HostingNode}. By defining Hosts relation with target {@link Service}, the model is capable of representing the diverse type of federated systems and service. | | :ref:`Site <Site>` | :ref:`Hosts <Hosts>` | 0..n | :ref:`Service <Service>` | Hosts relation is used from a :ref:`Site <Site>` a :ref:`Service <Service>` instance. The target of the Hosts relation depends on the service offered by the Site. When the resources provided by a site are virtual machines, Hosts relation is created from a :ref:`Site <Site>` to a :ref:`VirtualMachine <VirtualMachine>`. When, instead a Site provides web-services, Hosts relation is created with :ref:`EService <EService>`. If a site provides container facilities Hosts relation is created with :ref:`HostingNode <HostingNode>`. By defining Hosts relation with target :ref:`Service <Service>`, the model is capable of representing the diverse type of federated systems and service. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | Hosts | 0..n | Service | | | :ref:`Site <Site>` | :ref:`Hosts <Hosts>` | 0..n | :ref:`Service <Service>` | |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------+------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Hosts** current version is 1.0.0. The **Hosts** current version is 1.0.0.
@ -365,33 +387,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Involves:
Involves Involves
-------- --------
Involves is used to indicate that and {@link Actor} is involved in a {@link Dataset}. Involves is used to indicate that and :ref:`Actor <Actor>` is involved in a :ref:`Dataset <Dataset>`.
.. table:: **Involves** ``extends`` **IsRelatedTo** .. table:: **Involves** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================+ +======================================================+============================+==================+======================+=======================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | Involves is used to indicate that and {@link Actor} is involved in a {@link Dataset}. | | :ref:`Dataset <Dataset>` | :ref:`Involves <Involves>` | 0..n | :ref:`Actor <Actor>` | Involves is used to indicate that and :ref:`Actor <Actor>` is involved in a :ref:`Dataset <Dataset>`. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | | | :ref:`Dataset <Dataset>` | :ref:`Involves <Involves>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+----------------------+-------------------------------------------------------------------------------------------------------+
The **Involves** current version is 1.0.0. The **Involves** current version is 1.0.0.
@ -401,33 +425,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsCompliantWith:
IsCompliantWith IsCompliantWith
--------------- ---------------
IsCompliantWith is used to indicated a {@link Dataset} compliant with a {@link Schema}. IsCompliantWith is used to indicated a :ref:`Dataset <Dataset>` compliant with a :ref:`Schema <Schema>`.
.. table:: **IsCompliantWith** ``extends`` **IsRelatedTo** .. table:: **IsCompliantWith** ``extends`` **IsRelatedTo**
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+=================+==================+=================+========================================================================================================================+ +======================================================+==========================================+==================+========================+========================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsCompliantWith | 0..n | Schema | IsCompliantWith is used to indicated a {@link Dataset} compliant with a {@link Schema}. | | :ref:`Dataset <Dataset>` | :ref:`IsCompliantWith <IsCompliantWith>` | 0..n | :ref:`Schema <Schema>` | IsCompliantWith is used to indicated a :ref:`Dataset <Dataset>` compliant with a :ref:`Schema <Schema>`. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsCompliantWith | 0..n | Schema | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. | | :ref:`Dataset <Dataset>` | :ref:`IsCompliantWith <IsCompliantWith>` | 0..n | :ref:`Schema <Schema>` | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. |
+------------------------------------------------------+-----------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------------------+------------------+------------------------+------------------------------------------------------------------------------------------------------------------------+
The **IsCompliantWith** current version is 1.0.0. The **IsCompliantWith** current version is 1.0.0.
@ -437,33 +463,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsConfiguredBy:
IsConfiguredBy IsConfiguredBy
-------------- --------------
The relation IsConfiguredBy indicates that the source {@link Software} requires a configuration when it is instantiated. The relation IsConfiguredBy indicates that the source :ref:`Software <Software>` requires a configuration when it is instantiated.
.. table:: **IsConfiguredBy** ``extends`` **IsRelatedTo** .. table:: **IsConfiguredBy** ``extends`` **IsRelatedTo**
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=======================+==========================================================================================================================+ +======================================================+========================================+==================+======================================================+====================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Software | IsConfiguredBy | 0..n | ConfigurationTemplate | The relation IsConfiguredBy indicates that the source {@link Software} requires a configuration when it is instantiated. | | :ref:`Software <Software>` | :ref:`IsConfiguredBy <IsConfiguredBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | The relation IsConfiguredBy indicates that the source :ref:`Software <Software>` requires a configuration when it is instantiated. |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Software | IsConfiguredBy | 0..n | ConfigurationTemplate | | | :ref:`Software <Software>` | :ref:`IsConfiguredBy <IsConfiguredBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
The **IsConfiguredBy** current version is 1.0.0. The **IsConfiguredBy** current version is 1.0.0.
@ -473,33 +501,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsCorrelatedTo:
IsCorrelatedTo IsCorrelatedTo
-------------- --------------
IsCorrelatedTo relates a {@link Dataset} to another. IsCorrelatedTo relates a :ref:`Dataset <Dataset>` to another.
.. table:: **IsCorrelatedTo** ``extends`` **IsRelatedTo** .. table:: **IsCorrelatedTo** ``extends`` **IsRelatedTo**
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=================+======================================================+ +======================================================+========================================+==================+==========================+===============================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| Dataset | IsCorrelatedTo | 0..n | Dataset | IsCorrelatedTo relates a {@link Dataset} to another. | | :ref:`Dataset <Dataset>` | :ref:`IsCorrelatedTo <IsCorrelatedTo>` | 0..n | :ref:`Dataset <Dataset>` | IsCorrelatedTo relates a :ref:`Dataset <Dataset>` to another. |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
| Dataset | IsCorrelatedTo | 0..n | Dataset | | | :ref:`Dataset <Dataset>` | :ref:`IsCorrelatedTo <IsCorrelatedTo>` | 0..n | :ref:`Dataset <Dataset>` | |
+------------------------------------------------------+----------------+------------------+-----------------+------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+--------------------------+---------------------------------------------------------------+
The **IsCorrelatedTo** current version is 1.0.0. The **IsCorrelatedTo** current version is 1.0.0.
@ -509,33 +539,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsPartOf:
IsPartOf IsPartOf
^^^^^^^^ ^^^^^^^^
IsPartOf is used when a {@link ConcreteDataset} is part of a {@link Dataset}. IsPartOf is used when a :ref:`ConcreteDataset <ConcreteDataset>` is part of a :ref:`Dataset <Dataset>`.
.. table:: **IsPartOf** ``extends`` **IsCorrelatedTo** .. table:: **IsPartOf** ``extends`` **IsCorrelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=================================================================================+ +======================================================+============================+==================+==========================+=========================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| ConcreteDataset | IsPartOf | 0..n | Dataset | IsPartOf is used when a {@link ConcreteDataset} is part of a {@link Dataset}. | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`IsPartOf <IsPartOf>` | 0..n | :ref:`Dataset <Dataset>` | IsPartOf is used when a :ref:`ConcreteDataset <ConcreteDataset>` is part of a :ref:`Dataset <Dataset>`. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
| ConcreteDataset | IsPartOf | 0..n | Dataset | The reference to the 'incarnations'/'manifestations' contributing to a dataset. | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`IsPartOf <IsPartOf>` | 0..n | :ref:`Dataset <Dataset>` | The reference to the 'incarnations'/'manifestations' contributing to a dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+---------------------------------------------------------------------------------------------------------+
The **IsPartOf** current version is 1.0.0. The **IsPartOf** current version is 1.0.0.
@ -545,35 +577,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsCustomizedBy:
IsCustomizedBy IsCustomizedBy
-------------- --------------
IsCustomizedBy evidences that any {@link Service} can be customised by a {@link ConfigurationTemplate}. IsCustomizedBy evidences that any :ref:`Service <Service>` can be customised by a :ref:`ConfigurationTemplate <ConfigurationTemplate>`.
.. table:: **IsCustomizedBy** ``extends`` **IsRelatedTo** .. table:: **IsCustomizedBy** ``extends`` **IsRelatedTo**
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=======================+=========================================================================================================+ +======================================================+========================================+==================+======================================================+=========================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | IsCustomizedBy evidences that any {@link Service} can be customised by a {@link ConfigurationTemplate}. | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | IsCustomizedBy evidences that any :ref:`Service <Service>` can be customised by a :ref:`ConfigurationTemplate <ConfigurationTemplate>`. |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | A reference to any configuration characterising the Service behaviour. | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | A reference to any configuration characterising the Service behaviour. |
+------------------------------------------------------+----------------+------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
The **IsCustomizedBy** current version is 1.0.0. The **IsCustomizedBy** current version is 1.0.0.
@ -583,33 +617,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsDerivationOf:
IsDerivationOf IsDerivationOf
-------------- --------------
IsDerivationOf indicate that the source {@link Configuration} is an instantiation of the target {@link ConfigurationTemplate}. IsDerivationOf indicate that the source :ref:`Configuration <Configuration>` is an instantiation of the target :ref:`ConfigurationTemplate <ConfigurationTemplate>`.
.. table:: **IsDerivationOf** ``extends`` **IsRelatedTo** .. table:: **IsDerivationOf** ``extends`` **IsRelatedTo**
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+================+==================+=======================+================================================================================================================================+ +======================================================+========================================+==================+======================================================+======================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Configuration | IsDerivationOf | 0..n | ConfigurationTemplate | IsDerivationOf indicate that the source {@link Configuration} is an instantiation of the target {@link ConfigurationTemplate}. | | :ref:`Configuration <Configuration>` | :ref:`IsDerivationOf <IsDerivationOf>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | IsDerivationOf indicate that the source :ref:`Configuration <Configuration>` is an instantiation of the target :ref:`ConfigurationTemplate <ConfigurationTemplate>`. |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Configuration | IsDerivationOf | 0..n | ConfigurationTemplate | | | :ref:`Configuration <Configuration>` | :ref:`IsDerivationOf <IsDerivationOf>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------------------------------------+----------------+------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **IsDerivationOf** current version is 1.0.0. The **IsDerivationOf** current version is 1.0.0.
@ -619,33 +655,35 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsOwnedBy:
IsOwnedBy IsOwnedBy
--------- ---------
Any {@link Site} is owned by an {@link Actor} and this is captured by the IsOwnedBy relation. The referenced {@link Actor} can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site. Any :ref:`Site <Site>` is owned by an :ref:`Actor <Actor>` and this is captured by the IsOwnedBy relation. The referenced :ref:`Actor <Actor>` can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site.
.. table:: **IsOwnedBy** ``extends`` **IsRelatedTo** .. table:: **IsOwnedBy** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=======================================================================================================================================================================================================================================================================================================+ +======================================================+==============================+==================+======================+===========================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | Any {@link Site} is owned by an {@link Actor} and this is captured by the IsOwnedBy relation. The referenced {@link Actor} can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site. | | :ref:`Site <Site>` | :ref:`IsOwnedBy <IsOwnedBy>` | 0..n | :ref:`Actor <Actor>` | Any :ref:`Site <Site>` is owned by an :ref:`Actor <Actor>` and this is captured by the IsOwnedBy relation. The referenced :ref:`Actor <Actor>` can be used as a contact point during an emergency, to agree on the scheduling of a site downtime and to request additional resources during the downtime of another site. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | | | :ref:`Site <Site>` | :ref:`IsOwnedBy <IsOwnedBy>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------------------------------------+--------------+------------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+------------------------------+------------------+----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **IsOwnedBy** current version is 1.0.0. The **IsOwnedBy** current version is 1.0.0.
@ -655,35 +693,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Manages:
Manages Manages
------- -------
Manages indicates that of the source {@link Service} manages the target {@link Dataset}, e.g. read, manipulate, etc. Manages indicates that of the source :ref:`Service <Service>` manages the target :ref:`Dataset <Dataset>`, e.g. read, manipulate, etc.
.. table:: **Manages** ``extends`` **IsRelatedTo** .. table:: **Manages** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+=========================================================================================================================================+ +======================================================+==========================+==================+==========================+=========================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | Manages indicates that of the source {@link Service} manages the target {@link Dataset}, e.g. read, manipulate, etc. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | Manages indicates that of the source :ref:`Service <Service>` manages the target :ref:`Dataset <Dataset>`, e.g. read, manipulate, etc. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | A reference to any Dataset resource managed by the Service instance. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | A reference to any Dataset resource managed by the Service instance. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. |
+------------------------------------------------------+--------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+--------------------------+------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
The **Manages** current version is 1.0.0. The **Manages** current version is 1.0.0.
@ -693,35 +733,37 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Requires:
Requires Requires
-------- --------
Requires is used to indicate that the source {@link Software} when activated requires to interact with a specific {@link Service} instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead {@link DependsOn} which is between two {@link Software}.Not necessarily all the {@link Software} running in the infrastructure are represented as resources. Only the {@link Software} required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains. Requires is used to indicate that the source :ref:`Software <Software>` when activated requires to interact with a specific :ref:`Service <Service>` instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead :ref:`DependsOn <DependsOn>` which is between two :ref:`Software <Software>`.Not necessarily all the :ref:`Software <Software>` running in the infrastructure are represented as resources. Only the :ref:`Software <Software>` required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains.
.. table:: **Requires** ``extends`` **IsRelatedTo** .. table:: **Requires** ``extends`` **IsRelatedTo**
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +======================================================+============================+==================+==========================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | Requires | 0..n | Service | Requires is used to indicate that the source {@link Software} when activated requires to interact with a specific {@link Service} instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead {@link DependsOn} which is between two {@link Software}.Not necessarily all the {@link Software} running in the infrastructure are represented as resources. Only the {@link Software} required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains. | | :ref:`Software <Software>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | Requires is used to indicate that the source :ref:`Software <Software>` when activated requires to interact with a specific :ref:`Service <Service>` instance, i.e., the target of the relation. This relation usually reflects an administrative constraint than a technological limitation. When there are no constraint on the instance the relation is instead :ref:`DependsOn <DependsOn>` which is between two :ref:`Software <Software>`.Not necessarily all the :ref:`Software <Software>` running in the infrastructure are represented as resources. Only the :ref:`Software <Software>` required for infrastructure administration or the ones to be managed with specific policies are represented. Indeed, Requires relation is normally used as policy constraint. Let imagine an open source software which uses a MySQL database as backend. In many cases, what characterises the software instance is the data present in the backend. The infrastructure manager could stipulate an agreement with a provider having a particular set of data which is not for public domain. The software once deployed, giving the business agreement, is entitled to use the instance of the provider and not a generic MySQL database instance. The infrastructure manager imposes the use of such a particular instance because of the data it contains. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Requires | 0..n | Service | A reference to any Service needed by a Software to properly operate, e.g. this can be used to capture a sort of run-time requirements between a software component and the Service it needs. | | :ref:`Service <Service>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | A reference to any Service needed by a Software to properly operate, e.g. this can be used to capture a sort of run-time requirements between a software component and the Service it needs. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | Requires | 0..n | Service | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. | | :ref:`Software <Software>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. |
+------------------------------------------------------+--------------+------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------+------------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Requires** current version is 1.0.0. The **Requires** current version is 1.0.0.

22
gcube-model-property.rst
View File

@ -1,8 +1,12 @@
.. _Property:
Property Property
======== ========
.. _GCubeProperty:
GCubeProperty GCubeProperty
------------- -------------
@ -25,6 +29,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _AccessPolicy:
AccessPolicy AccessPolicy
^^^^^^^^^^^^ ^^^^^^^^^^^^
@ -33,13 +39,13 @@ AccessPolicy information
.. table:: **AccessPolicy** ``extends`` **GCubeProperty** .. table:: **AccessPolicy** ``extends`` **GCubeProperty**
+--------+-------------+----------------------------------------------------------+-------------+ +--------+----------------------------------+----------------------------------------------------------+-------------+
| Name | Type | Attributes | Description | | Name | Type | Attributes | Description |
+========+=============+==========================================================+=============+ +========+==================================+==========================================================+=============+
| note | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | | note | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | |
+--------+-------------+----------------------------------------------------------+-------------+ +--------+----------------------------------+----------------------------------------------------------+-------------+
| policy | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | | policy | :ref:`ValueSchema <ValueSchema>` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | |
+--------+-------------+----------------------------------------------------------+-------------+ +--------+----------------------------------+----------------------------------------------------------+-------------+
The **AccessPolicy** current version is 1.0.0. The **AccessPolicy** current version is 1.0.0.
@ -49,6 +55,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _EnumStringProperty:
EnumStringProperty EnumStringProperty
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
@ -71,6 +79,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _RegexProperty:
RegexProperty RegexProperty
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -95,6 +105,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _ValueSchema:
ValueSchema ValueSchema
^^^^^^^^^^^ ^^^^^^^^^^^

610
gcube-model-resource.rst
View File

@ -1,8 +1,12 @@
.. _Resource:
Resource Resource
======== ========
.. _GCubeResource:
GCubeResource GCubeResource
------------- -------------
@ -11,17 +15,17 @@ Marker type for any gCube Resource extended in the gCube model.
.. table:: **GCubeResource** ``extends`` **Resource** .. table:: **GCubeResource** ``extends`` **Resource**
+-------------------------------------------------------+----------------+--------------+--------+----------------------------------------------------------------------------------------------+ +-------------------------------------------------------+----------------------------------------+--------------+----------------------+----------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=======================================================+================+==============+========+==============================================================================================+ +=======================================================+========================================+==============+======================+==============================================================================================+
| **Facets** | | **Facets** |
+-------------------------------------------------------+----------------+--------------+--------+----------------------------------------------------------------------------------------------+ +-------------------------------------------------------+----------------------------------------+--------------+----------------------+----------------------------------------------------------------------------------------------+
| GCubeResource | IsIdentifiedBy | 1..1 | Facet | Any Resource has at least one Facet which in some way allow to identify the Resource per se. | | :ref:`GCubeResource <GCubeResource>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`Facet <Facet>` | Any Resource has at least one Facet which in some way allow to identify the Resource per se. |
+-------------------------------------------------------+----------------+--------------+--------+----------------------------------------------------------------------------------------------+ +-------------------------------------------------------+----------------------------------------+--------------+----------------------+----------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------------+----------------+--------------+--------+----------------------------------------------------------------------------------------------+ +-------------------------------------------------------+----------------------------------------+--------------+----------------------+----------------------------------------------------------------------------------------------+
| No specific Resource relations defined for this type. | | No specific Resource relations defined for this type. |
+-------------------------------------------------------+----------------+--------------+--------+----------------------------------------------------------------------------------------------+ +-------------------------------------------------------+----------------------------------------+--------------+----------------------+----------------------------------------------------------------------------------------------+
The **GCubeResource** current version is 1.0.0. The **GCubeResource** current version is 1.0.0.
@ -31,29 +35,31 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Actor:
Actor Actor
^^^^^ ^^^^^
Actor (Abstract) is any entity (human or machine) playing an active role in the infrastructure. Actor has two specialisations, {@link LegalBody} which represent any legal entity, and {@link Person} which is any human playing the role of Actor. An Actor can belong to a {@link LegalBody} and this is expressed using the defined {@link BelongsTo} relation. Actor (Abstract) is any entity (human or machine) playing an active role in the infrastructure. Actor has two specialisations, :ref:`LegalBody <LegalBody>` which represent any legal entity, and :ref:`Person <Person>` which is any human playing the role of Actor. An Actor can belong to a :ref:`LegalBody <LegalBody>` and this is expressed using the defined :ref:`BelongsTo <BelongsTo>` relation.
.. table:: **Actor** ``extends`` **GCubeResource** .. table:: **Actor** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=======================+====================================================================================+ +==========================+========================================+==============+======================================================+====================================================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| Actor | ConsistsOf | 0..n | ContactReferenceFacet | | | :ref:`Actor <Actor>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`ContactReferenceFacet <ContactReferenceFacet>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. | | :ref:`Actor <Actor>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`ContactFacet <ContactFacet>` | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | | | :ref:`Dataset <Dataset>` | :ref:`Involves <Involves>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | | | :ref:`Site <Site>` | :ref:`IsOwnedBy <IsOwnedBy>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------------------+
The **Actor** current version is 1.0.0. The **Actor** current version is 1.0.0.
@ -63,6 +69,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _LegalBody:
LegalBody LegalBody
""""""""" """""""""
@ -71,17 +79,17 @@ LegalBody represents any legal entity playing the role of an Actor.
.. table:: **LegalBody** ``extends`` **Actor** .. table:: **LegalBody** ``extends`` **Actor**
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=================================================+===========+==============+===========+=============+ +=================================================+==============================+==============+==============================+=============+
| **Facets** | | **Facets** |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| No specific facets usage defined for this type. | | No specific facets usage defined for this type. |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| Person | BelongsTo | 0..n | LegalBody | | | :ref:`Person <Person>` | :ref:`BelongsTo <BelongsTo>` | 0..n | :ref:`LegalBody <LegalBody>` | |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
The **LegalBody** current version is 1.0.0. The **LegalBody** current version is 1.0.0.
@ -91,6 +99,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Person:
Person Person
"""""" """"""
@ -99,17 +109,17 @@ Person represents any human playing the role of Actor.
.. table:: **Person** ``extends`` **Actor** .. table:: **Person** ``extends`` **Actor**
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=================================================+===========+==============+===========+=============+ +=================================================+==============================+==============+==============================+=============+
| **Facets** | | **Facets** |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| No specific facets usage defined for this type. | | No specific facets usage defined for this type. |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
| Person | BelongsTo | 0..n | LegalBody | | | :ref:`Person <Person>` | :ref:`BelongsTo <BelongsTo>` | 0..n | :ref:`LegalBody <LegalBody>` | |
+-------------------------------------------------+-----------+--------------+-----------+-------------+ +-------------------------------------------------+------------------------------+--------------+------------------------------+-------------+
The **Person** current version is 1.0.0. The **Person** current version is 1.0.0.
@ -119,6 +129,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _ConfigurationTemplate:
ConfigurationTemplate ConfigurationTemplate
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
@ -127,23 +139,23 @@ Configuration Template represents a template for a configuration. It describes h
.. table:: **ConfigurationTemplate** ``extends`` **GCubeResource** .. table:: **ConfigurationTemplate** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=======================+========================================================================+ +======================================================+========================================+==============+======================================================+========================================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| ConfigurationTemplate | IsIdentifiedBy | 1..1 | IdentifierFacet | | | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| Configuration | IsDerivationOf | 0..n | ConfigurationTemplate | | | :ref:`Configuration <Configuration>` | :ref:`IsDerivationOf <IsDerivationOf>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | A reference to any configuration characterising the Service behaviour. | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | A reference to any configuration characterising the Service behaviour. |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| Software | IsConfiguredBy | 0..n | ConfigurationTemplate | | | :ref:`Software <Software>` | :ref:`IsConfiguredBy <IsConfiguredBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------+ +------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
The **ConfigurationTemplate** current version is 1.0.0. The **ConfigurationTemplate** current version is 1.0.0.
@ -153,25 +165,27 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Configuration:
Configuration Configuration
""""""""""""" """""""""""""
Configuration is a specialisation of {@link ConfigurationTemplate} and is an instance of a configuration template characterising the behaviour and shape of the resource it is attached to. The Configuration can be related to the template it derives using {@link IsDerivationOf}. Configuration is a specialisation of :ref:`ConfigurationTemplate <ConfigurationTemplate>` and is an instance of a configuration template characterising the behaviour and shape of the resource it is attached to. The Configuration can be related to the template it derives using :ref:`IsDerivationOf <IsDerivationOf>`.
.. table:: **Configuration** ``extends`` **ConfigurationTemplate** .. table:: **Configuration** ``extends`` **ConfigurationTemplate**
+-------------------------------------------------+----------------+--------------+-----------------------+-------------+ +-------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+-------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=================================================+================+==============+=======================+=============+ +=================================================+========================================+==============+======================================================+=============+
| **Facets** | | **Facets** |
+-------------------------------------------------+----------------+--------------+-----------------------+-------------+ +-------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+-------------+
| No specific facets usage defined for this type. | | No specific facets usage defined for this type. |
+-------------------------------------------------+----------------+--------------+-----------------------+-------------+ +-------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+-------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------+----------------+--------------+-----------------------+-------------+ +-------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+-------------+
| Configuration | IsDerivationOf | 0..n | ConfigurationTemplate | | | :ref:`Configuration <Configuration>` | :ref:`IsDerivationOf <IsDerivationOf>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+-------------------------------------------------+----------------+--------------+-----------------------+-------------+ +-------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+-------------+
The **Configuration** current version is 1.0.0. The **Configuration** current version is 1.0.0.
@ -181,65 +195,67 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Dataset:
Dataset Dataset
^^^^^^^ ^^^^^^^
A Dataset is a set of digital objects representing data and treated collectively as a unit. It is the key resource of a HDI, even more, it is the reason the HDI exists. A Dataset can be correlated to another Dataset by using {@link IsCorrelatedTo} relation. A Dataset is a set of digital objects representing data and treated collectively as a unit. It is the key resource of a HDI, even more, it is the reason the HDI exists. A Dataset can be correlated to another Dataset by using :ref:`IsCorrelatedTo <IsCorrelatedTo>` relation.
.. table:: **Dataset** ``extends`` **GCubeResource** .. table:: **Dataset** ``extends`` **GCubeResource**
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+=====================+==============+==========================+=========================================================================================================================================================+ +==========================================+==================================================+==============+============================================================+=========================================================================================================================================================+
| **Facets** | | **Facets** |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | AccessPointFacet | The access point to use for having access to the dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`AccessPointFacet <AccessPointFacet>` | The access point to use for having access to the dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the dataset, e.g. for discovery purposes. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`DescriptiveMetadataFacet <DescriptiveMetadataFacet>` | Any descriptive information associated with the dataset, e.g. for discovery purposes. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | EventFacet | Any 'event' characterising the lifecycle of the dataset, e.g. collection date, last collection date. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`EventFacet <EventFacet>` | Any 'event' characterising the lifecycle of the dataset, e.g. collection date, last collection date. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | LicenseFacet | The licence governing dataset exploitation. The duration of license (if any) is captured by the expiry date defined in the consistsOf relation. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`LicenseFacet <LicenseFacet>` | The licence governing dataset exploitation. The duration of license (if any) is captured by the expiry date defined in the consistsOf relation. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`ProvenanceFacet <ProvenanceFacet>` | Any provenance record associated with the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | SubjectFacet | Any subject/tag associated with the dataset for descriptive and discovery purposes. | | :ref:`Dataset <Dataset>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SubjectFacet <SubjectFacet>` | Any subject/tag associated with the dataset for descriptive and discovery purposes. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasContact | 1..n | ContactFacet | The contact information of the entity responsible for the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasContributor | 0..n | ContactFacet | The contact information on contributors supporting the creation and development of the Dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasContributor <HasContributor>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information on contributors supporting the creation and development of the Dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCoverage | 1..n | CoverageFacet | Any coverage related information (e.g. topic, species) characterising the content of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCoverage <HasCoverage>` | 1..n | :ref:`CoverageFacet <CoverageFacet>` | Any coverage related information (e.g. topic, species) characterising the content of the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCreator | 0..n | ContactFacet | The contact information of the creator of the Dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCreator <HasCreator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the creator of the Dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasCurator | 0..n | ContactFacet | The contact information of the entity responsible for the curation of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasCurator <HasCurator>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the curation of the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasMaintainer | 0..n | ContactFacet | The contact information of the entity responsible for the maintenance of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasMaintainer <HasMaintainer>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the maintenance of the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasOwner | 0..n | ContactFacet | The contact information of the entity having the ownership of the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasOwner <HasOwner>` | 0..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity having the ownership of the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasSpatialCoverage | 0..n | CoverageFacet | Any geo-spatial coverage information characterising the content of the dataset, e.g. the area covered by the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasSpatialCoverage <HasSpatialCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | Any geo-spatial coverage information characterising the content of the dataset, e.g. the area covered by the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasTemporalCoverage | 0..n | CoverageFacet | Any temporal coverage information characterising the content of the dataset, e.g. the time-span covered by the dataset. | | :ref:`Dataset <Dataset>` | :ref:`HasTemporalCoverage <HasTemporalCoverage>` | 0..n | :ref:`CoverageFacet <CoverageFacet>` | Any temporal coverage information characterising the content of the dataset, e.g. the time-span covered by the dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsIdentifiedBy | 1..1 | IdentifierFacet | The set of Identifiers associated with the Dataset instance. | | :ref:`Dataset <Dataset>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | The set of Identifiers associated with the Dataset instance. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConcreteDataset | IsPartOf | 0..n | Dataset | The reference to the 'incarnations'/'manifestations' contributing to a dataset. | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`IsPartOf <IsPartOf>` | 0..n | :ref:`Dataset <Dataset>` | The reference to the 'incarnations'/'manifestations' contributing to a dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | | | :ref:`Dataset <Dataset>` | :ref:`Involves <Involves>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsCompliantWith | 0..n | Schema | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. | | :ref:`Dataset <Dataset>` | :ref:`IsCompliantWith <IsCompliantWith>` | 0..n | :ref:`Schema <Schema>` | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsCorrelatedTo | 0..n | Dataset | | | :ref:`Dataset <Dataset>` | :ref:`IsCorrelatedTo <IsCorrelatedTo>` | 0..n | :ref:`Dataset <Dataset>` | |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | A reference to any Dataset resource managed by the Service instance. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | A reference to any Dataset resource managed by the Service instance. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. |
+------------------------+---------------------+--------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------------------+--------------+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Dataset** current version is 1.0.0. The **Dataset** current version is 1.0.0.
@ -249,27 +265,29 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _ConcreteDataset:
ConcreteDataset ConcreteDataset
""""""""""""""" """""""""""""""
ConcreteDataset is any incarnation/manifestation of a dataset or part of it. The relation {@link IsPartOf} is used when a ConcreteDataset is part of a {@link Dataset}. ConcreteDataset is any incarnation/manifestation of a dataset or part of it. The relation :ref:`IsPartOf <IsPartOf>` is used when a ConcreteDataset is part of a :ref:`Dataset <Dataset>`.
.. table:: **ConcreteDataset** ``extends`` **Dataset** .. table:: **ConcreteDataset** ``extends`` **Dataset**
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+===============+==============+==================+==================================================================================================================================================================+ +==========================================+======================================+==============+============================================+==================================================================================================================================================================+
| **Facets** | | **Facets** |
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConcreteDataset | ConsistsOf | 1..n | AccessPointFacet | The access point to use for having access to the concrete dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`AccessPointFacet <AccessPointFacet>` | The access point to use for having access to the concrete dataset. The embargoState can be modeled through the access policy defined in the consistsOf relation. |
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConcreteDataset | HasMaintainer | 1..n | ContactFacet | The contact information of the entity responsible for the maintenance of the concrete dataset | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`HasMaintainer <HasMaintainer>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The contact information of the entity responsible for the maintenance of the concrete dataset |
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ConcreteDataset | IsPartOf | 0..n | Dataset | The reference to the 'incarnations'/'manifestations' contributing to a dataset. | | :ref:`ConcreteDataset <ConcreteDataset>` | :ref:`IsPartOf <IsPartOf>` | 0..n | :ref:`Dataset <Dataset>` | The reference to the 'incarnations'/'manifestations' contributing to a dataset. |
+------------------------+---------------+--------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------+--------------------------------------+--------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **ConcreteDataset** current version is 1.0.0. The **ConcreteDataset** current version is 1.0.0.
@ -279,31 +297,33 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Schema:
Schema Schema
^^^^^^ ^^^^^^
Schema is any reference schema used to specify compliant values. Examples include controlled vocabularies, ontologies, and others. This resource is mainly used by {@link Dataset} to evidence that is compliant with a Schema by using {@link IsCompliantWith} relation. Schema is any reference schema used to specify compliant values. Examples include controlled vocabularies, ontologies, and others. This resource is mainly used by :ref:`Dataset <Dataset>` to evidence that is compliant with a Schema by using :ref:`IsCompliantWith <IsCompliantWith>` relation.
.. table:: **Schema** ``extends`` **GCubeResource** .. table:: **Schema** ``extends`` **GCubeResource**
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+=================+==============+==========================+========================================================================================================================+ +==========================+==========================================+==============+============================================================+========================================================================================================================+
| **Facets** | | **Facets** |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Schema | ConsistsOf | 0..n | DescriptiveMetadataFacet | | | :ref:`Schema <Schema>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`DescriptiveMetadataFacet <DescriptiveMetadataFacet>` | |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Schema | ConsistsOf | 0..n | SubjectFacet | | | :ref:`Schema <Schema>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SubjectFacet <SubjectFacet>` | |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Schema | HasContact | 1..n | ContactFacet | | | :ref:`Schema <Schema>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Schema | IsIdentifiedBy | 1..1 | SchemaFacet | | | :ref:`Schema <Schema>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SchemaFacet <SchemaFacet>` | |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Dataset | IsCompliantWith | 0..n | Schema | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. | | :ref:`Dataset <Dataset>` | :ref:`IsCompliantWith <IsCompliantWith>` | 0..n | :ref:`Schema <Schema>` | Any schema characterising the content of the dataset, e.g. the schema describing the 'columns' of a CSV-based dataset. |
+------------------------+-----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------+ +--------------------------+------------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
The **Schema** current version is 1.0.0. The **Schema** current version is 1.0.0.
@ -313,47 +333,49 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Service:
Service Service
^^^^^^^ ^^^^^^^
Service (Abstract) represents any typology of service worth registering in the infrastructure. Service has relations with quite all other resources. If on one side, an Hybrid Data Infrastructure (HDI) is created to manage datasets, on the other side the HDI born to manage such datasets digitally. We could affirm that datasets and services are the two pillar resources around which revolves the entire infrastructure. It is important to highlight that Service has a general meaning and must not be intended as a network-callable service which is represented instead by one of its specialisation called {@link EService}.Giving that Service is abstract no {@link IsIdentifiedBy} association with a facet is provided which in turns is responsibility of the specialisation. Service (Abstract) represents any typology of service worth registering in the infrastructure. Service has relations with quite all other resources. If on one side, an Hybrid Data Infrastructure (HDI) is created to manage datasets, on the other side the HDI born to manage such datasets digitally. We could affirm that datasets and services are the two pillar resources around which revolves the entire infrastructure. It is important to highlight that Service has a general meaning and must not be intended as a network-callable service which is represented instead by one of its specialisation called :ref:`EService <EService>`.Giving that Service is abstract no :ref:`IsIdentifiedBy <IsIdentifiedBy>` association with a facet is provided which in turns is responsibility of the specialisation.
.. table:: **Service** ``extends`` **GCubeResource** .. table:: **Service** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+==========================+==================================================================================================================================================================================================================================================================+ +============================+========================================+==============+============================================================+==================================================================================================================================================================================================================================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | ConsistsOf | 0..n | CapabilityFacet | Any facility supported/offered by the Service. | | :ref:`Service <Service>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`CapabilityFacet <CapabilityFacet>` | Any facility supported/offered by the Service. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the service, e.g. for discovery purposes. | | :ref:`Service <Service>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`DescriptiveMetadataFacet <DescriptiveMetadataFacet>` | Any descriptive information associated with the service, e.g. for discovery purposes. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | ConsistsOf | 0..n | SubjectFacet | Any subject/tag associated with the service for descriptive, cataloguing and discovery purposes. | | :ref:`Service <Service>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SubjectFacet <SubjectFacet>` | Any subject/tag associated with the service for descriptive, cataloguing and discovery purposes. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Activates | 0..n | Service | The source Service enables the target Service to be running. Examples are an Hosting Node which enables an EService; A VirtualMachine enabling an EService or an HostingNode; An EService enabling a RunningPlugin; A VirtualMachine enabling an HostingNode etc | | :ref:`Service <Service>` | :ref:`Activates <Activates>` | 0..n | :ref:`Service <Service>` | The source Service enables the target Service to be running. Examples are an Hosting Node which enables an EService; A VirtualMachine enabling an EService or an HostingNode; An EService enabling a RunningPlugin; A VirtualMachine enabling an HostingNode etc |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | CallsFor | 0..n | Service | A reference to the Services needed by the target instance to work. | | :ref:`Service <Service>` | :ref:`CallsFor <CallsFor>` | 0..n | :ref:`Service <Service>` | A reference to the Services needed by the target instance to work. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Enables | 0..n | Software | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). | | :ref:`Service <Service>` | :ref:`Enables <Enables>` | 0..n | :ref:`Software <Software>` | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | IsCustomizedBy | 0..n | ConfigurationTemplate | A reference to any configuration characterising the Service behaviour. | | :ref:`Service <Service>` | :ref:`IsCustomizedBy <IsCustomizedBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | A reference to any configuration characterising the Service behaviour. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | A reference to any Dataset resource managed by the Service instance. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | A reference to any Dataset resource managed by the Service instance. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Manages | 0..n | Dataset | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. | | :ref:`Service <Service>` | :ref:`Manages <Manages>` | 0..n | :ref:`Dataset <Dataset>` | The link between the service that 'manages' the dataset and the dataset, e.g. the service that hosts the dataset and give access to it. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Requires | 0..n | Service | A reference to any Service needed by a Software to properly operate, e.g. this can be used to capture a sort of run-time requirements between a software component and the Service it needs. | | :ref:`Service <Service>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | A reference to any Service needed by a Software to properly operate, e.g. this can be used to capture a sort of run-time requirements between a software component and the Service it needs. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Site | Hosts | 0..n | Service | | | :ref:`Site <Site>` | :ref:`Hosts <Hosts>` | 0..n | :ref:`Service <Service>` | |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | Requires | 0..n | Service | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. | | :ref:`Software <Software>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. |
+------------------------+----------------+--------------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **Service** current version is 1.0.0. The **Service** current version is 1.0.0.
@ -363,6 +385,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _EService:
EService EService
"""""""" """"""""
@ -371,29 +395,29 @@ EService is any running service that is registered in the infrastructure and mad
.. table:: **EService** ``extends`` **Service** .. table:: **EService** ``extends`` **Service**
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+==================+=============================================================================================================+ +============================+========================================+==============+============================================+=============================================================================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | ConsistsOf | 1..n | AccessPointFacet | Identify the endpoints of the EService. | | :ref:`EService <EService>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`AccessPointFacet <AccessPointFacet>` | Identify the endpoints of the EService. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | ConsistsOf | 1..n | EventFacet | Events characterising the current status and lifecycle of the service, e.g. ActivationTime, DeploymentTime. | | :ref:`EService <EService>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`EventFacet <EventFacet>` | Events characterising the current status and lifecycle of the service, e.g. ActivationTime, DeploymentTime. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | ConsistsOf | 0..n | LicenseFacet | The specific terms of use governing the exploitation of the EService. | | :ref:`EService <EService>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`LicenseFacet <LicenseFacet>` | The specific terms of use governing the exploitation of the EService. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | ConsistsOf | 0..n | SoftwareFacet | Software available in the EService environment that characterizes the specific EService instance. | | :ref:`EService <EService>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SoftwareFacet <SoftwareFacet>` | Software available in the EService environment that characterizes the specific EService instance. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | ConsistsOf | 1..1 | StateFacet | The current status of the EService, e.g. STARTED, ready, down, failed. | | :ref:`EService <EService>` | :ref:`ConsistsOf <ConsistsOf>` | 1..1 | :ref:`StateFacet <StateFacet>` | The current status of the EService, e.g. STARTED, ready, down, failed. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | IsIdentifiedBy | 1..1 | SoftwareFacet | The main software enabling the EService capabilities. | | :ref:`EService <EService>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SoftwareFacet <SoftwareFacet>` | The main software enabling the EService capabilities. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | Discovers | 0..n | EService | A reference to any other EService, the EService instance is discovering through query on IS. | | :ref:`EService <EService>` | :ref:`Discovers <Discovers>` | 0..n | :ref:`EService <EService>` | A reference to any other EService, the EService instance is discovering through query on IS. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| EService | Uses | 0..n | EService | A reference to any other EService, the EService instance is invoking. | | :ref:`EService <EService>` | :ref:`Uses <Uses>` | 0..n | :ref:`EService <EService>` | A reference to any other EService, the EService instance is invoking. |
+------------------------+----------------+--------------+------------------+-------------------------------------------------------------------------------------------------------------+ +----------------------------+----------------------------------------+--------------+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
The **EService** current version is 1.0.0. The **EService** current version is 1.0.0.
@ -403,6 +427,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _RunningPlugin:
RunningPlugin RunningPlugin
""""""""""""" """""""""""""
@ -431,39 +457,41 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _HostingNode:
HostingNode HostingNode
""""""""""" """""""""""
The HostingNode represent a container capable of managing the lifecycle of an electronic service, i.e., being capable to host and operate an {@link EService}. Examples are docker, tomcat. A container is a service which is conceived to enable any services respecting the container rules to be operative. The container does not typically provide any functionality rather than allowing the hosted service to operate. The HostingNode characterisation in terms of facets reflects the one presented for {@link VirtualMachine}. In particular, facets representing memory, CPU and networking interface are used to describe the HostingNode when the {@link VirtualMachine} enabling the HostingNode is not represented. Federated systems can provide virtual machines as resource or containers as resources. In some cases, the description of a container includes (virtual) hardware information. It is important to highlight that HostingNode is not a subclass of {@link VirtualMachine}. The HostingNode represent a container capable of managing the lifecycle of an electronic service, i.e., being capable to host and operate an :ref:`EService <EService>`. Examples are docker, tomcat. A container is a service which is conceived to enable any services respecting the container rules to be operative. The container does not typically provide any functionality rather than allowing the hosted service to operate. The HostingNode characterisation in terms of facets reflects the one presented for :ref:`VirtualMachine <VirtualMachine>`. In particular, facets representing memory, CPU and networking interface are used to describe the HostingNode when the :ref:`VirtualMachine <VirtualMachine>` enabling the HostingNode is not represented. Federated systems can provide virtual machines as resource or containers as resources. In some cases, the description of a container includes (virtual) hardware information. It is important to highlight that HostingNode is not a subclass of :ref:`VirtualMachine <VirtualMachine>`.
.. table:: **HostingNode** ``extends`` **Service** .. table:: **HostingNode** ``extends`` **Service**
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=======================================================+=====================+==============+=====================+==================================================================================================================================================================================+ +=======================================================+==================================================+==============+==================================================+==================================================================================================================================================================================+
| **Facets** | | **Facets** |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | ConsistsOf | 1..n | CPUFacet | The CPU equipping the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`CPUFacet <CPUFacet>` | The CPU equipping the Hosting Node. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | ConsistsOf | 1..n | EventFacet | Every event characterizing the life cycle of the Hosting Node, e.g. the activation time. | | :ref:`HostingNode <HostingNode>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`EventFacet <EventFacet>` | Every event characterizing the life cycle of the Hosting Node, e.g. the activation time. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | ConsistsOf | 0..n | SimplePropertyFacet | Any <key,value> pair property worth associating with the Hosting Node, e.g. Environment Variables | | :ref:`HostingNode <HostingNode>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SimplePropertyFacet <SimplePropertyFacet>` | Any <key,value> pair property worth associating with the Hosting Node, e.g. Environment Variables |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | ConsistsOf | 0..n | SoftwareFacet | Any Software characterising the Hosting Node. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System | | :ref:`HostingNode <HostingNode>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SoftwareFacet <SoftwareFacet>` | Any Software characterising the Hosting Node. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | ConsistsOf | 1..1 | StateFacet | The current state of the Hosting Node, e.g. started, ready, certified, down, failed. | | :ref:`HostingNode <HostingNode>` | :ref:`ConsistsOf <ConsistsOf>` | 1..1 | :ref:`StateFacet <StateFacet>` | The current state of the Hosting Node, e.g. started, ready, certified, down, failed. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | HasPersistentMemory | 1..n | MemoryFacet | The Disk Space Capacity of the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`HasPersistentMemory <HasPersistentMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The Disk Space Capacity of the Hosting Node. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | HasVolatileMemory | 1..n | MemoryFacet | The RAM Capacity of the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`HasVolatileMemory <HasVolatileMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The RAM Capacity of the Hosting Node. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HostingNode | IsIdentifiedBy | 1..1 | NetworkingFacet | The Network ID characterising the Hosting Node. | | :ref:`HostingNode <HostingNode>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`NetworkingFacet <NetworkingFacet>` | The Network ID characterising the Hosting Node. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| No specific Resource relations defined for this type. | | No specific Resource relations defined for this type. |
+-------------------------------------------------------+---------------------+--------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **HostingNode** current version is 1.0.0. The **HostingNode** current version is 1.0.0.
@ -473,6 +501,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _VirtualMachine:
VirtualMachine VirtualMachine
"""""""""""""" """"""""""""""
@ -481,29 +511,29 @@ VirtualMachine (VM) is the typical resource represented in a cloud infrastructur
.. table:: **VirtualMachine** ``extends`` **Service** .. table:: **VirtualMachine** ``extends`` **Service**
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=======================================================+=====================+==============+=================+=====================================================================================================================================================================================+ +=======================================================+==================================================+==============+==========================================+=====================================================================================================================================================================================+
| **Facets** | | **Facets** |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | ConsistsOf | 1..n | CPUFacet | The CPU equipping the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`CPUFacet <CPUFacet>` | The CPU equipping the Virtual Machine. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | ConsistsOf | 1..n | EventFacet | Every event characterizing the life cycle of the Virtual Machine, e.g. the activation time. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`EventFacet <EventFacet>` | Every event characterizing the life cycle of the Virtual Machine, e.g. the activation time. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | ConsistsOf | 0..n | SoftwareFacet | Any Software characterising the Virtual Machine. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`SoftwareFacet <SoftwareFacet>` | Any Software characterising the Virtual Machine. Useful to report the hosted software that are not registered in the Resource Registry as Software Resource, e.g. Operating System |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | ConsistsOf | 1..1 | StateFacet | The current state of the Virtual Machine, e.g. started, ready, down, unreachable. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`ConsistsOf <ConsistsOf>` | 1..1 | :ref:`StateFacet <StateFacet>` | The current state of the Virtual Machine, e.g. started, ready, down, unreachable. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | HasPersistentMemory | 1..n | MemoryFacet | The Disk Space Capacity of the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`HasPersistentMemory <HasPersistentMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The Disk Space Capacity of the Virtual Machine. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | HasVolatileMemory | 1..n | MemoryFacet | The RAM Capacity of the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`HasVolatileMemory <HasVolatileMemory>` | 1..n | :ref:`MemoryFacet <MemoryFacet>` | The RAM Capacity of the Virtual Machine. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualMachine | IsIdentifiedBy | 1..1 | NetworkingFacet | The Network ID characterising the Virtual Machine. | | :ref:`VirtualMachine <VirtualMachine>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`NetworkingFacet <NetworkingFacet>` | The Network ID characterising the Virtual Machine. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| No specific Resource relations defined for this type. | | No specific Resource relations defined for this type. |
+-------------------------------------------------------+---------------------+--------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------+--------------------------------------------------+--------------+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
The **VirtualMachine** current version is 1.0.0. The **VirtualMachine** current version is 1.0.0.
@ -513,25 +543,27 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _VirtualService:
VirtualService VirtualService
"""""""""""""" """"""""""""""
VirtualService is an abstract service (non-physically existing service) worth being represented as an existing Service for management purposes. Examples of usage include cases where classes or set of services have to be managed like an existing unit. This resource is essential from infrastructure management point of view because it allows easily share a pool of services across VREs as a single unit. VirtualService mainly consist of a service definition which uses relations to {@link ConfigurationTemplate}, {@link EService}, {@link Software} (using {@link Demands} relation) to properly support the sharing across VREs. The correct sharing is feasible thanks to the {@link PropagationConstraint} of the model. The IS provides only the support for resource sharing as a bundle. Instead, the actions required to deploy a {@link Software} are a responsibility of the service invoking the sharing operation. This resource emerged thank to the experience maturated with gCube IS V.1 (gCore Based IS) where this resource was represented as a Generic Resource containing the list of the resource’s id forming the bundle which often lead to inconsistency. VirtualService is an abstract service (non-physically existing service) worth being represented as an existing Service for management purposes. Examples of usage include cases where classes or set of services have to be managed like an existing unit. This resource is essential from infrastructure management point of view because it allows easily share a pool of services across VREs as a single unit. VirtualService mainly consist of a service definition which uses relations to :ref:`ConfigurationTemplate <ConfigurationTemplate>`, :ref:`EService <EService>`, :ref:`Software <Software>` (using :ref:`Demands <Demands>` relation) to properly support the sharing across VREs. The correct sharing is feasible thanks to the :ref:`PropagationConstraint <PropagationConstraint>` of the model. The IS provides only the support for resource sharing as a bundle. Instead, the actions required to deploy a :ref:`Software <Software>` are a responsibility of the service invoking the sharing operation. This resource emerged thank to the experience maturated with gCube IS V.1 (gCore Based IS) where this resource was represented as a Generic Resource containing the list of the resource’s id forming the bundle which often lead to inconsistency.
.. table:: **VirtualService** ``extends`` **Service** .. table:: **VirtualService** ``extends`` **Service**
+------------------------+----------------+--------------+---------------+-------------+ +----------------------------------------+----------------------------------------+--------------+--------------------------------------+-------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+===============+=============+ +========================================+========================================+==============+======================================+=============+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+---------------+-------------+ +----------------------------------------+----------------------------------------+--------------+--------------------------------------+-------------+
| VirtualService | IsIdentifiedBy | 1..n | SoftwareFacet | | | :ref:`VirtualService <VirtualService>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..n | :ref:`SoftwareFacet <SoftwareFacet>` | |
+------------------------+----------------+--------------+---------------+-------------+ +----------------------------------------+----------------------------------------+--------------+--------------------------------------+-------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+---------------+-------------+ +----------------------------------------+----------------------------------------+--------------+--------------------------------------+-------------+
| VirtualService | Demands | 0..n | Software | | | :ref:`VirtualService <VirtualService>` | :ref:`Demands <Demands>` | 0..n | :ref:`Software <Software>` | |
+------------------------+----------------+--------------+---------------+-------------+ +----------------------------------------+----------------------------------------+--------------+--------------------------------------+-------------+
The **VirtualService** current version is 1.0.0. The **VirtualService** current version is 1.0.0.
@ -541,6 +573,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Site:
Site Site
^^^^ ^^^^
@ -549,29 +583,29 @@ Site is a resource representing the location (physical or virtual) hosting the r
.. table:: **Site** ``extends`` **GCubeResource** .. table:: **Site** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=================+====================================================+ +========================+========================================+==============+==========================================+====================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | ConsistsOf | 1..n | LocationFacet | | | :ref:`Site <Site>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`LocationFacet <LocationFacet>` | |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | ConsistsOf | 1..n | NetworkingFacet | | | :ref:`Site <Site>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`NetworkingFacet <NetworkingFacet>` | |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | HasContact | 1..n | ContactFacet | The main contact for the Site. | | :ref:`Site <Site>` | :ref:`HasContact <HasContact>` | 1..n | :ref:`ContactFacet <ContactFacet>` | The main contact for the Site. |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | HasMaintainer | 1..n | ContactFacet | Contact information of the maintainer of the Site. | | :ref:`Site <Site>` | :ref:`HasMaintainer <HasMaintainer>` | 1..n | :ref:`ContactFacet <ContactFacet>` | Contact information of the maintainer of the Site. |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | HasManager | 1..n | ContactFacet | Contact information of the Site Manager. | | :ref:`Site <Site>` | :ref:`HasManager <HasManager>` | 1..n | :ref:`ContactFacet <ContactFacet>` | Contact information of the Site Manager. |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | IsIdentifiedBy | 1..1 | IdentifierFacet | The Site Identifier. | | :ref:`Site <Site>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | The Site Identifier. |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | Hosts | 0..n | Service | | | :ref:`Site <Site>` | :ref:`Hosts <Hosts>` | 0..n | :ref:`Service <Service>` | |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | | | :ref:`Site <Site>` | :ref:`IsOwnedBy <IsOwnedBy>` | 0..n | :ref:`Actor <Actor>` | |
+------------------------+----------------+--------------+-----------------+----------------------------------------------------+ +------------------------+----------------------------------------+--------------+------------------------------------------+----------------------------------------------------+
The **Site** current version is 1.0.0. The **Site** current version is 1.0.0.
@ -581,41 +615,43 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Software:
Software Software
^^^^^^^^ ^^^^^^^^
Software is an entity worth being represented for management purposes. The relation {@link DependsOn} indicates dependencies between two Software captured for management purposes. Software is an entity worth being represented for management purposes. The relation :ref:`DependsOn <DependsOn>` indicates dependencies between two Software captured for management purposes.
.. table:: **Software** ``extends`` **GCubeResource** .. table:: **Software** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=======================+====================================================================================================================================================+ +========================================+========================================+==============+======================================================+====================================================================================================================================================+
| **Facets** | | **Facets** |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | ConsistsOf | 0..n | CapabilityFacet | | | :ref:`Software <Software>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`CapabilityFacet <CapabilityFacet>` | |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | ConsistsOf | 1..n | SoftwareFacet | Apart the one connected by the IsIdentifiedBy relation (gCube coordinates) the others identify the software in other way e.g. (Maven coordinates). | | :ref:`Software <Software>` | :ref:`ConsistsOf <ConsistsOf>` | 1..n | :ref:`SoftwareFacet <SoftwareFacet>` | Apart the one connected by the IsIdentifiedBy relation (gCube coordinates) the others identify the software in other way e.g. (Maven coordinates). |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | IsIdentifiedBy | 1..1 | SoftwareFacet | Software coordinates which identify the Software per se. | | :ref:`Software <Software>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`SoftwareFacet <SoftwareFacet>` | Software coordinates which identify the Software per se. |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | A reference to the Software this Plugin is conceived to extend the capabilities. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | A reference to the Software this Plugin is conceived to extend the capabilities. |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | To capture the relation between a Software and its Plugins. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | To capture the relation between a Software and its Plugins. |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Enables | 0..n | Software | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). | | :ref:`Service <Service>` | :ref:`Enables <Enables>` | 0..n | :ref:`Software <Software>` | A reference to any Software the Service is enabling (i.e. the Software is running throught the EService). |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | DependsOn | 0..n | Software | To capture any dependency between two software artifacts. | | :ref:`Software <Software>` | :ref:`DependsOn <DependsOn>` | 0..n | :ref:`Software <Software>` | To capture any dependency between two software artifacts. |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | IsConfiguredBy | 0..n | ConfigurationTemplate | | | :ref:`Software <Software>` | :ref:`IsConfiguredBy <IsConfiguredBy>` | 0..n | :ref:`ConfigurationTemplate <ConfigurationTemplate>` | |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Software | Requires | 0..n | Service | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. | | :ref:`Software <Software>` | :ref:`Requires <Requires>` | 0..n | :ref:`Service <Service>` | To capture any dependency between a software artifact and a Service, e.g. A software requiring a specific database instance. |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| VirtualService | Demands | 0..n | Software | | | :ref:`VirtualService <VirtualService>` | :ref:`Demands <Demands>` | 0..n | :ref:`Software <Software>` | |
+------------------------+----------------+--------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------+----------------------------------------+--------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
The **Software** current version is 1.0.0. The **Software** current version is 1.0.0.
@ -625,6 +661,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Plugin:
Plugin Plugin
"""""" """"""
@ -633,19 +671,19 @@ Collect Plugin information through the list of its facets.
.. table:: **Plugin** ``extends`` **Software** .. table:: **Plugin** ``extends`` **Software**
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description | | Source | Relation | Multiplicity | Target | Description |
+=================================================+============+==============+==========+==================================================================================+ +=================================================+================================+==============+============================+==================================================================================+
| **Facets** | | **Facets** |
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
| No specific facets usage defined for this type. | | No specific facets usage defined for this type. |
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
| **Resource Relations** | | **Resource Relations** |
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | A reference to the Software this Plugin is conceived to extend the capabilities. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | A reference to the Software this Plugin is conceived to extend the capabilities. |
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
| Plugin | IsPluginOf | 0..n | Software | To capture the relation between a Software and its Plugins. | | :ref:`Plugin <Plugin>` | :ref:`IsPluginOf <IsPluginOf>` | 0..n | :ref:`Software <Software>` | To capture the relation between a Software and its Plugins. |
+-------------------------------------------------+------------+--------------+----------+----------------------------------------------------------------------------------+ +-------------------------------------------------+--------------------------------+--------------+----------------------------+----------------------------------------------------------------------------------+
The **Plugin** current version is 1.0.0. The **Plugin** current version is 1.0.0.

94
is-model.rst
View File

@ -1,4 +1,6 @@
.. _Property:
Property Property
======== ========
@ -21,6 +23,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Encrypted:
Encrypted Encrypted
--------- ---------
@ -43,6 +47,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Metadata:
Metadata Metadata
-------- --------
@ -71,6 +77,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _PropagationConstraint:
PropagationConstraint PropagationConstraint
--------------------- ---------------------
@ -98,6 +106,8 @@ Changelog:
* **1.0.0**: First Version; * **1.0.0**: First Version;
.. _Entity:
Entity Entity
====== ======
@ -106,15 +116,15 @@ This is the base type for any Entity
.. table:: **Entity** .. table:: **Entity**
+------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| Properties | | Properties |
+============+==========+====================================================================================================================================================+============================================================================================+ +============+============================+====================================================================================================================================================+============================================================================================+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| id | String | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` ``Regex:^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$`` | This UUID is be used to identify the instance univocally. | | id | String | ``Mandatory:true`` ``ReadOnly:true`` ``NotNull:true`` ``Regex:^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$`` | This UUID is be used to identify the instance univocally. |
+------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| metadata | Metadata | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Metadata associated with the instance that is automatically created/updated by the system. | | metadata | :ref:`Metadata <Metadata>` | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Metadata associated with the instance that is automatically created/updated by the system. |
+------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
The **Entity** current version is 1.0.0. The **Entity** current version is 1.0.0.
@ -124,6 +134,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Resource:
Resource Resource
-------- --------
@ -152,6 +164,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Facet:
Facet Facet
----- -----
@ -182,6 +196,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _Relation:
Relation Relation
======== ========
@ -190,19 +206,19 @@ This is the base type for any Relation
.. table:: **Relation** .. table:: **Relation**
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
| **Definition** | | **Definition** |
+=======================+=======================+==========================================================+=================+========================================+ +============================+======================================================+==========================================================+========================+========================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
| Resource | Relation | 0..n | Entity | This is the base type for any Relation | | :ref:`Resource <Resource>` | :ref:`Relation <Relation>` | 0..n | :ref:`Entity <Entity>` | This is the base type for any Relation |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
| **Properties** | | **Properties** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
| propagationConstraint | PropagationConstraint | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | | propagationConstraint | :ref:`PropagationConstraint <PropagationConstraint>` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | |
+-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+
The **Relation** current version is 1.0.0. The **Relation** current version is 1.0.0.
@ -212,6 +228,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _IsRelatedTo:
IsRelatedTo IsRelatedTo
----------- -----------
@ -220,25 +238,25 @@ This is the base type for any IsRelatedTo relation
.. table:: **IsRelatedTo** ``extends`` **Relation** .. table:: **IsRelatedTo** ``extends`` **Relation**
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+====================================================+ +======================================================+==================================+==================+============================+====================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| Resource | IsRelatedTo | 0..n | Resource | This is the base type for any IsRelatedTo relation | | :ref:`Resource <Resource>` | :ref:`IsRelatedTo <IsRelatedTo>` | 0..n | :ref:`Resource <Resource>` | This is the base type for any IsRelatedTo relation |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+
The **IsRelatedTo** current version is 1.0.0. The **IsRelatedTo** current version is 1.0.0.
@ -248,6 +266,8 @@ Changelog:
* **1.0.0**: First Version. * **1.0.0**: First Version.
.. _ConsistsOf:
ConsistsOf ConsistsOf
---------- ----------
@ -256,25 +276,25 @@ This is the base type for any ConsistsOf relation
.. table:: **ConsistsOf** ``extends`` **Relation** .. table:: **ConsistsOf** ``extends`` **Relation**
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| **Definition** | | **Definition** |
+======================================================+==============+==================+=================+===================================================+ +======================================================+================================+==================+======================+===================================================+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| Resource | ConsistsOf | 0..n | Facet | This is the base type for any ConsistsOf relation | | :ref:`Resource <Resource>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`Facet <Facet>` | This is the base type for any ConsistsOf relation |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| **Properties** | | **Properties** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| This type does not define any additional attributes. | | This type does not define any additional attributes. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
| No specific known usage for this type. | | No specific known usage for this type. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+
The **ConsistsOf** current version is 1.0.0. The **ConsistsOf** current version is 1.0.0.

64
src/main/java/org/gcube/informationsystem/utils/documentation/model/Documentation.java
View File

@ -7,9 +7,13 @@ import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.gcube.informationsystem.base.reference.AccessType; import org.gcube.informationsystem.base.reference.AccessType;
import org.gcube.informationsystem.discovery.knowledge.UsageKnowledge; import org.gcube.informationsystem.discovery.knowledge.UsageKnowledge;
import org.gcube.informationsystem.types.PropertyTypeName;
import org.gcube.informationsystem.types.impl.properties.PropertyDefinitionImpl;
import org.gcube.informationsystem.types.reference.Type; import org.gcube.informationsystem.types.reference.Type;
import org.gcube.informationsystem.types.reference.properties.LinkedEntity; import org.gcube.informationsystem.types.reference.properties.LinkedEntity;
import org.gcube.informationsystem.types.reference.properties.PropertyDefinition; import org.gcube.informationsystem.types.reference.properties.PropertyDefinition;
@ -34,8 +38,15 @@ public abstract class Documentation {
public static final String NO_ADDITIONAL_ATTRIBUTE = "This type does not define any additional attributes."; public static final String NO_ADDITIONAL_ATTRIBUTE = "This type does not define any additional attributes.";
public static final String NO_SPECIFIC_KNOWN_USAGE = "No specific known usage for this type."; public static final String NO_SPECIFIC_KNOWN_USAGE = "No specific known usage for this type.";
public static final String NAMED_LINK_PATTERN = "\\{@link (?<type>[A-Za-z]*)\\}";
public static final Pattern linkPattern;
protected static int defaultOffsetLevel = 0; protected static int defaultOffsetLevel = 0;
static {
linkPattern = Pattern.compile(NAMED_LINK_PATTERN);
}
public static int getDefaultOffsetLevel() { public static int getDefaultOffsetLevel() {
return defaultOffsetLevel; return defaultOffsetLevel;
} }
@ -89,6 +100,35 @@ public abstract class Documentation {
public void setOffsetLevel(int offsetLevel) { public void setOffsetLevel(int offsetLevel) {
this.offsetLevel = offsetLevel; this.offsetLevel = offsetLevel;
} }
public String getReference(String label) {
return getReference(label, label);
}
public String getReference(String label, String referenceId) {
StringBuffer sb = new StringBuffer();
sb.append(":ref:`");
sb.append(label);
sb.append(" <");
sb.append(referenceId);
sb.append(">");
sb.append("`");
return sb.toString();
}
protected String checkDescription(String description) {
StringBuffer stringBuffer = new StringBuffer();
Matcher matcher = linkPattern.matcher(description);
while (matcher.find()) {
// int start = matcher.start();
// int end = matcher.end();
String typeName = matcher.group("type");
matcher.appendReplacement(stringBuffer, getReference(typeName));
}
matcher.appendTail(stringBuffer);
return stringBuffer.toString();
}
protected Row getPropertyFieldsBoldRow() { protected Row getPropertyFieldsBoldRow() {
Row row = new Row(RowType.NORMAL); Row row = new Row(RowType.NORMAL);
Cell name = new Cell(); Cell name = new Cell();
@ -191,11 +231,11 @@ public abstract class Documentation {
protected Row getLinkedEntityrow(LinkedEntity linkedEntity) { protected Row getLinkedEntityrow(LinkedEntity linkedEntity) {
Row row = new Row(RowType.NORMAL); Row row = new Row(RowType.NORMAL);
Cell source = new Cell(); Cell source = new Cell();
source.setText(linkedEntity.getSource()); source.setText(getReference(linkedEntity.getSource()));
row.appendCell(source); row.appendCell(source);
Cell relation = new Cell(); Cell relation = new Cell();
relation.setText(linkedEntity.getRelation()); relation.setText(getReference(linkedEntity.getRelation()));
row.appendCell(relation); row.appendCell(relation);
Cell multiplicity = new Cell(); Cell multiplicity = new Cell();
@ -209,11 +249,11 @@ public abstract class Documentation {
row.appendCell(multiplicity); row.appendCell(multiplicity);
Cell target = new Cell(); Cell target = new Cell();
target.setText(linkedEntity.getTarget()); target.setText(getReference(linkedEntity.getTarget()));
row.appendCell(target); row.appendCell(target);
Cell description = new Cell(); Cell description = new Cell();
description.setText(linkedEntity.getDescription()); description.setText(checkDescription(linkedEntity.getDescription()));
row.appendCell(description); row.appendCell(description);
for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) { for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) {
@ -278,13 +318,21 @@ public abstract class Documentation {
name.setText(propertyDefinition.getName()); name.setText(propertyDefinition.getName());
row.appendCell(name); row.appendCell(name);
Cell type = new Cell(); Cell type = new Cell();
type.setText(propertyDefinition.getPropertyType());
PropertyTypeName propertyTypeName = ((PropertyDefinitionImpl) propertyDefinition).getPropertyTypeName();
String typeName = propertyDefinition.getPropertyType();
if(propertyTypeName.isGenericType() ) {
String generic = propertyTypeName.getGenericClassName();
type.setText(typeName.replace(generic, getReference(generic)));
}else {
type.setText(typeName);
}
row.appendCell(type); row.appendCell(type);
Cell attributes = new Cell(); Cell attributes = new Cell();
attributes.setText(getPropertyAttributes(propertyDefinition)); attributes.setText(getPropertyAttributes(propertyDefinition));
row.appendCell(attributes); row.appendCell(attributes);
Cell description = new Cell(); Cell description = new Cell();
description.setText(propertyDefinition.getDescription()); description.setText(checkDescription(propertyDefinition.getDescription()));
row.appendCell(description); row.appendCell(description);
for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) { for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) {
row.appendCell(description); row.appendCell(description);
@ -383,7 +431,7 @@ public abstract class Documentation {
stringBuffer.append("\n"); stringBuffer.append("\n");
Section section = getSection(); Section section = getSection();
String name = type.getName(); String name = type.getName();
stringBuffer.append(section.generate(name)); stringBuffer.append(section.generate(name, true));
return stringBuffer; return stringBuffer;
} }
@ -434,7 +482,7 @@ public abstract class Documentation {
public StringBuffer generate() { public StringBuffer generate() {
StringBuffer stringBuffer = generateSection(); StringBuffer stringBuffer = generateSection();
stringBuffer.append(type.getDescription()); stringBuffer.append(checkDescription(type.getDescription()));
stringBuffer.append("\n"); stringBuffer.append("\n");
stringBuffer.append(generateTable()); stringBuffer.append(generateTable());
stringBuffer.append(generateChangelog()); stringBuffer.append(generateChangelog());

8
src/main/java/org/gcube/informationsystem/utils/documentation/model/relations/RelationDocumentation.java
View File

@ -33,11 +33,11 @@ public class RelationDocumentation extends Documentation {
protected Row getTypeDefinitionRow(RelationType<? extends EntityType, ? extends EntityType> relationType) { protected Row getTypeDefinitionRow(RelationType<? extends EntityType, ? extends EntityType> relationType) {
Row row = new Row(RowType.NORMAL); Row row = new Row(RowType.NORMAL);
Cell source = new Cell(); Cell source = new Cell();
source.setText(relationType.getSource().getName()); source.setText(getReference(relationType.getSource().getName()));
row.appendCell(source); row.appendCell(source);
Cell relation = new Cell(); Cell relation = new Cell();
relation.setText(relationType.getName()); relation.setText(getReference(relationType.getName()));
row.appendCell(relation); row.appendCell(relation);
Cell multiplicity = new Cell(); Cell multiplicity = new Cell();
@ -45,11 +45,11 @@ public class RelationDocumentation extends Documentation {
row.appendCell(multiplicity); row.appendCell(multiplicity);
Cell target = new Cell(); Cell target = new Cell();
target.setText(relationType.getTarget().getName()); target.setText(getReference(relationType.getTarget().getName()));
row.appendCell(target); row.appendCell(target);
Cell description = new Cell(); Cell description = new Cell();
description.setText(relationType.getDescription()); description.setText(checkDescription(relationType.getDescription()));
row.appendCell(description); row.appendCell(description);
for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) { for(int i=row.getCells().size(); i<requiredNumberOfColumns; i++) {

7
src/main/java/org/gcube/informationsystem/utils/documentation/rst/Section.java
View File

@ -48,8 +48,13 @@ public class Section {
return stringBuffer; return stringBuffer;
} }
public StringBuffer generate(String sectionTitle) { public StringBuffer generate(String sectionTitle, boolean addSectionReference) {
StringBuffer stringBuffer = new StringBuffer(); StringBuffer stringBuffer = new StringBuffer();
if(addSectionReference) {
stringBuffer.append(".. _");
stringBuffer.append(sectionTitle);
stringBuffer.append(":\n\n");
}
int lenght = sectionTitle.length(); int lenght = sectionTitle.length();
if(sectionType.overline) { if(sectionType.overline) {
stringBuffer.append(getSectionSeparation(sectionType.separator, lenght)); stringBuffer.append(getSectionSeparation(sectionType.separator, lenght));