generalenvelope.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

 following rules apply:
 <p>
 <ul>
   <li>If <code>isNull() == true</code>, then <code><A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#isEmpty()">isEmpty()</A> == true</code></li>
   <li>If <code><A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#isEmpty()">isEmpty()</A> == false</code>, then <code>isNull() == false</code></li>
   <li>The converse of the above-cited rules are not always true.</li>
 </ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Since:</B></DT>
  <DD>2.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isEmpty()"><!-- --></A><H3>
isEmpty</H3>
<PRE>
public boolean <B>isEmpty</B>()</PRE>
<DL>
<DD>Determines whether or not this envelope is empty. An envelope is non-empty only if it has
 at least one <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getDimension()">dimension</A>, and the <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getLength(int)">length</A>
 is greater than 0 along all dimensions. Note that an empty envelope is always <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#isNull()">null</A>, but the converse is not always true.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="add(org.opengis.spatialschema.geometry.DirectPosition)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(DirectPosition&nbsp;position)
         throws MismatchedDimensionException</PRE>
<DL>
<DD>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 <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#contains(org.opengis.spatialschema.geometry.DirectPosition)"><CODE>contains(org.opengis.spatialschema.geometry.DirectPosition)</CODE></A> with the added point as an argument will return ,
 except if one of the point's ordinates was <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NaN" title="class or interface in java.lang"><CODE>Double.NaN</CODE></A> (in which case the
 corresponding ordinate have been ignored).
 <p>
 This method assumes that the specified point uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - The point to add.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified point doesn't have
         the expected dimension.</DL>
</DD>
</DL>
<HR>

<A NAME="add(org.opengis.spatialschema.geometry.Envelope)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(Envelope&nbsp;envelope)
         throws MismatchedDimensionException</PRE>
<DL>
<DD>Adds an envelope object to this envelope. The resulting envelope is the union of the
 two  objects.
 <p>
 This method assumes that the specified envelope uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - the  to add to this envelope.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified envelope doesn't
         have the expected dimension.</DL>
</DD>
</DL>
<HR>

<A NAME="contains(org.opengis.spatialschema.geometry.DirectPosition)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(DirectPosition&nbsp;position)
                 throws MismatchedDimensionException</PRE>
<DL>
<DD>Tests if a specified coordinate is inside the boundary of this envelope.
 <p>
 This method assumes that the specified point uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - The point to text.
<DT><B>Returns:</B><DD> if the specified coordinates are inside the boundary
         of this envelope;  otherwise.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified point doesn't have
         the expected dimension.</DL>
</DD>
</DL>
<HR>

<A NAME="contains(org.opengis.spatialschema.geometry.Envelope, boolean)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(Envelope&nbsp;envelope,
                        boolean&nbsp;edgesInclusive)
                 throws MismatchedDimensionException</PRE>
<DL>
<DD>Returns  if this envelope completly encloses the specified envelope.
 If one or more edges from the specified envelope coincide with an edge from this
 envelope, then this method returns  only if 
 is .
 <p>
 This method assumes that the specified envelope uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - The envelope to test for inclusion.<DD><CODE>edgesInclusive</CODE> -  if this envelope edges are inclusive.
<DT><B>Returns:</B><DD> if this envelope completly encloses the specified one.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified envelope doesn't have
         the expected dimension.<DT><B>Since:</B></DT>
  <DD>2.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#intersects(org.opengis.spatialschema.geometry.Envelope, boolean)"><CODE>intersects(Envelope, boolean)</CODE></A>, 
<A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#equals(org.opengis.spatialschema.geometry.Envelope, double)"><CODE>equals(Envelope, double)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="intersects(org.opengis.spatialschema.geometry.Envelope, boolean)"><!-- --></A><H3>
intersects</H3>
<PRE>
public boolean <B>intersects</B>(Envelope&nbsp;envelope,
                          boolean&nbsp;edgesInclusive)
                   throws MismatchedDimensionException</PRE>
<DL>
<DD>Returns  if this envelope intersects the specified envelope.
 If one or more edges from the specified envelope coincide with an edge from this
 envelope, then this method returns  only if 
 is .
 <p>
 This method assumes that the specified envelope uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - The envelope to test for intersection.<DD><CODE>edgesInclusive</CODE> -  if this envelope edges are inclusive.
<DT><B>Returns:</B><DD> if this envelope intersects the specified one.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified envelope doesn't have
         the expected dimension.<DT><B>Since:</B></DT>
  <DD>2.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#contains(org.opengis.spatialschema.geometry.Envelope, boolean)"><CODE>contains(Envelope, boolean)</CODE></A>, 
<A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#equals(org.opengis.spatialschema.geometry.Envelope, double)"><CODE>equals(Envelope, double)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="intersect(org.opengis.spatialschema.geometry.Envelope)"><!-- --></A><H3>
intersect</H3>
<PRE>
public void <B>intersect</B>(Envelope&nbsp;envelope)
               throws MismatchedDimensionException</PRE>
<DL>
<DD>Sets this envelope to the intersection if this envelope with the specified one.
 <p>
 This method assumes that the specified envelope uses the same CRS than this envelope.
 For performance reason, it will no be verified unless J2SE assertions are enabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - the  to intersect to this envelope.
<DT><B>Throws:</B>
<DD><CODE>MismatchedDimensionException</CODE> - if the specified envelope doesn't
         have the expected dimension.</DL>
</DD>
</DL>
<HR>

<A NAME="getSubEnvelope(int, int)"><!-- --></A><H3>
getSubEnvelope</H3>
<PRE>
public <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html" title="class in org.geotools.geometry">GeneralEnvelope</A> <B>getSubEnvelope</B>(int&nbsp;lower,
                                      int&nbsp;upper)
                               throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
<DL>
<DD>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 <code>lower</code> and extending to dimension <code>upper-1</code>.
 Thus the dimension of the subenvelope is <code>upper-lower</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lower</CODE> - The first dimension to copy, inclusive.<DD><CODE>upper</CODE> - The last  dimension to copy, exclusive.
<DT><B>Returns:</B><DD>The subenvelope.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if an index is out of bounds.</DL>
</DD>
</DL>
<HR>

<A NAME="getReducedEnvelope(int, int)"><!-- --></A><H3>
getReducedEnvelope</H3>
<PRE>
public <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html" title="class in org.geotools.geometry">GeneralEnvelope</A> <B>getReducedEnvelope</B>(int&nbsp;lower,
                                          int&nbsp;upper)
                                   throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
<DL>
<DD>Returns a new envelope with the same values than this envelope minus the
 specified range of dimensions.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lower</CODE> - The first dimension to omit, inclusive.<DD><CODE>upper</CODE> - The last  dimension to omit, exclusive.
<DT><B>Returns:</B><DD>The subenvelope.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if an index is out of bounds.</DL>
</DD>
</DL>
<HR>

<A NAME="toRectangle2D()"><!-- --></A><H3>
toRectangle2D</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom">Rectangle2D</A> <B>toRectangle2D</B>()
                          throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>Returns a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom"><CODE>Rectangle2D</CODE></A> with the same bounds as this .
 This is a convenience method for interoperability with Java2D.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this envelope is not two-dimensional.</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
<DL>
<DD>Returns a string representation of this envelope. The default implementation formats the
 <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getLowerCorner()">lower</A> and <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getUpperCorner()">upper</A> corners using a
 shared instance of <A HREF="../../../org/geotools/measure/CoordinateFormat.html" title="class in org.geotools.measure"><CODE>CoordinateFormat</CODE></A>. This is okay for occasional
 formatting (for example for debugging purpose). But if there is a lot of positions to format,
 users will get better performance and more control by using their own instance of
 <A HREF="../../../org/geotools/measure/CoordinateFormat.html" title="class in org.geotools.measure"><CODE>CoordinateFormat</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD>Returns a hash value for this envelope. This value need not remain
 consistent between different implementations of the same class.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;object)</PRE>
<DL>
<DD>Compares the specified object with this envelope for equality.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="equals(org.opengis.spatialschema.geometry.Envelope, double)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(Envelope&nbsp;envelope,
                      double&nbsp;eps)</PRE>
<DL>
<DD>Compares to the specified envelope for equality up to the specified relative tolerance value.
 The tolerance value  is relative to the <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getLength(int)">envelope length</A>
 along each dimension. More specifically, the actual tolerance value for a given dimension
 <var>i</var> is &times; where  is the maximum of
 <A HREF="../../../org/geotools/geometry/GeneralEnvelope.html#getLength(int)">this envelope length</A> and the specified envelope length along
 dimension <var>i</var>.
 <p>
 Relative tolerance value (as opposed to absolute tolerance value) help to workaround the
 fact that tolerance value are CRS dependent. For example the tolerance value need to be
 smaller for geographic CRS than for UTM projections, because the former typically has a
 range of -180 to 180