org.geotools.geometry.jts
Class ReferencedEnvelope

Object
  extended by Envelope
      extended by ReferencedEnvelope
All Implemented Interfaces:
Serializable, BoundingBox, Envelope

public class ReferencedEnvelope
extends Envelope
implements Envelope, BoundingBox

A JTS envelope associated with a coordinate reference system. In addition, this JTS envelope also implements the GeoAPI envelope interface for interoperability with GeoAPI.

Since:
2.2
Author:
Jody Garnett, Martin Desruisseaux, Simone Giannecchini
See Also:
Envelope2D, GeneralEnvelope, GeographicBoundingBox, Serialized Form
Module:

Field Summary
static ReferencedEnvelope EVERYTHING
          A ReferencedEnvelope containing "everything"
 
Constructor Summary
ReferencedEnvelope()
          Creates a null envelope with a null coordinate reference system.
ReferencedEnvelope(BoundingBox bbox)
          Creates a new envelope from an existing bounding box.
ReferencedEnvelope(CoordinateReferenceSystem crs)
          Creates a null envelope with the specified coordinate reference system.
ReferencedEnvelope(double x1, double x2, double y1, double y2, CoordinateReferenceSystem crs)
          Creates an envelope for a region defined by maximum and minimum values.
ReferencedEnvelope(Envelope envelope)
          Creates a new envelope from an existing OGC envelope.
ReferencedEnvelope(Envelope envelope, CoordinateReferenceSystem crs)
          Creates a new envelope from an existing JTS envelope.
ReferencedEnvelope(Rectangle2D rectangle, CoordinateReferenceSystem crs)
          Creates an envelope for a Java2D rectangle.
ReferencedEnvelope(ReferencedEnvelope envelope)
          Creates a new envelope from an existing envelope.
 
Method Summary
 boolean contains(BoundingBox bbox)
          Returns true if the provided bounds are contained by this bounding box.
 boolean contains(DirectPosition pos)
          Returns true if the provided location is contained by this bounding box.
 CoordinateReferenceSystem crs()
          Deprecated. Use getCoordinateReferenceSystem(), since it is the method inherited from the interface.
 boolean equals(Object object)
          Compares the specified object with this envelope for equality.
 double getCenter(int dimension)
          Deprecated. Use getMedian(int).
 CoordinateReferenceSystem getCoordinateReferenceSystem()
          Returns the coordinate reference system associated with this envelope.
 int getDimension()
          Returns the number of dimensions.
 double getLength(int dimension)
          Deprecated. Use getSpan(int).
 DirectPosition getLowerCorner()
          A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.
 double getMaximum(int dimension)
          Returns the maximal ordinate along the specified dimension.
 double getMedian(int dimension)
          Returns the center ordinate along the specified dimension.
 double getMinimum(int dimension)
          Returns the minimal ordinate along the specified dimension.
 double getSpan(int dimension)
          Returns the envelope length along the specified dimension.
 DirectPosition getUpperCorner()
          A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.
 int hashCode()
          Returns a hash value for this envelope.
 void include(BoundingBox bbox)
          Include the provided bounding box, expanding as necessary.
 void include(double x, double y)
          Include the provided coordinates, expanding as necessary.
 void init(BoundingBox bounds)
          Sets this envelope to the specified bounding box.
 boolean intersects(BoundingBox bbox)
          Check if this bounding box intersects the provided bounds.
 boolean isEmpty()
          Returns true if lengths along all dimension are zero.
 double maxX()
          Deprecated. Use Envelope.getMaxX().
 double maxY()
          Deprecated. Use Envelope.getMaxY().
 double minX()
          Deprecated. Use Envelope.getMinX().
 double minY()
          Deprecated. Use Envelope.getMinY().
static ReferencedEnvelope reference(BoundingBox e)
          Utility method to ensure that an BoundingBox in a ReferencedEnvelope.
static ReferencedEnvelope reference(Envelope e)
          Utility method to ensure that an Envelope if a ReferencedEnvelope.
 void setBounds(BoundingBox bbox)
          Initialize the bounding box with another bounding box.
 BoundingBox toBounds(CoordinateReferenceSystem targetCRS)
          Returns a new bounding box which contains the transformed shape of this bounding box.
 String toString()
          Returns a string representation of this envelope.
 ReferencedEnvelope transform(CoordinateReferenceSystem targetCRS, boolean lenient)
          Transforms the referenced envelope to the specified coordinate reference system.
 ReferencedEnvelope transform(CoordinateReferenceSystem targetCRS, boolean lenient, int numPointsForTransformation)
          Transforms the referenced envelope to the specified coordinate reference system using the specified amount of points.
 
Methods inherited from class Envelope
centre, contains, contains, contains, covers, covers, covers, distance, expandBy, expandBy, expandToInclude, expandToInclude, expandToInclude, getHeight, getMaxX, getMaxY, getMinX, getMinY, getWidth, init, init, init, init, init, intersection, intersects, intersects, intersects, intersects, intersects, isNull, overlaps, overlaps, overlaps, setToNull, translate
 
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface BoundingBox
contains, getHeight, getMaxX, getMaxY, getMinX, getMinY, getWidth
 

Field Detail

EVERYTHING

public static ReferencedEnvelope EVERYTHING
A ReferencedEnvelope containing "everything"

Constructor Detail

ReferencedEnvelope

public ReferencedEnvelope()
Creates a null envelope with a null coordinate reference system.


ReferencedEnvelope

public ReferencedEnvelope(CoordinateReferenceSystem crs)
                   throws MismatchedDimensionException
Creates a null envelope with the specified coordinate reference system.

Parameters:
crs - The coordinate reference system.
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.

ReferencedEnvelope

public ReferencedEnvelope(double x1,
                          double x2,
                          double y1,
                          double y2,
                          CoordinateReferenceSystem crs)
                   throws MismatchedDimensionException
Creates an envelope for a region defined by maximum and minimum values.

Parameters:
x1 - The first x-value.
x2 - The second x-value.
y1 - The first y-value.
y2 - The second y-value.
crs - The coordinate reference system.
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.

ReferencedEnvelope

public ReferencedEnvelope(Rectangle2D rectangle,
                          CoordinateReferenceSystem crs)
                   throws MismatchedDimensionException
Creates an envelope for a Java2D rectangle.

Parameters:
rectangle - The rectangle.
crs - The coordinate reference system.
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.
Since:
2.4

ReferencedEnvelope

public ReferencedEnvelope(ReferencedEnvelope envelope)
                   throws MismatchedDimensionException
Creates a new envelope from an existing envelope.

Parameters:
envelope - The envelope to initialize from
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.
Since:
2.3

ReferencedEnvelope

public ReferencedEnvelope(BoundingBox bbox)
                   throws MismatchedDimensionException
Creates a new envelope from an existing bounding box.

Parameters:
bbox - The bounding box to initialize from.
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.
Since:
2.4

ReferencedEnvelope

public ReferencedEnvelope(Envelope envelope)
                   throws MismatchedDimensionException
Creates a new envelope from an existing OGC envelope.

Parameters:
envelope - The envelope to initialize from.
Throws:
MismatchedDimensionException - if the CRS dimension is not valid.
Since:
2.4

ReferencedEnvelope

public ReferencedEnvelope(Envelope envelope,
                          CoordinateReferenceSystem crs)
                   throws MismatchedDimensionException
Creates a new envelope from an existing JTS envelope.

Parameters:
envelope - The envelope to initialize from.
crs - The coordinate reference system.
Throws:
MismatchedDimensionExceptionif - the CRS dimension is not valid.
MismatchedDimensionException
Method Detail

init

public void init(BoundingBox bounds)
Sets this envelope to the specified bounding box.


getCoordinateReferenceSystem

public CoordinateReferenceSystem getCoordinateReferenceSystem()
Returns the coordinate reference system associated with this envelope.

Specified by:
getCoordinateReferenceSystem in interface Envelope

crs

public CoordinateReferenceSystem crs()
Deprecated. Use getCoordinateReferenceSystem(), since it is the method inherited from the interface.


getDimension

public int getDimension()
Returns the number of dimensions.

Specified by:
getDimension in interface Envelope

getMinimum

public double getMinimum(int dimension)
Returns the minimal ordinate along the specified dimension.

Specified by:
getMinimum in interface Envelope

minX

public double minX()
Deprecated. Use Envelope.getMinX().


minY

public double minY()
Deprecated. Use Envelope.getMinY().


getMaximum

public double getMaximum(int dimension)
Returns the maximal ordinate along the specified dimension.

Specified by:
getMaximum in interface Envelope

maxX

public double maxX()
Deprecated. Use Envelope.getMaxX().


maxY

public double maxY()
Deprecated. Use Envelope.getMaxY().


getCenter

public double getCenter(int dimension)
Deprecated. Use getMedian(int).

Specified by:
getCenter in interface Envelope

getMedian

public double getMedian(int dimension)
Returns the center ordinate along the specified dimension.

Specified by:
getMedian in interface Envelope

getLength

public double getLength(int dimension)
Deprecated. Use getSpan(int).

Specified by:
getLength in interface Envelope

getSpan

public double getSpan(int dimension)
Returns the envelope length along the specified dimension. This length is equals to the maximum ordinate minus the minimal ordinate.

Specified by:
getSpan in interface Envelope

getLowerCorner

public DirectPosition getLowerCorner()
A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.

Specified by:
getLowerCorner in interface Envelope

getUpperCorner

public DirectPosition getUpperCorner()
A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.

Specified by:
getUpperCorner in interface Envelope

isEmpty

public boolean isEmpty()
Returns true if lengths along all dimension are zero.

Specified by:
isEmpty in interface BoundingBox
Since:
2.4

contains

public boolean contains(DirectPosition pos)
Returns true if the provided location is contained by this bounding box.

Specified by:
contains in interface BoundingBox
Since:
2.4

contains

public boolean contains(BoundingBox bbox)
Returns true if the provided bounds are contained by this bounding box.

Specified by:
contains in interface BoundingBox
Since:
2.4

intersects

public boolean intersects(BoundingBox bbox)
Check if this bounding box intersects the provided bounds.

Specified by:
intersects in interface BoundingBox
Since:
2.4

include

public void include(BoundingBox bbox)
Include the provided bounding box, expanding as necessary.

Specified by:
include in interface BoundingBox
Since:
2.4

include

public void include(double x,
                    double y)
Include the provided coordinates, expanding as necessary.

Specified by:
include in interface BoundingBox
Since:
2.4

setBounds

public void setBounds(BoundingBox bbox)
Initialize the bounding box with another bounding box.

Specified by:
setBounds in interface BoundingBox
Since:
2.4

toBounds

public BoundingBox toBounds(CoordinateReferenceSystem targetCRS)
                     throws TransformException
Returns a new bounding box which contains the transformed shape of this bounding box. This is a convenience method that delegate its work to the transform method.

Specified by:
toBounds in interface BoundingBox
Throws:
TransformException
Since:
2.4

transform

public ReferencedEnvelope transform(CoordinateReferenceSystem targetCRS,
                                    boolean lenient)
                             throws TransformException,
                                    FactoryException
Transforms the referenced envelope to the specified coordinate reference system.

This method can handle the case where the envelope contains the North or South pole, or when it cross the ±180� longitude.

Parameters:
targetCRS - The target coordinate reference system.
lenient - true if datum shift should be applied even if there is insuffisient information. Otherwise (if false), an exception is thrown in such case.
Returns:
The transformed envelope.
Throws:
FactoryException - if the math transform can't be determined.
TransformException - if at least one coordinate can't be transformed.
See Also:
CRS.transform(CoordinateOperation, org.opengis.geometry.Envelope)

transform

public ReferencedEnvelope transform(CoordinateReferenceSystem targetCRS,
                                    boolean lenient,
                                    int numPointsForTransformation)
                             throws TransformException,
                                    FactoryException
Transforms the referenced envelope to the specified coordinate reference system using the specified amount of points.

This method can handle the case where the envelope contains the North or South pole, or when it cross the ±180� longitude.

Parameters:
targetCRS - The target coordinate reference system.
lenient - true if datum shift should be applied even if there is insuffisient information. Otherwise (if false), an exception is thrown in such case.
numPointsForTransformation - The number of points to use for sampling the envelope.
Returns:
The transformed envelope.
Throws:
FactoryException - if the math transform can't be determined.
TransformException - if at least one coordinate can't be transformed.
Since:
2.3
See Also:
CRS.transform(CoordinateOperation, org.opengis.geometry.Envelope)

hashCode

public int hashCode()
Returns a hash value for this envelope. This value need not remain consistent between different implementations of the same class.

Overrides:
hashCode in class Envelope

equals

public boolean equals(Object object)
Compares the specified object with this envelope for equality.

Overrides:
equals in class Envelope

toString

public String toString()
Returns a string representation of this envelope. The default implementation is okay for occasional formatting (for example for debugging purpose).

Overrides:
toString in class Envelope

reference

public static ReferencedEnvelope reference(Envelope e)
Utility method to ensure that an Envelope if a ReferencedEnvelope.

This method first checks if e is an instanceof ReferencedEnvelope, if it is, itself is returned. If not new ReferencedEnvelpe(e,null) is returned.

If e is null, null is returned.

Parameters:
e - The envelope. Can be null.
Returns:
A ReferencedEnvelope using the specified envelope, or null if the envelope was null.

reference

public static ReferencedEnvelope reference(BoundingBox e)
Utility method to ensure that an BoundingBox in a ReferencedEnvelope.

This method first checks if e is an instanceof ReferencedEnvelope, if it is, itself is returned. If not new ReferencedEnvelpe(e) is returned.

Parameters:
e - The envelope.
Returns:


Copyright © 1996-2009 Geotools. All Rights Reserved.