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="1.0.0") @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. https://wiki.gcube-system.org/gcube/GCube_Model#Provenance_Facet
Author:
Luca Frosini (ISTI - CNR)

  • Field Summary

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

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

    DATETIME_PATTERN, TYPE_PROPERTY

    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

    Modifier and Type
    Method
    Description
    static ProvenanceFacet
    getDefaultInstance()
    Returns a default instance of ProvenanceFacet
    ValueSchema
    getDocument()
    Provenance Document, e.g., an XML according to the reference schema.
    String
    getReference()
    The ID of the referenced resource.
    String
    getRelationship()
    Relationship with the resource indicated by ID.
    void
    setDocument(ValueSchema document)
    Sets the Provenance Document, e.g., an XML according to the reference schema.
    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

  • Field Details

  • Method Details

    • getDefaultInstance

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

    • getRelationship

      @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.") 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="Provenance Document, e.g., an XML according to the reference schema.") ValueSchema getDocument()
      Provenance Document, e.g., an XML according to the reference schema.
      Returns:
      the document

    • setDocument

      void setDocument(ValueSchema document)
      Sets the Provenance Document, e.g., an XML according to the reference schema.
      Parameters:
      document - the document