Class DefaultVerticalExtent
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultVerticalExtent
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- VerticalExtent
Vertical domain of dataset.
 The following properties are mandatory in a well-formed metadata according ISO 19115:
 
 In addition to the standard properties, SIS provides the following methods:
 
EX_VerticalExtent
   ├─minimumValue…… The lowest vertical extent contained in the dataset.
   ├─maximumValue…… The highest vertical extent contained in the dataset.
   └─verticalCRS……… Information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured. The CRS identification includes unit of measure.- 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 XMLinstead.
- Coordinate Reference System cannot be specified by identifier only; they have to be specified in full. See SIS-397.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty vertical extent.DefaultVerticalExtent(double minimumValue, double maximumValue, VerticalCRS verticalCRS) Creates a vertical extent initialized to the specified values.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultVerticalExtentcastOrCopy(VerticalExtent object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the highest vertical extent contained in the dataset.Returns the lowest vertical extent contained in the dataset.Provides information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.voidintersect(VerticalExtent other) Sets this vertical extent to the intersection of this extent with the specified one.voidsetBounds(Envelope envelope) Sets this vertical extent to values inferred from the specified envelope.voidsetMaximumValue(Double newValue) Sets the highest vertical extent contained in the dataset.voidsetMinimumValue(Double newValue) Sets the lowest vertical extent contained in the dataset.voidsetVerticalCRS(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 ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultVerticalExtentpublic DefaultVerticalExtent()Constructs an initially empty vertical extent.
- 
DefaultVerticalExtentCreates a vertical extent initialized to the specified values.- Parameters:
- minimumValue- the lowest vertical extent contained in the dataset, or- Double.NaNif none.
- maximumValue- the highest vertical extent contained in the dataset, or- Double.NaNif none.
- verticalCRS- the information about the vertical coordinate reference system, or- null.
 
- 
DefaultVerticalExtentConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is already an instance of
       DefaultVerticalExtent, then it is returned unchanged.
- Otherwise a new DefaultVerticalExtentinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getMinimumValueReturns the lowest vertical extent contained in the dataset.- Specified by:
- getMinimumValuein interface- VerticalExtent
- Returns:
- the lowest vertical extent, or null.
 
- 
setMinimumValueSets the lowest vertical extent contained in the dataset.- Parameters:
- newValue- the new minimum value.
 
- 
getMaximumValueReturns the highest vertical extent contained in the dataset.- Specified by:
- getMaximumValuein interface- VerticalExtent
- Returns:
- the highest vertical extent, or null.
 
- 
setMaximumValueSets the highest vertical extent contained in the dataset.- Parameters:
- newValue- the new maximum value.
 
- 
getVerticalCRSProvides 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:
- getVerticalCRSin interface- VerticalExtent
- Returns:
- the vertical CRS, or null.
- See Also:
 
- 
setVerticalCRSSets the information about the vertical coordinate reference system to which the maximum and minimum elevation values are measured.- Parameters:
- newValue- the new vertical CRS.
 
- 
setBoundsSets 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 cannot be transformed to a vertical extent.
- See Also:
 
- 
intersectSets 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:
- IllegalArgumentException- if the two extents do not use the same datum, ignoring metadata.
- Since:
- 0.8
- See Also:
 
 
-