Class DefaultCoverageDescription

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.content.ContentInformation, org.opengis.metadata.content.CoverageDescription
Direct Known Subclasses:
DefaultImageDescription, MI_CoverageDescription

public class DefaultCoverageDescription extends AbstractContentInformation implements org.opengis.metadata.content.CoverageDescription
Information about the content of a grid data cell. The following property is mandatory in a well-formed metadata according ISO 19115:
MD_CoverageDescription   └─attributeDescription…… Description of the attribute described by the measurement value.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
Version:
1.0
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:
    • attributeDescription

      private org.opengis.util.RecordType attributeDescription
      Description of the attribute described by the measurement value.
    • processingLevelCode

      private org.opengis.metadata.Identifier processingLevelCode
      Identifier for the level of processing that has been applied to the resource.
    • attributeGroups

      private Collection<DefaultAttributeGroup> attributeGroups
      Information on attribute groups of the resource.
    • rangeElementDescriptions

      private Collection<org.opengis.metadata.content.RangeElementDescription> rangeElementDescriptions
      Provides the description of the specific range elements of a coverage.
  • Constructor Details

    • DefaultCoverageDescription

      public DefaultCoverageDescription()
      Constructs an empty coverage description.
    • DefaultCoverageDescription

      public DefaultCoverageDescription(org.opengis.metadata.content.CoverageDescription object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:
  • Method Details

    • castOrCopy

      public static DefaultCoverageDescription castOrCopy(org.opengis.metadata.content.CoverageDescription object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is an instance of ImageDescription, then this method delegates to the castOrCopy(…) method of the corresponding SIS subclass.
      • Otherwise if the given object is already an instance of DefaultCoverageDescription, then it is returned unchanged.
      • Otherwise a new DefaultCoverageDescription instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
    • getAttributeDescription

      public org.opengis.util.RecordType getAttributeDescription()
      Returns the description of the attribute described by the measurement value.
      Specified by:
      getAttributeDescription in interface org.opengis.metadata.content.CoverageDescription
      Returns:
      description of the attribute.
    • setAttributeDescription

      public void setAttributeDescription(org.opengis.util.RecordType newValue)
      Sets the description of the attribute described by the measurement value.
      Parameters:
      newValue - the new attribute description.
    • getProcessingLevelCode

      @UML(identifier="processingLevelCode", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.metadata.Identifier getProcessingLevelCode()
      Returns an identifier for the level of processing that has been applied to the resource, or null if none. For image descriptions, this is the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.
      Returns:
      identifier for the level of processing that has been applied to the resource, or null if none.
      Since:
      0.5
    • setProcessingLevelCode

      public void setProcessingLevelCode(org.opengis.metadata.Identifier newValue)
      Sets the identifier for the level of processing that has been applied to the resource.
      Parameters:
      newValue - the new identifier for the level of processing.
      Since:
      0.5
    • getAttributeGroups

      @UML(identifier="attributeGroup", obligation=OPTIONAL, specification=ISO_19115) public Collection<DefaultAttributeGroup> getAttributeGroups()
      Returns information on attribute groups of the resource.
      Upcoming API change — generalization
      The element type will be changed to the AttributeGroup interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
      Returns:
      information on attribute groups of the resource.
      Since:
      0.5
    • setAttributeGroups

      public void setAttributeGroups(Collection<? extends DefaultAttributeGroup> newValues)
      Sets information on attribute groups of the resource.
      Upcoming API change — generalization
      The element type will be changed to the AttributeGroup interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
      Parameters:
      newValues - the new information on attribute groups of the resource.
      Since:
      0.5
    • getContentType

      @Deprecated public org.opengis.metadata.content.CoverageContentType getContentType()
      Deprecated.
      As of ISO 19115:2014, moved to DefaultAttributeGroup.getContentTypes().
      Returns the type of information represented by the cell value. This method fetches the value from the attribute groups.
      Specified by:
      getContentType in interface org.opengis.metadata.content.CoverageDescription
      Returns:
      type of information represented by the cell value, or null.
    • setContentType

      @Deprecated public void setContentType(org.opengis.metadata.content.CoverageContentType newValue)
      Deprecated.
      Sets the type of information represented by the cell value. This method stores the value in the first writable attribute groups.
      Parameters:
      newValue - the new content type.
    • getDimensions

      @Deprecated public final Collection<org.opengis.metadata.content.RangeDimension> getDimensions()
      Deprecated.
      As of ISO 19115:2014, moved to DefaultAttributeGroup.getAttributes().
      Returns the information on the dimensions of the cell measurement value. This method fetches the values from the first attribute groups.
      Specified by:
      getDimensions in interface org.opengis.metadata.content.CoverageDescription
      Returns:
      dimensions of the cell measurement value.
    • setDimensions

      @Deprecated public void setDimensions(Collection<? extends org.opengis.metadata.content.RangeDimension> newValues)
      Deprecated.
      As of ISO 19115:2014, moved to DefaultAttributeGroup.setAttributes(Collection).
      Sets the information on the dimensions of the cell measurement value. This method stores the values in the attribute groups.
      Parameters:
      newValues - the new dimensions.
    • getRangeElementDescriptions

      public Collection<org.opengis.metadata.content.RangeElementDescription> getRangeElementDescriptions()
      Provides the description of the specific range elements of a coverage.
      Specified by:
      getRangeElementDescriptions in interface org.opengis.metadata.content.CoverageDescription
      Returns:
      description of the specific range elements of a coverage.
    • setRangeElementDescriptions

      public void setRangeElementDescriptions(Collection<? extends org.opengis.metadata.content.RangeElementDescription> newValues)
      Sets the description of the specific range elements of a coverage.
      Parameters:
      newValues - the new range element description.
    • getAttributeGroup

      private Collection<DefaultAttributeGroup> getAttributeGroup()
      Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute.