Class DefaultVerticalExtent

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Vertical­Extent

    public class DefaultVerticalExtent
    extends ISOMetadata
    implements VerticalExtent
    Vertical domain of dataset. The following properties are mandatory in a well-formed metadata according ISO 19115:
    EX_Vertical­Extent   ├─minimum­Value…… The lowest vertical extent contained in the dataset.   ├─maximum­Value…… The highest vertical extent contained in the dataset.   └─vertical­CRS……… Information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured. The CRS identification includes unit of measure.
    In addition to the standard properties, SIS provides the following methods:
    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.
    • Coordinate Reference System can not be specified by identifier only; they have to be specified in full. See SIS-397.
    Since:
    0.3
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultVerticalExtent

        public DefaultVerticalExtent()
        Constructs an initially empty vertical extent.
      • DefaultVerticalExtent

        public DefaultVerticalExtent​(double minimumValue,
                                     double maximumValue,
                                     VerticalCRS verticalCRS)
        Creates a vertical extent initialized to the specified values.
        Parameters:
        minimum­Value - the lowest vertical extent contained in the dataset, or Double​.Na­N if none.
        maximum­Value - the highest vertical extent contained in the dataset, or Double​.Na­N if none.
        vertical­CRS - the information about the vertical coordinate reference system, or null.
      • DefaultVerticalExtent

        public DefaultVerticalExtent​(VerticalExtent object)
        Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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:
        cast­Or­Copy(Vertical­Extent)
    • Method Detail

      • castOrCopy

        public static DefaultVerticalExtent castOrCopy​(VerticalExtent 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 already an instance of Default­Vertical­Extent, then it is returned unchanged.
        • Otherwise a new Default­Vertical­Extent instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.
      • getMinimumValue

        public Double getMinimumValue()
        Returns the lowest vertical extent contained in the dataset.
        Specified by:
        get­Minimum­Value in interface Vertical­Extent
        Returns:
        the lowest vertical extent, or null.
      • setMinimumValue

        public void setMinimumValue​(Double newValue)
        Sets the lowest vertical extent contained in the dataset.
        Parameters:
        new­Value - the new minimum value.
      • getMaximumValue

        public Double getMaximumValue()
        Returns the highest vertical extent contained in the dataset.
        Specified by:
        get­Maximum­Value in interface Vertical­Extent
        Returns:
        the highest vertical extent, or null.
      • setMaximumValue

        public void setMaximumValue​(Double newValue)
        Sets the highest vertical extent contained in the dataset.
        Parameters:
        new­Value - the new maximum value.
      • getVerticalCRS

        public VerticalCRS getVerticalCRS()
        Provides information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured. The CRS identification includes unit of measure.
        Specified by:
        get­Vertical­CRS in interface Vertical­Extent
        Returns:
        the vertical CRS, or null.
        See Also:
        SIS-397
      • setVerticalCRS

        public void setVerticalCRS​(VerticalCRS newValue)
        Sets the information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.
        Parameters:
        new­Value - the new vertical CRS.