Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.content

Class DefaultCoverageDescription

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractContentInformation
DefaultCoverageDescription
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Content­Information, Coverage­Description
Direct Known Subclasses:
Default­Image­Description
public class DefaultCoverageDescription extends AbstractContentInformation implements CoverageDescription
Information about the content of a grid data cell. The following property is mandatory in a well-formed metadata according ISO 19115:
MD_Coverage­Description   └─attribute­Description…… 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
See Also:

  • Constructor Details

    • DefaultCoverageDescription

      public DefaultCoverageDescription()
      Constructs an empty coverage description.

    • DefaultCoverageDescription

      public DefaultCoverageDescription(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(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 Image­Description, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass.
      • Otherwise if the given object is already an instance of Default­Coverage­Description, then it is returned unchanged.
      • Otherwise a new Default­Coverage­Description 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 RecordType getAttributeDescription()
      Returns the description of the attribute described by the measurement value.
      Specified by:
      get­Attribute­Description in interface Coverage­Description
      Returns:
      description of the attribute.

    • setAttributeDescription

      public void setAttributeDescription(RecordType newValue)
      Sets the description of the attribute described by the measurement value.
      Parameters:
      new­Value - the new attribute description.

    • getProcessingLevelCode

      @UML(identifier="processingLevelCode", obligation=OPTIONAL, specification=ISO_19115) public 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(Identifier newValue)
      Sets the identifier for the level of processing that has been applied to the resource.
      Parameters:
      new­Value - 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 Attribute­Group 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 Attribute­Group interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
      Parameters:
      new­Values - the new information on attribute groups of the resource.
      Since:
      0.5

    • getContentType

      @Deprecated(since="1.0") public CoverageContentType getContentType()
      Deprecated.
      As of ISO 19115:2014, moved to Default­Attribute­Group​.get­Content­Types().
      Returns the type of information represented by the cell value. This method fetches the value from the attribute groups.
      Specified by:
      get­Content­Type in interface Coverage­Description
      Returns:
      type of information represented by the cell value, or null.

    • setContentType

      @Deprecated(since="1.0") public void setContentType(CoverageContentType newValue)
      Deprecated.
      As of ISO 19115:2014, moved to Default­Attribute­Group​.set­Content­Types(Collection).
      Sets the type of information represented by the cell value. This method stores the value in the first writable attribute groups.
      Parameters:
      new­Value - the new content type.

    • getDimensions

      @Deprecated(since="1.0") public final Collection<RangeDimension> getDimensions()
      Deprecated.
      As of ISO 19115:2014, moved to Default­Attribute­Group​.get­Attributes().
      Returns the information on the dimensions of the cell measurement value. This method fetches the values from the first attribute groups.
      Specified by:
      get­Dimensions in interface Coverage­Description
      Returns:
      dimensions of the cell measurement value.

    • setDimensions

      @Deprecated(since="1.0") public void setDimensions(Collection<? extends RangeDimension> newValues)
      Deprecated.
      As of ISO 19115:2014, moved to Default­Attribute­Group​.set­Attributes(Collection).
      Sets the information on the dimensions of the cell measurement value. This method stores the values in the attribute groups.
      Parameters:
      new­Values - the new dimensions.

    • getRangeElementDescriptions

      public Collection<RangeElementDescription> getRangeElementDescriptions()
      Provides the description of the specific range elements of a coverage.
      Specified by:
      get­Range­Element­Descriptions in interface Coverage­Description
      Returns:
      description of the specific range elements of a coverage.

    • setRangeElementDescriptions

      public void setRangeElementDescriptions(Collection<? extends RangeElementDescription> newValues)
      Sets the description of the specific range elements of a coverage.
      Parameters:
      new­Values - the new range element description.