org.apache.sis.metadata.iso.extent

Class DefaultVerticalExtent

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultVerticalExtent

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, VerticalExtent

public class DefaultVerticalExtent
extends ISOMetadata
implements VerticalExtent

Vertical domain of dataset.

In addition to the standard properties, SIS provides the following methods:

• setBounds(Envelope) for setting the extent from the given envelope.

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:

Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers, LOGGER

Constructor Summary

Constructors

Constructor and Description
DefaultVerticalExtent() Constructs an initially empty vertical extent.
DefaultVerticalExtent(double minimumValue, double maximumValue, VerticalCRS verticalCRS) Creates a vertical extent initialized to the specified values.
DefaultVerticalExtent(VerticalExtent object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultVerticalExtent	castOrCopy(VerticalExtent object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Double	getMaximumValue() Returns the highest vertical extent contained in the dataset.
Double	getMinimumValue() Returns the lowest vertical extent contained in the dataset.
VerticalCRS	getVerticalCRS() Provides information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.
void	setBounds(Envelope envelope) Sets this vertical extent to values inferred from the specified envelope.
void	setMaximumValue(Double newValue) Sets the highest vertical extent contained in the dataset.
void	setMinimumValue(Double newValue) Sets the lowest vertical extent contained in the dataset.
void	setVerticalCRS(VerticalCRS newValue) Sets the information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.

Methods inherited from class ISOMetadata

getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet

Methods inherited from class AbstractMetadata

asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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:

minimumValue - The lowest vertical extent contained in the dataset, or Double.NaN if none.

maximumValue - The highest vertical extent contained in the dataset, or Double.NaN if none.

verticalCRS - 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:

castOrCopy(VerticalExtent)

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 DefaultVerticalExtent, then it is returned unchanged.
• Otherwise a new DefaultVerticalExtent 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:

getMinimumValue in interface VerticalExtent

Returns:

The lowest vertical extent, or null.

setMinimumValue

public void setMinimumValue(Double newValue)

Sets the lowest vertical extent contained in the dataset.

Parameters:

newValue - The new minimum value.

getMaximumValue

public Double getMaximumValue()

Returns the highest vertical extent contained in the dataset.

Specified by:

getMaximumValue in interface VerticalExtent

Returns:

The highest vertical extent, or null.

setMaximumValue

public void setMaximumValue(Double newValue)

Sets the highest vertical extent contained in the dataset.

Parameters:

newValue - 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:

getVerticalCRS in interface VerticalExtent

Returns:

The vertical CRS, or null.

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:

newValue - The new vertical CRS.

setBounds

public void setBounds(Envelope envelope)
               throws TransformException

Sets this vertical extent to values inferred from the specified envelope. The envelope can be multi-dimensional, in which case the envelope CRS must have a vertical component.

Note: this method is available only if the referencing module is on the classpath.

Parameters:

envelope - The envelope to use for setting this vertical extent.

Throws:

UnsupportedOperationException - if the referencing module is not on the classpath.

TransformException - if the envelope can not be transformed to a vertical extent.

See Also:

DefaultExtent.addElements(Envelope), DefaultGeographicBoundingBox.setBounds(Envelope), DefaultTemporalExtent.setBounds(Envelope)