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

Regenerated doc

This commit is contained in:
Luca Frosini 2023-05-03 10:35:46 +02:00
parent 96183fbed3
commit 7cbb1754e5
3 changed files with 32 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gcube-model-consistsof.rst
View File

@ -136,8 +136,6 @@ HasContact is a base relation type to capture the diverse points of contact asso
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Dataset | HasContact | 1..n | ContactFacet | The contact information of the entity responsible for the dataset. |
+------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Schema | HasContact | 1..n | ContactFacet | |

36
gcube-model-facet.rst
View File

@ -180,8 +180,6 @@ ContactFacet captures information on a point of contact for the resource, i.e.,
+-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. |
+-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
+-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| ConcreteDataset | HasMaintainer | 1..n | ContactFacet | The contact information of the entity responsible for the maintenance of the concrete dataset |
@ -553,23 +551,23 @@ ProvenanceFacet captures information on provenance/lineage of the entire resourc
.. table:: **ProvenanceFacet** ``extends`` **Facet**
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| Properties |
+=================+==============+======================================================================================================+======================================================================+====================================================+
| **Name** | **Type** | **Attributes** | **Description** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The ID of the referenced resource. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| **Known Usage** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| Properties |
+=================+==============+======================================================================================================+===========================================================================================================================================================================================================================================+====================================================+
| **Name** | **Type** | **Attributes** | **Description** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The ID of the referenced resource. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. Please note that the provenance has not been modelled as IsRelatedTo specialization, because the source resource is not necessarly in the IS or could be deleted from the IS at any time. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| **Known Usage** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
| Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. |
+-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+
The **ProvenanceFacet** current version is 1.0.0.

32
gcube-model-resource.rst
View File

@ -39,23 +39,21 @@ Actor (Abstract) is any entity (human or machine) playing an active role in the
.. table:: **Actor** ``extends`` **GCubeResource**
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=======================+=======================================================================================+
| **Facets** |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Actor | ConsistsOf | 0..n | ContactReferenceFacet | |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| **Resource Relations** |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | |
+------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| Source | Relation | Multiplicity | Target | Description |
+========================+================+==============+=======================+====================================================================================+
| **Facets** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| Actor | ConsistsOf | 0..n | ContactReferenceFacet | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| **Resource Relations** |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| Dataset | Involves | 0..n | Actor | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
| Site | IsOwnedBy | 0..n | Actor | |
+------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+
The **Actor** current version is 1.0.0.