From 05787952be767f5a89c806f0b05e7db72b9e5ba3 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Fri, 12 May 2023 15:00:41 +0200 Subject: [PATCH] Improved documentation with cross reference --- docs/index.rst | 340 ++++++++++++------------------------------------- 1 file changed, 79 insertions(+), 261 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 026ac15..3dd5944 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,200 +1,5 @@ -############################# -Information System (IS) Model -############################# - -This Model is part of research conducted in the context of a PhD. This wiki page represents just a partial view of the full rationale of the research. To have a complete overview of the rationale of the model, please refer to the PhD thesis which is publicly available at: - -https://etd.adm.unipi.it/t/etd-05102019-114151/ - -https://openportal.isti.cnr.it/doc?id=people______::470484e51fcb9e307a418c800efc44c8 - -If you need to refer to such work you can cite the PhD Thesis. - -.. code:: - - @phdthesis{frosini2019transactional, - title={Transactional REST Information System for Federated Research Infrastructures enabling Virtual Research Environments}, - author={Frosini, Luca}, - year={2019}, - school={UNIVERSITÀ DI PISA} - } - -An previous paper about this work is: - - - -.. code:: - - @article{frosini2018facet, - title={A Facet-based Open and Extensible Resource Model for Research Data Infrastructures.}, - author={Frosini, Luca and Pagano, Pasquale}, - journal={Grey Journal (TGJ)}, - volume={14}, - number={2}, - year={2018} - } - - - -************ -The IS Model -************ - -.. image:: ./is-model.png - -.. image:: ./is-model-er.png - -The Information System Model (henceforth IS Model) is a graph model with Entities as nodes and Relations as edges. - -* Two typologies of entities are envisaged: - - * Resources, i.e. entities representing a description of "thing" to be managed: - - * Every Resource is described by a number of Facets. - - * Facets, i.e. entities contributing to "build" a description of a Resource. Every facet, once attached to a Resource profile captures a certain aspect / characterization of the resource: - - * Every facet is characterised by a number of properties. - -* Two typologies of relations are envisaged: - - * IsRelatedTo, i.e. a relation linking any two Resources. - * ConsistsOf, i.e. a relation connecting each Resource with one of the Facets characterizing it; - -* Each entity and relation: - - * has an UUID used for identification; - * has a metadata automatically generated for the sake of provenance of the specific information; - * can be specialized - - * A number of specializations are identified below. Such specializations are managed by the gCube Core services, i.e. Core services builds upon these specializations to realize its management tasks; - * Other specializations can be defined by clients, the system make it possible to store these additional typologies of relations and facets and to discover them. - -* Facet and Relation instances can have additional properties which are not defined in the schema (henceforth schema-mixed mode). -* On relations: - - * Any relation has a direction, i.e. a "source" (out bound of the relation) and a "target" (in bound of the relation). Anyway, the relation can be also navigated in the opposite direction; - * It is not permitted to define a Relation having a Facet as "source". In other words: - - * It is not permitted to define a Relation connecting a Facet with another one; - * It is not permitted to define a Relation connecting a Facet with a Resource (as target); - - * A Facet instance can be linked (by ConsistsOf or any specialization of it) from different Resources. - -We derived the term Facet directly from the dictionary definition. -Merriam Webster Dictionary defines facet as “any of the definable aspects that make up a subject -(as of contemplation) or an object (as of consideration)” [#FacetMerriamWebsterDef]_ . - -The Free Dictionary defines a facet as “One of numerous aspects, as of a subject” [#FacetFreeDictionaryDef]_ . - - - -Type Attributes -=============== - -Any Property defined in the schema is characterised by: - -Name: - Property Name - -Type: - The Type of the Property (e.g. String, Integer, ...). It can be a Basic Type or a Derived Type or a Complex Type - -Description: - The description of the Property. default=null. - -Mandatory (M): - Indicate if the Property is mandatory. default=false. - -ReadOnly (RO): - The Property cannot change its value. default=false. - -NotNull (NN): - Whether the property must assume a value diverse from 'null' or not. default=false - -Max (Max): - default=null - -Min (Min): - default=null - -Regex (Reg)): - A Regular Expression to validate the property value, default=null. A good online tool for regex is avalable at https://regex101.com/ - - -Basic Types ------------ - -.. table:: Basic Types - - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Type | Java type | Description | - +==========+===========================================================================================+===========================================================+ - | Boolean | java.lang.Boolean or boolean | Handles only the values True or False. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Integer | java.lang.Integer or int or java.math.BigInteger | 32-bit signed Integers. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Short | java.lang.Short or short | Small 16-bit signed integers. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Long | java.lang.Long or long | Big 64-bit signed integers. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Float | java.lang.Float or float | Decimal numbers. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Double | java.lang.Double or double | Decimal numbers with high precision. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Date | java.util.Date | Any date with the precision up to milliseconds. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | String | java.lang.String | Any string as alphanumeric sequence of chars. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Byte | java.lang.Byte or byte | Single byte. useful to store small 8-bit signed integers. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Binary | java.lang.Byte[] or byte[] | Can contain any value as byte array. | - +----------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - - - -Derived Types -------------- - -The following are obtained using a String as real type and adding a validation regex. - -.. table:: Derived Types - - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | Java type | Description | - +==============+=============================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Enum | java.lang.Enum or enum | By default it is represented using the String representation of the Enum. So that the primitive type used will be String. The enumeration is checked by setting Regexpr property. The Regular Expression is auto-generated and it will be something like ^(FIRST-ENUM-STRING_REPRESENTATION SECOND-ENUM-STRING_REPRESENTATION... LAST_ENUM_STRING_REPRESENTATION)$. Otherwise (if indicated using an annotation), it can be represented using the Integer value of the Enum. So that the primitive type used will be Integer. The enumeration is checked using Max and Min properties. | - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | UUID | java.util.UUID | String representation of the UUID. The check is obtained using the regular expression ^([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}$ | - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | URL | java.net.URL | String representation of the URL. No check actually. | - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | URI | java.net.URI | String representation of the URI. No check actually. | - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | TypeVersion | org.gcube.informationsystem.utils.TypeVersion | A type representing and validating a version in the following format X.X.X Major(Integer).Minor(Integer).Revision(Integer) (e.g 1.0.0, 2.3.0, 2.0.1). The check is obtained using the regular expression '''^[1-9][0-9]{0,}\.(0 | - +--------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - - -Complex Types -------------- - -Any property defined by composing basic types, complex types and other complex types. Any complex type can be defined by extending Property type. - -.. table:: Complex Types - - +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | Java type | Description | - +===========================+=================================================================================================================+===================================================================================================================================================================+ - | Property | ? extends org.gcube.informationsystem.model.reference.properties.Property | This is an Object contained inside the owner Entity and has no UUID and Metadata. It is reachable only by navigating the owner Entity/Relation. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Property list | List<? extends org.gcube.informationsystem.model.reference.properties.Property> | List of Objects contained inside the owner Entity and have no UUID and Metadata. They are reachable only by navigating the owner Entity/Relation. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Property set | Set<? org.gcube.informationsystem.model.reference.properties.Property> | Set (no duplicates) of Objects contained inside the owner Entity and have no UUID and Metadata. They are reachable only by navigating the owner Entity/Relation. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Property map | Map<String, ? extends org.gcube.informationsystem.model.reference.properties.Propertyd> | Map of Objects contained inside the owner Entity and have no UUID and Metadata. They are reachable only by navigating the owner Entity/Relation. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. _Property: Property ======== @@ -218,6 +23,8 @@ Changelog: * **1.0.0**: First Version. +.. _Encrypted: + Encrypted --------- @@ -240,6 +47,8 @@ Changelog: * **1.0.0**: First Version. +.. _Metadata: + Metadata -------- @@ -268,6 +77,8 @@ Changelog: * **1.0.0**: First Version. +.. _PropagationConstraint: + PropagationConstraint --------------------- @@ -295,6 +106,8 @@ Changelog: * **1.0.0**: First Version; +.. _Entity: + Entity ====== @@ -303,15 +116,15 @@ This is the base type for any Entity .. table:: **Entity** - +------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Properties | - +============+==========+====================================================================================================================================================+============================================================================================+ - | **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. | - +------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | metadata | Metadata | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Metadata associated with the instance that is automatically created/updated by the system. | - +------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Properties | + +============+============================+====================================================================================================================================================+============================================================================================+ + | **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. | + +------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | metadata | :ref:`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. @@ -321,6 +134,8 @@ Changelog: * **1.0.0**: First Version. +.. _Resource: + Resource -------- @@ -349,6 +164,8 @@ Changelog: * **1.0.0**: First Version. +.. _Facet: + Facet ----- @@ -379,6 +196,8 @@ Changelog: * **1.0.0**: First Version. +.. _Relation: + Relation ======== @@ -387,19 +206,19 @@ This is the base type for any Relation .. table:: **Relation** - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ - | **Definition** | - +=======================+=======================+==========================================================+=================+========================================+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ - | Resource | Relation | 0..n | Entity | This is the base type for any Relation | - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ - | **Properties** | - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ - | **Name** | **Type** | **Attributes** | **Description** | - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ - | propagationConstraint | PropagationConstraint | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | - +-----------------------+-----------------------+----------------------------------------------------------+-----------------+----------------------------------------+ + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ + | **Definition** | + +============================+======================================================+==========================================================+========================+========================================+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ + | :ref:`Resource ` | :ref:`Relation ` | 0..n | :ref:`Entity ` | This is the base type for any Relation | + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ + | **Properties** | + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ + | **Name** | **Type** | **Attributes** | **Description** | + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ + | propagationConstraint | :ref:`PropagationConstraint ` | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | | + +----------------------------+------------------------------------------------------+----------------------------------------------------------+------------------------+----------------------------------------+ The **Relation** current version is 1.0.0. @@ -409,6 +228,8 @@ Changelog: * **1.0.0**: First Version. +.. _IsRelatedTo: + IsRelatedTo ----------- @@ -417,25 +238,25 @@ This is the base type for any IsRelatedTo relation .. table:: **IsRelatedTo** ``extends`` **Relation** - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | **Definition** | - +======================================================+==============+==================+=================+====================================================+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | Resource | IsRelatedTo | 0..n | Resource | This is the base type for any IsRelatedTo relation | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | **Properties** | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | **Name** | **Type** | **Attributes** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | This type does not define any additional attributes. | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | **Known Usage** | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ - | No specific known usage for this type. | - +------------------------------------------------------+--------------+------------------+-----------------+----------------------------------------------------+ + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | **Definition** | + +======================================================+==================================+==================+============================+====================================================+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | :ref:`Resource ` | :ref:`IsRelatedTo ` | 0..n | :ref:`Resource ` | This is the base type for any IsRelatedTo relation | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | **Properties** | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | **Name** | **Type** | **Attributes** | **Description** | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | This type does not define any additional attributes. | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | **Known Usage** | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ + | No specific known usage for this type. | + +------------------------------------------------------+----------------------------------+------------------+----------------------------+----------------------------------------------------+ The **IsRelatedTo** current version is 1.0.0. @@ -445,6 +266,8 @@ Changelog: * **1.0.0**: First Version. +.. _ConsistsOf: + ConsistsOf ---------- @@ -453,25 +276,25 @@ This is the base type for any ConsistsOf relation .. table:: **ConsistsOf** ``extends`` **Relation** - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | **Definition** | - +======================================================+==============+==================+=================+===================================================+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | Resource | ConsistsOf | 0..n | Facet | This is the base type for any ConsistsOf relation | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | **Properties** | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | **Name** | **Type** | **Attributes** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | This type does not define any additional attributes. | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | **Known Usage** | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ - | No specific known usage for this type. | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------+ + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | **Definition** | + +======================================================+================================+==================+======================+===================================================+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | :ref:`Resource ` | :ref:`ConsistsOf ` | 0..n | :ref:`Facet ` | This is the base type for any ConsistsOf relation | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | **Properties** | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | **Name** | **Type** | **Attributes** | **Description** | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | This type does not define any additional attributes. | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | **Known Usage** | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ + | No specific known usage for this type. | + +------------------------------------------------------+--------------------------------+------------------+----------------------+---------------------------------------------------+ The **ConsistsOf** current version is 1.0.0. @@ -480,8 +303,3 @@ Changelog: * **1.0.0**: First Version. - -.. rubric:: Footnotes - -.. [#FacetMerriamWebsterDef] https://www.merriam-webster.com/dictionary/facet -.. [#FacetFreeDictionaryDef] https://www.thefreedictionary.com/facet