Package org.gcube.resourcemanagement.model.reference.entities.facets

Interface ProvenanceFacet

  • All Superinterfaces:
    org.gcube.informationsystem.base.reference.Element, org.gcube.informationsystem.model.reference.entities.Entity, org.gcube.informationsystem.base.reference.entities.EntityElement, org.gcube.informationsystem.model.reference.ERElement, org.gcube.informationsystem.model.reference.entities.Facet, org.gcube.informationsystem.base.reference.IdentifiableElement, org.gcube.informationsystem.model.reference.ModelElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable
    All Known Implementing Classes:
    ProvenanceFacetImpl
    @TypeMetadata(name="ProvenanceFacet",
              description="ProvenanceFacet captures information on provenance/lineage of the entire resource. It is mainly used to describe provenance information of a Dataset.",
              version="2.0.0")
@Change(version="2.0.0",description="Replaced complex ValueSchema property for \'document\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
public interface ProvenanceFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
    ProvenanceFacet captures information on provenance/lineage of the entire resource. It is mainly used to describe provenance information of a Dataset.
    Author:
    Luca Frosini (ISTI - CNR)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String NAME
      The name associated with this facet
      static String VERSION
      The version associated with this facet

      • Fields inherited from interface org.gcube.informationsystem.base.reference.Element

        DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

        CONTEXTS_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

        ID_PROPERTY, METADATA_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static ProvenanceFacet getDefaultInstance()
      Returns a default instance of ProvenanceFacet
      String getDocument()
      The provenance document itself.
      String getReference()
      The ID of the referenced resource.
      String getRelationship()
      Relationship with the resource indicated by ID.
      void setDocument​(String document)
      Sets the provenance document itself.
      void setReference​(String reference)
      Sets the ID of the referenced resource.
      void setRelationship​(String relationship)
      Sets the Relationship with the resource indicated by ID.

      • Methods inherited from interface org.gcube.informationsystem.base.reference.Element

        getTypeName

      • Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

        getID, getMetadata, setID, setMetadata

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ERElement

        getContexts

      • Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

        getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

        getExpectedType, getSupertypes

    • Method Detail

      • getDefaultInstance

        static ProvenanceFacet getDefaultInstance()
        Returns a default instance of ProvenanceFacet
        Returns:
        a default instance of ProvenanceFacet

      • getRelationship

        @ISProperty(description="The 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 necessarily in the IS or could be deleted from the IS at any time.")
String getRelationship()
        Relationship with the resource indicated by ID.
        Returns:
        the relationship

      • setRelationship

        void setRelationship​(String relationship)
        Sets the Relationship with the resource indicated by ID.
        Parameters:
        relationship - the relationship

      • getReference

        @ISProperty(description="The ID of the referenced resource.")
String getReference()
        The ID of the referenced resource.
        Returns:
        the reference

      • setReference

        void setReference​(String reference)
        Sets the ID of the referenced resource.
        Parameters:
        reference - the reference

      • getDocument

        @ISProperty(description="The provenance document itself (e.g., PROV-XML, PROV-JSON, or plain text).")
String getDocument()
        The provenance document itself. Deliberately unconstrained: accepts any JSON-compatible value, since the provenance representation in use (e.g., PROV-XML, PROV-JSON, or plain text) is not known in advance. The Java API always exposes it as a String.
        Returns:
        the document

      • setDocument

        void setDocument​(String document)
        Sets the provenance document itself.
        Parameters:
        document - the document