diff --git a/docs/index.rst b/docs/index.rst index 028999d..1d39719 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -63,7 +63,8 @@ The Information System Model (henceforth IS Model) is a graph model with Entitie * Each entity and relation: - * has an header automatically generated for the sake of identification and provenance of the specific information; + * 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; @@ -185,13 +186,13 @@ Any property defined by composing basic types, complex types and other complex t +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 Header. It is reachable only by navigating the owner Entity/Relation. | + | 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 Header. They are 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 Header. 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 Header. 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. | +---------------------------+-----------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -217,13 +218,13 @@ Changelog: * **1.0.0**: First Version. -Header +Meatdata ------ This type provides metadata per every IdentifiableElement -.. table:: **Header** ``extends`` **Property** +.. table:: **Metadata** ``extends`` **Property** +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Attributes | Description | @@ -236,11 +237,9 @@ This type provides metadata per every IdentifiableElement +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | lastUpdateTime | Date | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Last Update time. At creation time it assumes the same value of creationTime. It is represented in the format yyyy-MM-dd HH:mm:ss.SSS Z | +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | uuid | 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 Entity or the Relation univocally. | - +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -The **Header** current version is 1.0.0. +The **Metadata** current version is 1.0.0. Changelog: @@ -309,7 +308,7 @@ This is the base type for any Entity +============+==========+========================================================+============================================================================================+ | **Name** | **Type** | **Attributes** | **Description** | +------------+----------+--------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | header | Header | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Metadata associated with the instance that is automatically created/updated by the system. | + | @metadata | Metadata | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | Metadata associated with the instance that is automatically created/updated by the system. | +------------+----------+--------------------------------------------------------+--------------------------------------------------------------------------------------------+