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

Interface CoverageFacet

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:
CoverageFacetImpl
@TypeMetadata(name="CoverageFacet", description="CoverageFacet captures information about the coverage of a resource, focusing on its temporal validity and other non-geospatial aspects. It should not be confused with {@link LocationFacet}. CoverageFacet describes when a resource is valid and the scope of its applicability, rather than where it is located. What is essential for the information system is not the representation of the measured data itself (e.g. salinity values), but the definition of the period of validity and other non-geographic coverage aspects of the dataset.", version="1.0.0") @Change(version="1.0.0", description="First Version") public interface CoverageFacet extends org.gcube.informationsystem.model.reference.entities.Facet
CoverageFacet captures information on the extent of the resource, i.e., any aspect aiming at capturing an indicator of the amount/area the resource covers be it a geospatial area, a temporal area, or any other "area". Let consider a dataset containing information regarding the salinity of a specific ocean area in a certain amount of time. What is essential in the information system is not representing the data of the salinity. Instead, to specify the temporal period and the ocean area the dataset is valid. This information is captured by the CoverageFacet. https://wiki.gcube-system.org/gcube/GCube_Model#Coverage_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
    ValueSchema
    getCoverage()
    The value indicates the 'area' covered by the dataset according to the schema
    static CoverageFacet
    getDefaultInstance()
    Returns a default instance of CoverageFacet
    void
    setCoverage(ValueSchema coverage)
    Sets the value indicating the 'area' covered by the dataset according to the schema

    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 CoverageFacet getDefaultInstance()
      Returns a default instance of CoverageFacet
      Returns:
      a default instance of CoverageFacet

    • getCoverage

      @ISProperty(description="The value indicates the \'area\' covered by the dataset according to the schema", mandatory=true, nullable=false) ValueSchema getCoverage()
      The value indicates the 'area' covered by the dataset according to the schema
      Returns:
      the coverage

    • setCoverage

      void setCoverage(ValueSchema coverage)
      Sets the value indicating the 'area' covered by the dataset according to the schema
      Parameters:
      coverage - the coverage