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 [LocationFacet](type: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.1.0")
@Change(version="1.1.0",description="Replaced complex ValueSchema property for \'coverage\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
public interface CoverageFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
    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 LocationFacet, which captures where a resource is located; CoverageFacet describes when a resource is valid and the scope of its applicability, not where it is located. Consider a dataset containing salinity measurements for a specific time period. What is essential for the information system is not the representation of the measured data itself (e.g., the salinity values), but the definition of the period of validity and other non-geographic coverage aspects of the dataset. This information is captured by CoverageFacet.
    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
      String getCoverage()
      The value indicates the temporal validity or other non-geospatial "coverage" aspect of the dataset (see this Facet's own description — geospatial extent is LocationFacet's concern, not this one's).
      static CoverageFacet getDefaultInstance()
      Returns a default instance of CoverageFacet
      void setCoverage​(String coverage)
      Sets the value indicating the 'area' covered by the dataset.

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

      • getCoverage

        @ISProperty(description="The temporal validity or other non-geospatial \"coverage\" aspect of the dataset (geospatial extent is LocationFacet\'s concern, not this one\'s).",
            mandatory=true)
String getCoverage()
        The value indicates the temporal validity or other non-geospatial "coverage" aspect of the dataset (see this Facet's own description — geospatial extent is LocationFacet's concern, not this one's). Deliberately unconstrained: accepts any JSON-compatible value (string, number, object, array, ...) since the concrete shape of "coverage" is not known in advance. The Java API always exposes it as a String; clients needing the original submitted shape should read the instance via the REST API directly.
        Returns:
        the coverage

      • setCoverage

        void setCoverage​(String coverage)
        Sets the value indicating the 'area' covered by the dataset.
        Parameters:
        coverage - the coverage