Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.extent

Class DefaultVerticalExtent

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

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:

• set­Bounds(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.
• Coordinate Reference System cannot be specified by identifier only; they have to be specified in full. See SIS-397.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Vertical­Extent()	Constructs an initially empty vertical extent.
Default­Vertical­Extent(double minimum­Value, double maximum­Value, Vertical­CRS vertical­CRS)	Creates a vertical extent initialized to the specified values.
Default­Vertical­Extent(Vertical­Extent object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Vertical­Extent	cast­Or­Copy(Vertical­Extent object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Double	get­Maximum­Value()	Returns the highest vertical extent contained in the dataset.
Double	get­Minimum­Value()	Returns the lowest vertical extent contained in the dataset.
Vertical­CRS	get­Vertical­CRS()	Provides information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.
void	intersect(Vertical­Extent other)	Sets this vertical extent to the intersection of this extent with the specified one.
void	set­Bounds(Envelope envelope)	Sets this vertical extent to values inferred from the specified envelope.
void	set­Maximum­Value(Double new­Value)	Sets the highest vertical extent contained in the dataset.
void	set­Minimum­Value(Double new­Value)	Sets the lowest vertical extent contained in the dataset.
void	set­Vertical­CRS(Vertical­CRS new­Value)	Sets the information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

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

• cast­Or­Copy(Vertical­Extent)

Method Details

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, 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.

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.

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 module path.

Parameters:

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

Throws:

Unsupported­Operation­Exception - if the referencing module is not on the module path.

Transform­Exception - if the envelope cannot be transformed to a vertical extent.

See Also:

• Default­Extent.add­Elements(Envelope)
• Default­Geographic­Bounding­Box.set­Bounds(Envelope)
• Default­Temporal­Extent.set­Bounds(Envelope)

intersect

public void intersect(VerticalExtent other)
               throws IllegalArgumentException

Sets this vertical extent to the intersection of this extent with the specified one. The vertical datum must be the same (ignoring metadata) for both extents; this method does not perform datum shift. However, this method can perform unit conversions.

If there is no intersection between the two extents, then this method sets both minimum and maximum values to Double.NaN. If either this extent or the specified extent has NaN bounds, then the corresponding bounds of the intersection result will also be NaN.

Parameters:

other - the vertical extent to intersect with this extent.

Throws:

Illegal­Argument­Exception - if the two extents do not use the same datum, ignoring metadata.

Since:

0.8

See Also:

• Extents.intersection(Vertical­Extent, Vertical­Extent)
• General­Envelope.intersect(Envelope)