Class DefaultGeographicBoundingBox
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- GeographicBoundingBox,- GeographicExtent
The following properties are mandatory in a well-formed metadata according ISO 19115:
EX_GeographicBoundingBox
   ├─westBoundLongitude…… The western-most coordinate of the limit of the dataset extent.
   ├─eastBoundLongitude…… The eastern-most coordinate of the limit of the dataset extent.
   ├─southBoundLatitude…… The southern-most coordinate of the limit of the dataset extent.
   └─northBoundLatitude…… The northern-most, coordinate of the limit of the dataset extent.- setBounds(double, double, double, double)for setting the extent from (λ,φ) values.
- setBounds(Envelope)for setting the extent from the given envelope.
- setBounds(GeographicBoundingBox)for setting the extent from another bounding box.
- add(GeographicBoundingBox)for expanding this extent to include another bounding box.
- intersect(GeographicBoundingBox)for the intersection between the two bounding boxes.
Validation and normalization
All constructors and setter methods in this class perform the following argument validation or normalization:- If the south bound latitude is greater than the north bound latitude, then an exception is thrown.
- If any latitude is set to a value outside the [-90 … 90]° range, then that latitude will be clamped.
- If any longitude is set to a value outside the [-180 … 180]° range, then a multiple of 360° will be added or subtracted to that longitude in order to bring it back inside the range.
Relationship with Envelope classes
Theorg.apache.sis.geometry package provides various Envelope classes serving a similar purpose.
 The main difference is that envelopes can be expressed in any Coordinate Reference System (for example using any map projection), may have any number of dimensions, axes may have
 any direction (some maps are south-oriented)
 and may use any units of measurement. By contrast, geographic bounding box are restricted to two-dimensional
 geographic CRS with latitude and longitude in decimal degrees, inside the [-90 … +90]° and [-180 … +180]° range
 respectively, increasing toward north and east respectively, and longitude measured from the international
 reference meridian (Greenwich on Earth). However, GeographicBoundingBox said nothing about the
 geodetic datum. Consequently, this bounding
 box should be used only as a convenient way to give an approximate description of a location.
 Users can assume a precision of about 0.01° for the latitude and longitude values in this class.
 If more precision is desired, an Envelope should be considered instead.
 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:
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 geographic bounding box.DefaultGeographicBoundingBox(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) Creates a geographic bounding box initialized to the specified values.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdds a geographic bounding box to this box.castOrCopy(GeographicBoundingBox object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.booleanequals(Object object, ComparisonMode mode) Compares this geographic bounding box with the specified object for equality.doubleReturns the eastern-most coordinate of the limit of the dataset extent.doubleReturns the northern-most, coordinate of the limit of the dataset extent.doubleReturns the southern-most coordinate of the limit of the dataset extent.doubleReturns the western-most coordinate of the limit of the dataset extent.voidSets this bounding box to the intersection of this box with the specified one.booleanisEmpty()Returnstrueif this metadata is empty.voidsetBounds(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) Sets the bounding box to the specified values.voidsetBounds(Envelope envelope) Sets the bounding box to the specified envelope.voidSets the bounding box to the same values than the specified box.voidsetEastBoundLongitude(double newValue) Sets the eastern-most coordinate of the limit of the dataset extent.voidsetNorthBoundLatitude(double newValue) Sets the northern-most, coordinate of the limit of the dataset extent.voidsetSouthBoundLatitude(double newValue) Sets the southern-most coordinate of the limit of the dataset extent.voidsetWestBoundLongitude(double newValue) Sets the western-most coordinate of the limit of the dataset extent.Methods inherited from class AbstractGeographicExtentcastOrCopy, getInclusion, setInclusionMethods 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, getInterface, hashCode, prune, toStringMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface GeographicExtentgetInclusion
- 
Constructor Details- 
DefaultGeographicBoundingBoxpublic DefaultGeographicBoundingBox()Constructs an initially empty geographic bounding box. All longitude and latitude values are initialized toDouble.NaN.
- 
DefaultGeographicBoundingBoxpublic DefaultGeographicBoundingBox(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) throws IllegalArgumentException Creates a geographic bounding box initialized to the specified values. The inclusion property is set totrue.Caution: Arguments are expected in the same order than they appear in the ISO 19115 specification. This is different than the order commonly found in the Java2D world, which is rather (xmin, ymin, xmax, ymax). - Parameters:
- westBoundLongitude- the minimal λ value.
- eastBoundLongitude- the maximal λ value.
- southBoundLatitude- the minimal φ value.
- northBoundLatitude- the maximal φ value.
- Throws:
- IllegalArgumentException- if (south bound > north bound). Note that NaN values are allowed.
- See Also:
 
- 
DefaultGeographicBoundingBoxConstructs 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
       DefaultGeographicBoundingBox, then it is returned unchanged.
- Otherwise a new DefaultGeographicBoundingBoxinstance 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 
- 
getWestBoundLongitudeReturns the western-most coordinate of the limit of the dataset extent. The value is expressed in longitude in decimal degrees (positive east).Note that the returned value is greater than the east bound longitude if this box is crossing the anti-meridian. - Specified by:
- getWestBoundLongitudein interface- GeographicBoundingBox
- Returns:
- the western-most longitude between -180° and +180° inclusive, or NaN if undefined.
 
- 
setWestBoundLongitudepublic void setWestBoundLongitude(double newValue) Sets the western-most coordinate of the limit of the dataset extent. The value is expressed in longitude in decimal degrees (positive east). Values outside the [-180 … 180]° range are normalized.- Parameters:
- newValue- the western-most longitude between -180° and +180° inclusive, or NaN to undefine.
 
- 
getEastBoundLongitudeReturns the eastern-most coordinate of the limit of the dataset extent. The value is expressed in longitude in decimal degrees (positive east).Note that the returned value is smaller than the west bound longitude if this box is crossing the anti-meridian. - Specified by:
- getEastBoundLongitudein interface- GeographicBoundingBox
- Returns:
- the eastern-most longitude between -180° and +180° inclusive, or NaN if undefined.
 
- 
setEastBoundLongitudepublic void setEastBoundLongitude(double newValue) Sets the eastern-most coordinate of the limit of the dataset extent. The value is expressed in longitude in decimal degrees (positive east). Values outside the [-180 … 180]° range are normalized.- Parameters:
- newValue- the eastern-most longitude between -180° and +180° inclusive, or NaN to undefine.
 
- 
getSouthBoundLatitudeReturns the southern-most coordinate of the limit of the dataset extent. The value is expressed in latitude in decimal degrees (positive north).- Specified by:
- getSouthBoundLatitudein interface- GeographicBoundingBox
- Returns:
- the southern-most latitude between -90° and +90° inclusive, or NaN if undefined.
 
- 
setSouthBoundLatitudepublic void setSouthBoundLatitude(double newValue) Sets the southern-most coordinate of the limit of the dataset extent. The value is expressed in latitude in decimal degrees (positive north). Values outside the [-90 … 90]° range are clamped. If the result is greater than the north bound latitude, then the north bound is set toDouble.NaN.- Parameters:
- newValue- the southern-most latitude between -90° and +90° inclusive, or NaN to undefine.
 
- 
getNorthBoundLatitudeReturns the northern-most, coordinate of the limit of the dataset extent. The value is expressed in latitude in decimal degrees (positive north).- Specified by:
- getNorthBoundLatitudein interface- GeographicBoundingBox
- Returns:
- the northern-most latitude between -90° and +90° inclusive, or NaN if undefined.
 
- 
setNorthBoundLatitudepublic void setNorthBoundLatitude(double newValue) Sets the northern-most, coordinate of the limit of the dataset extent. The value is expressed in latitude in decimal degrees (positive north). Values outside the [-90 … 90]° range are clamped. If the result is smaller than the south bound latitude, then the south bound is set toDouble.NaN.- Parameters:
- newValue- the northern-most latitude between -90° and +90° inclusive, or NaN to undefine.
 
- 
setBoundspublic void setBounds(double westBoundLongitude, double eastBoundLongitude, double southBoundLatitude, double northBoundLatitude) throws IllegalArgumentException Sets the bounding box to the specified values. The inclusion property is left unchanged.Caution: Arguments are expected in the same order than they appear in the ISO 19115 specification. This is different than the order commonly found in the Java2D world, which is rather (xmin, ymin, xmax, ymax). - Parameters:
- westBoundLongitude- the minimal λ value.
- eastBoundLongitude- the maximal λ value.
- southBoundLatitude- the minimal φ value.
- northBoundLatitude- the maximal φ value.
- Throws:
- IllegalArgumentException- if (south bound > north bound). Note that NaN values are allowed.
 
- 
setBoundsSets the bounding box to the specified envelope. If the envelope contains a CRS, then the bounding box may be projected to a geographic CRS. Otherwise, the envelope is assumed already in appropriate CRS.When coordinate transformation is required, the target geographic CRS is not necessarily WGS84. This method preserves the same ellipsoid than in the envelope CRS when possible. This is because geographic bounding box are only approximated and the ISO specification does not mandates a particular CRS, so we avoid transformations that are not strictly necessary. Note: this method is available only if the referencing module is on the classpath. - Parameters:
- envelope- the envelope to use for setting this geographic bounding box.
- Throws:
- UnsupportedOperationException- if the referencing module is not on the classpath.
- TransformException- if the envelope cannot be transformed to a geographic extent.
- See Also:
 
- 
setBoundsSets the bounding box to the same values than the specified box.- Parameters:
- box- the geographic bounding box to use for setting the values of this box.
 
- 
addAdds a geographic bounding box to this box. This method behavior depends on whether the bounding boxes encompass an area covered by the data (inclusion) or an area where data is not present (exclusion):- If the inclusion status is the same for this box and the box to be added, then the resulting bounding box is the union of the two boxes.
- If the inclusion/exclusion status are opposite, then this method attempts to exclude some area of the specified box from this box. The resulting bounding box is smaller if the exclusion can be performed without ambiguity.
 Rational: this class is stricter about NaN values than other classes likeGeneralEnvelope. The reason is that computations onGeographicBoundingBoxinstances are rare (Envelopeinstances are preferred for this purpose). Usually,GeographicBoundingBoxvalues come directly from some metadata structure. Consequently, NaN values inGeographicBoundingBoxmeans "information is unknown" more often than "not yet calculated".- Parameters:
- box- the geographic bounding box to add to this box.
- See Also:
 
- 
intersectSets this bounding box to the intersection of this box with the specified one. The inclusion status must be the same for both boxes.If there is no intersection between the two bounding boxes, then this method sets both longitudes and/or both latitudes to NaN. If either this box or the specified box has NaN bounds, then the corresponding bounds of the intersection result will bet set to NaN. - Parameters:
- box- the geographic bounding box to intersect with this box.
- Throws:
- IllegalArgumentException- if the inclusion status is not the same for both boxes.
- See Also:
 
- 
isEmptypublic boolean isEmpty()Returnstrueif this metadata is empty. This metadata is considered empty if every bound values are NaN. Note that this is different than the Java2D or envelope definition of "emptiness", since we don't test if the area is greater than zero - this method is a metadata test, not a geometric test.- Specified by:
- isEmptyin interface- Emptiable
- Overrides:
- isEmptyin class- AbstractMetadata
- Returns:
- trueif this metadata does not define any bound value.
- See Also:
 
- 
equalsCompares this geographic bounding box with the specified object for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- AbstractMetadata
- Parameters:
- object- the object to compare for equality.
- mode- the strictness level of the comparison.
- Returns:
- trueif the given object is equal to this box.
- See Also:
 
 
-