Class DefaultRangeDimension

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.content.RangeDimension
Direct Known Subclasses:
DefaultSampleDimension

@TitleProperty(name="sequenceIdentifier") public class DefaultRangeDimension extends ISOMetadata implements org.opengis.metadata.content.RangeDimension
Information on the range of each dimension of a cell 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:
    • sequenceIdentifier

      private org.opengis.util.MemberName sequenceIdentifier
      Unique name or number that identifies attributes included in the coverage.
    • description

      private org.opengis.util.InternationalString description
      Description of the attribute.
    • names

      private Collection<org.opengis.metadata.Identifier> names
      Identifiers for each attribute included in the resource. These identifiers can be use to provide names for the attribute from a standard set of names.
  • Constructor Details

    • DefaultRangeDimension

      public DefaultRangeDimension()
      Constructs an initially empty range dimension.
    • DefaultRangeDimension

      public DefaultRangeDimension(org.opengis.metadata.content.RangeDimension 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 DefaultRangeDimension castOrCopy(org.opengis.metadata.content.RangeDimension 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 SampleDimension, then this method delegates to the castOrCopy(…) method of the corresponding SIS subclass.
      • Otherwise if the given object is already an instance of DefaultRangeDimension, then it is returned unchanged.
      • Otherwise a new DefaultRangeDimension 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.
    • getSequenceIdentifier

      public org.opengis.util.MemberName getSequenceIdentifier()
      Returns a unique name or number that identifies attributes included in the coverage.
      Specified by:
      getSequenceIdentifier in interface org.opengis.metadata.content.RangeDimension
      Returns:
      unique name or number, or null.
    • setSequenceIdentifier

      public void setSequenceIdentifier(org.opengis.util.MemberName newValue)
      Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.
      Parameters:
      newValue - the new sequence identifier.
    • getDescription

      @UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.InternationalString getDescription()
      Returns the description of the attribute.
      Returns:
      description of the attribute, or null.
      Since:
      0.5
    • setDescription

      public void setDescription(org.opengis.util.InternationalString newValue)
      Sets the description of the attribute.
      Parameters:
      newValue - the new description.
      Since:
      0.5
    • getDescriptor

      @Deprecated public org.opengis.util.InternationalString getDescriptor()
      Deprecated.
      As of ISO 19115:2014, renamed getDescription().
      Returns the description of the range of a cell measurement value. This method fetches the value from the description.
      Specified by:
      getDescriptor in interface org.opengis.metadata.content.RangeDimension
      Returns:
      description of the range of a cell measurement value, or null.
    • setDescriptor

      @Deprecated public void setDescriptor(org.opengis.util.InternationalString newValue)
      Deprecated.
      As of ISO 19115:2014, renamed setDescription(InternationalString).
      Sets the description of the range of a cell measurement value. This method stores the value in the description.
      Parameters:
      newValue - the new descriptor.
    • getNames

      @UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.Identifier> getNames()
      Returns the identifiers for each attribute included in the resource. These identifiers can be use to provide names for the attribute from a standard set of names.
      Returns:
      identifiers for each attribute included in the resource.
      Since:
      0.5
    • setNames

      public void setNames(Collection<? extends org.opengis.metadata.Identifier> newValues)
      Sets the identifiers for each attribute included in the resource.
      Parameters:
      newValues - the new identifiers for each attribute.
      Since:
      0.5
    • getName

      private Collection<org.opengis.metadata.Identifier> getName()
      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.