Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultExtent
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,Extent
Information about spatial, vertical, and temporal extent.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
This type has four conditional properties:
geographic elements,
temporal elements,
vertical elements and
description.
At least one of the four shall be used.
EX_Extent
├─description…………………… The spatial and temporal extent for the referring object.
├─geographicElement…… Geographic component of the extent of the referring object.
├─temporalElement………… Temporal component of the extent of the referring object.
│ └─extent……………………… The date and time for the content of the dataset.
└─verticalElement………… Vertical component of the extent of the referring object.
├─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.In addition to the standard properties, SIS provides the following methods:
addElements(Envelope)for adding extents inferred from the given envelope.Extents.getGeographicBoundingBox(Extent)for extracting a global geographic bounding box.
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.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty extent.DefaultExtent(CharSequence description, GeographicExtent geographicElements, VerticalExtent verticalElements, TemporalExtent temporalElements) Constructs an extent initialized to the given description or components.DefaultExtent(Extent object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddElements(Envelope envelope) Adds geographic, vertical or temporal extents inferred from the given envelope.static DefaultExtentcastOrCopy(Extent object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the spatial and temporal extent for the referring object.Provides geographic component of the extent of the referring objectProvides temporal component of the extent of the referring object.Provides vertical component of the extent of the referring object.voidSets this extent to the intersection of this extent with the specified one.voidsetDescription(InternationalString newValue) Sets the spatial and temporal extent for the referring object.voidsetGeographicElements(Collection<? extends GeographicExtent> newValues) Sets geographic component of the extent of the referring object.voidsetTemporalElements(Collection<? extends TemporalExtent> newValues) Sets temporal component of the extent of the referring object.voidsetVerticalElements(Collection<? extends VerticalExtent> newValues) Sets vertical component of the extent of the referring object.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultExtent
public DefaultExtent()Constructs an initially empty extent. -
DefaultExtent
public DefaultExtent(CharSequence description, GeographicExtent geographicElements, VerticalExtent verticalElements, TemporalExtent temporalElements) Constructs an extent initialized to the given description or components. Any argument given to this constructor can benull. While a validExtentrequires at least one component to be non-null, this constructor does not perform such verification.- Parameters:
description- a description, ornullif none.geographicElements- a geographic component, ornullif none.verticalElements- a vertical component, ornullif none.temporalElements- a temporal component, ornullif none.
-
DefaultExtent
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultExtent, then it is returned unchanged. - Otherwise a new
DefaultExtentinstance 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, ornullif 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
-
getDescription
Returns the spatial and temporal extent for the referring object.- Specified by:
getDescriptionin interfaceExtent- Returns:
- the spatial and temporal extent, or
nullin none.
-
setDescription
Sets the spatial and temporal extent for the referring object.- Parameters:
newValue- the new description.
-
getGeographicElements
Provides geographic component of the extent of the referring object- Specified by:
getGeographicElementsin interfaceExtent- Returns:
- the geographic extent, or an empty set if none.
-
setGeographicElements
Sets geographic component of the extent of the referring object.- Parameters:
newValues- the new geographic elements.
-
getVerticalElements
Provides vertical component of the extent of the referring object.- Specified by:
getVerticalElementsin interfaceExtent- Returns:
- the vertical extent, or an empty set if none.
-
setVerticalElements
Sets vertical component of the extent of the referring object.- Parameters:
newValues- the new vertical elements.
-
getTemporalElements
Provides temporal component of the extent of the referring object.- Specified by:
getTemporalElementsin interfaceExtent- Returns:
- the temporal extent, or an empty set if none.
-
setTemporalElements
Sets temporal component of the extent of the referring object.- Parameters:
newValues- the new temporal elements.
-
addElements
Adds geographic, vertical or temporal extents inferred from the given envelope. This method inspects the envelope CRS and creates aGeographicBoundingBox,VerticalExtentorTemporalExtentelements as needed.Note: this method is available only if the referencing module is on the module path.
- Parameters:
envelope- the envelope to use for inferring the additional extents.- Throws:
UnsupportedOperationException- if the referencing module is not on the module path.TransformException- if a coordinate transformation was required and failed.- See Also:
-
intersect
Sets this extent to the intersection of this extent with the specified one. This method computes the intersections of all geographic, vertical and temporal elements in this extent with all geographic, vertical and temporal elements in the other extent, ignoring duplicated results.- Parameters:
other- the extent to intersect with this extent.- Throws:
IllegalArgumentException- if two elements to intersect are not compatible (e.g. mismatched bounding box inclusion status or mismatched vertical datum).UnsupportedOperationException- if aTemporalFactoryis required but no implementation has been found on the module path.- Since:
- 0.8
- See Also:
-