org.geotoolkit.metadata.iso.extent
Class DefaultVerticalExtent

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultVerticalExtent

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, VerticalExtent

@ThreadSafe
public class DefaultVerticalExtent
extends MetadataEntity
implements VerticalExtent

Vertical domain of dataset.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultVerticalExtent()
Constructs an initially empty vertical extent.

DefaultVerticalExtent(Double minimumValue, Double maximumValue, VerticalCRS verticalCRS)
Creates a vertical extent initialized to the specified values.

DefaultVerticalExtent(Envelope envelope)
Constructs a vertical extent from the specified envelope.

DefaultVerticalExtent(VerticalExtent source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultVerticalExtent	castOrCopy(VerticalExtent object) Returns a Geotk metadata implementation with the same values than 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	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 MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, 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(VerticalExtent source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultVerticalExtent

public DefaultVerticalExtent(Envelope envelope)
                      throws TransformException

Constructs a vertical extent from the specified envelope. The envelope can be multi-dimensional, in which case the envelope CRS must have a vertical component.

Note: This constructor is available only if the referencing module is on the classpath.

Parameters:

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

Throws:

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

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

Since:

3.18

See Also:

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

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.

maximumValue - The highest vertical extent contained in the dataset.

verticalCRS - The information about the vertical coordinate reference system.

Since:

2.4

Method Detail

castOrCopy

public static DefaultVerticalExtent castOrCopy(VerticalExtent object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getMinimumValue

public Double getMinimumValue()

Returns the lowest vertical extent contained in the dataset.

Specified by:

getMinimumValue in interface VerticalExtent

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

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

Since:

2.4

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.

Since:

2.4