org.geotools.geometry
Class GeneralEnvelope

java.lang.Object
  extended byorg.geotools.geometry.GeneralEnvelope
All Implemented Interfaces:
org.opengis.util.Cloneable, java.lang.Cloneable, org.opengis.spatialschema.geometry.Envelope, java.io.Serializable

public class GeneralEnvelope
extends java.lang.Object
implements org.opengis.spatialschema.geometry.Envelope, org.opengis.util.Cloneable, java.io.Serializable

A minimum bounding box or rectangle. Regardless of dimension, an Envelope can be represented without ambiguity as two direct positions (coordinate points). To encode an Envelope, it is sufficient to encode these two points. This is consistent with all of the data types in this specification, their state is represented by their publicly accessible attributes.

This particular implementation of Envelope is said "General" because it uses coordinates of an arbitrary dimension.

Version:
$Id$
Author:
Martin Desruisseaux
See Also:
Serialized Form

Constructor Summary
GeneralEnvelope(double[] minCP, double[] maxCP)
          Constructs a envelope defined by two positions.
GeneralEnvelope(double min, double max)
          Constructs one-dimensional envelope defined by a range of values.
GeneralEnvelope(org.opengis.spatialschema.geometry.Envelope envelope)
          Constructs a new envelope with the same data than the specified envelope.
GeneralEnvelope(GeneralDirectPosition minCP, GeneralDirectPosition maxCP)
          Constructs a envelope defined by two positions.
GeneralEnvelope(int dimension)
          Constructs an empty envelope of the specified dimension.
GeneralEnvelope(java.awt.geom.Rectangle2D rect)
          Constructs two-dimensional envelope defined by a Rectangle2D.
 
Method Summary
 void add(GeneralDirectPosition position)
          Adds a point to this envelope.
 void add(GeneralEnvelope envelope)
          Adds an envelope object to this envelope.
 java.lang.Object clone()
          Returns a deep copy of this envelope.
 boolean contains(GeneralDirectPosition position)
          Tests if a specified coordinate is inside the boundary of this envelope.
 boolean equals(java.lang.Object object)
          Compares the specified object with this envelope for equality.
 double getCenter(int dimension)
          Returns the center ordinate along the specified dimension.
 org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()
          Returns the coordinate reference system in which the coordinates are given.
 int getDimension()
          Returns the number of dimensions.
 double getLength(int dimension)
          Returns the envelope length along the specified dimension.
 org.opengis.spatialschema.geometry.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 getMinimum(int dimension)
          Returns the minimal ordinate along the specified dimension.
 GeneralEnvelope getReducedEnvelope(int lower, int upper)
          Returns a new envelope with the same values than this envelope minus the specified range of dimensions.
 GeneralEnvelope getSubEnvelope(int lower, int upper)
          Returns a new envelope that encompass only some dimensions of this envelope.
 org.opengis.spatialschema.geometry.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 intersect(GeneralEnvelope envelope)
          Set this envelope to the intersection if this envelope with the specified one.
 boolean isEmpty()
          Determines whether or not this envelope is empty.
 void setCoordinateReferenceSystem(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
          Set the coordinate reference system in which the coordinate are given.
 void setRange(int dimension, double minimum, double maximum)
          Set the envelope's range along the specified dimension.
 java.awt.geom.Rectangle2D toRectangle2D()
          Returns a Rectangle2D with the same bounds as this Envelope.
 java.lang.String toString()
          Returns a string representation of this envelope.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GeneralEnvelope

public GeneralEnvelope(org.opengis.spatialschema.geometry.Envelope envelope)
Constructs a new envelope with the same data than the specified envelope.


GeneralEnvelope

public GeneralEnvelope(int dimension)
Constructs an empty envelope of the specified dimension. All ordinates are initialized to 0.


GeneralEnvelope

public GeneralEnvelope(double min,
                       double max)
Constructs one-dimensional envelope defined by a range of values.

Parameters:
min - The minimal value.
max - The maximal value.

GeneralEnvelope

public GeneralEnvelope(double[] minCP,
                       double[] maxCP)
                throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Constructs a envelope defined by two positions.

Parameters:
minCP - Minimum ordinate values.
maxCP - Maximum ordinate values.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the two positions don't have the same dimension.
java.lang.IllegalArgumentException - if an ordinate value in the minimum point is not less than or equal to the corresponding ordinate value in the maximum point.

GeneralEnvelope

public GeneralEnvelope(GeneralDirectPosition minCP,
                       GeneralDirectPosition maxCP)
                throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Constructs a envelope defined by two positions.

Parameters:
minCP - Point containing minimum ordinate values.
maxCP - Point containing maximum ordinate values.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the two positions don't have the same dimension.
java.lang.IllegalArgumentException - if an ordinate value in the minimum point is not less than or equal to the corresponding ordinate value in the maximum point.

GeneralEnvelope

public GeneralEnvelope(java.awt.geom.Rectangle2D rect)
Constructs two-dimensional envelope defined by a Rectangle2D.

Method Detail

getCoordinateReferenceSystem

public final org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()
Returns the coordinate reference system in which the coordinates are given.

Returns:
The coordinate reference system, or null.

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(org.opengis.referencing.crs.CoordinateReferenceSystem crs)
Set the coordinate reference system in which the coordinate are given. Note: this method do not reproject the envelope.

Parameters:
crs - The new coordinate reference system, or null.

getDimension

public final int getDimension()
Returns the number of dimensions.

Specified by:
getDimension in interface org.opengis.spatialschema.geometry.Envelope

getLowerCorner

public org.opengis.spatialschema.geometry.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 org.opengis.spatialschema.geometry.Envelope
Returns:
The lower corner.

getUpperCorner

public org.opengis.spatialschema.geometry.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 org.opengis.spatialschema.geometry.Envelope
Returns:
The upper corner.

getMinimum

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

Specified by:
getMinimum in interface org.opengis.spatialschema.geometry.Envelope

getMaximum

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

Specified by:
getMaximum in interface org.opengis.spatialschema.geometry.Envelope

getCenter

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

Specified by:
getCenter in interface org.opengis.spatialschema.geometry.Envelope

getLength

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

Specified by:
getLength in interface org.opengis.spatialschema.geometry.Envelope

setRange

public void setRange(int dimension,
                     double minimum,
                     double maximum)
Set the envelope's range along the specified dimension.

Parameters:
dimension - The dimension to set.
minimum - The minimum value along the specified dimension.
maximum - The maximum value along the specified dimension.

add

public void add(GeneralDirectPosition position)
         throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Adds a point to this envelope. The resulting envelope is the smallest envelope that contains both the original envelope and the specified point. After adding a point, a call to contains(org.geotools.geometry.GeneralDirectPosition) with the added point as an argument will return true, except if one of the point's ordinates was Double.NaN (in which case the corresponding ordinate have been ignored).

Parameters:
position - The point to add.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the specified point doesn't have the expected dimension.

add

public void add(GeneralEnvelope envelope)
         throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Adds an envelope object to this envelope. The resulting envelope is the union of the two Envelope objects.

Parameters:
envelope - the Envelope to add to this envelope.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.

contains

public boolean contains(GeneralDirectPosition position)
                 throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Tests if a specified coordinate is inside the boundary of this envelope.

Parameters:
position - The point to text.
Returns:
true if the specified coordinates are inside the boundary of this envelope; false otherwise.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the specified point doesn't have the expected dimension.

intersect

public void intersect(GeneralEnvelope envelope)
               throws org.opengis.spatialschema.geometry.MismatchedDimensionException
Set this envelope to the intersection if this envelope with the specified one.

Parameters:
envelope - the Envelope to intersect to this envelope.
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.

isEmpty

public boolean isEmpty()
Determines whether or not this envelope is empty. An envelope is non-empty only if it has a length greater that 0 along all dimensions.


getSubEnvelope

public GeneralEnvelope getSubEnvelope(int lower,
                                      int upper)
                               throws java.lang.IndexOutOfBoundsException
Returns a new envelope that encompass only some dimensions of this envelope. This method copy this envelope's ordinates into a new envelope, beginning at dimension lower and extending to dimension upper-1. Thus the dimension of the subenvelope is upper-lower.

Parameters:
lower - The first dimension to copy, inclusive.
upper - The last dimension to copy, exclusive.
Returns:
The subenvelope.
Throws:
java.lang.IndexOutOfBoundsException - if an index is out of bounds.

getReducedEnvelope

public GeneralEnvelope getReducedEnvelope(int lower,
                                          int upper)
                                   throws java.lang.IndexOutOfBoundsException
Returns a new envelope with the same values than this envelope minus the specified range of dimensions.

Parameters:
lower - The first dimension to omit, inclusive.
upper - The last dimension to omit, exclusive.
Returns:
The subenvelope.
Throws:
java.lang.IndexOutOfBoundsException - if an index is out of bounds.

toRectangle2D

public java.awt.geom.Rectangle2D toRectangle2D()
                                        throws java.lang.IllegalStateException
Returns a Rectangle2D with the same bounds as this Envelope. This is a convenience method for interoperability with Java2D.

Throws:
java.lang.IllegalStateException - if this envelope is not two-dimensional.

toString

public java.lang.String toString()
Returns a string representation of this envelope. The returned string is implementation dependent. It is usually provided for debugging purposes.


hashCode

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


equals

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


clone

public java.lang.Object clone()
Returns a deep copy of this envelope.

Specified by:
clone in interface org.opengis.util.Cloneable


Copyright © GeoTools. All Rights Reserved.