From 652a3093f195ac20f707245d277ce14dada79141 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Wed, 3 May 2023 10:18:41 +0200 Subject: [PATCH] Added additional information on relationship field description --- docs/gcube-model-facet.rst | 34 +++++++++---------- .../entities/facets/ProvenanceFacet.java | 2 +- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/gcube-model-facet.rst b/docs/gcube-model-facet.rst index 23e1756..f308e32 100644 --- a/docs/gcube-model-facet.rst +++ b/docs/gcube-model-facet.rst @@ -553,23 +553,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. diff --git a/src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/ProvenanceFacet.java b/src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/ProvenanceFacet.java index 76ad884..94d6a3e 100644 --- a/src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/ProvenanceFacet.java +++ b/src/main/java/org/gcube/resourcemanagement/model/reference/entities/facets/ProvenanceFacet.java @@ -36,7 +36,7 @@ public interface ProvenanceFacet extends Facet { wasDerivedFrom, wasGeneratedBy /* .... */ } - @ISProperty(description = "Relationship with the resource indicated by ID.") + @ISProperty(description = "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.") public Relationship getRelationship(); public void setRelationship(Relationship relationship);