rtree.html

本程序是由JAVA实现的R-树新建、结点增加、删除功能。

contains</H3>
<PRE>
public java.util.Vector <B>contains</B>(<A HREF="../rtree/Rect.html" title="class in rtree">Rect</A>&nbsp;rect)
                          throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                                 java.io.FileNotFoundException</PRE>
<DL>
<DD>Find all index records whose MBR enclose/contain the MBR 'rect'.
     An Vector is returned. The tree is traversed recusively in post order.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>If the file is empty or search rect. is out of scope then the 
     method returns a zero size vector.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getRPostContains(rtree.Node, rtree.Rect)"><!-- --></A><H3>
getRPostContains</H3>
<PRE>
private java.util.Vector <B>getRPostContains</B>(<A HREF="../rtree/Node.html" title="class in rtree">Node</A>&nbsp;node,
                                          <A HREF="../rtree/Rect.html" title="class in rtree">Rect</A>&nbsp;rect)
                                   throws <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A>,
                                          java.io.FileNotFoundException,
                                          <A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A>,
                                          java.io.IOException,
                                          <A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></PRE>
<DL>
<DD>Given any node it traverses a tree in a recursive post order manner
     fetching all the enclosed(inside 'rect') elements in the leaves.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE>
<DD><CODE><A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A></CODE>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE><A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getAllElements()"><!-- --></A><H3>
getAllElements</H3>
<PRE>
public java.util.Vector <B>getAllElements</B>()
                                throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                                       java.io.FileNotFoundException</PRE>
<DL>
<DD>Returns all the elements traversing the tree recursively in <b>postorder</b>
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="trvsRPost(rtree.Node, boolean)"><!-- --></A><H3>
trvsRPost</H3>
<PRE>
private java.util.Vector <B>trvsRPost</B>(<A HREF="../rtree/Node.html" title="class in rtree">Node</A>&nbsp;node,
                                   boolean&nbsp;del)
                            throws <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A>,
                                   java.io.FileNotFoundException,
                                   <A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A>,
                                   java.io.IOException,
                                   <A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></PRE>
<DL>
<DD>Traverses the tree recursively in post order.
     The second parameter is for the delete method. As it goes through the nodes 
     returning the leafelements it also deletes the nodes.
     This feature is not required for any other methods hence set <code>del</code> as 
     <code>false</code> for all other cases.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE>
<DD><CODE><A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A></CODE>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE><A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="printTree()"><!-- --></A><H3>
printTree</H3>
<PRE>
public void <B>printTree</B>()
               throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                      java.io.FileNotFoundException</PRE>
<DL>
<DD>Prints the tree in recursively <b>preorder</b> manner.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getTreeMBR()"><!-- --></A><H3>
getTreeMBR</H3>
<PRE>
public <A HREF="../rtree/Rect.html" title="class in rtree">Rect</A> <B>getTreeMBR</B>()</PRE>
<DL>
<DD>This method will return MBR of the whole tree.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="deleteAllElements()"><!-- --></A><H3>
deleteAllElements</H3>
<PRE>
public void <B>deleteAllElements</B>()
                       throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></PRE>
<DL>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="trvsRPrePrint(rtree.Node)"><!-- --></A><H3>
trvsRPrePrint</H3>
<PRE>
private void <B>trvsRPrePrint</B>(<A HREF="../rtree/Node.html" title="class in rtree">Node</A>&nbsp;node)
                    throws <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A>,
                           java.io.FileNotFoundException,
                           <A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A>,
                           java.io.IOException,
                           <A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></PRE>
<DL>
<DD>Traverses the tree recursively in post order.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE>
<DD><CODE><A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A></CODE>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE><A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="nearestSearch(rtree.Point, long, int)"><!-- --></A><H3>
nearestSearch</H3>
<PRE>
public <A HREF="../rtree/ABL.html" title="class in rtree">ABL</A>[] <B>nearestSearch</B>(<A HREF="../rtree/Point.html" title="class in rtree">Point</A>&nbsp;pt,
                           long&nbsp;range,
                           int&nbsp;n)
                    throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                           <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></PRE>
<DL>
<DD><b>Read Me Well.</b><br>
     The Nearest Neighbour(NN) search from Roussopoulos and Cheung.
     <br>The returned leaf elements are sorted in ascending order of their 
     differences from the query point. <br><b>If the no. of leaf elements found 
     are less then <code>n</code>, then the rest of the values in the returend array
     are null.<br></b>Give the limit(distance) within which you want to search. 
     The limit is in the same unit as the coordinates of the MBRs. <p>There may
     be some objects in the tree which come within the region but are so big 
     that their size makes them extend much beyond the given region.
     Such objects would also be considered.
     If you do not want any limit then give <code>Long.MAX_VALUE</code> in <code>range</code>.
     You can also search for presence of any object at the given point by giving
     <code>range</code> as <code>0</code>.
     Also required are the no. of objects that need to be fetched(N-Nearest objects).
     <br><b>The value of <code>range</code> is actually square of the distance you want. 
     Therefor if you want to search in an area of 10cm, give the <code>range</code> as 100.</b>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pt</CODE> - the query point.<DD><CODE>range</CODE> - the region within which you want to search.<DD><CODE>n</CODE> - the number of objects required.
<DT><B>Returns:</B><DD>the leaf elements found near the point.The length of the returned 
     array would be equal to <code>n</code>.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="INNSearch(rtree.Node, rtree.Point, rtree.ABL[], rtree.RTree.Nearest)"><!-- --></A><H3>
INNSearch</H3>
<PRE>
private <A HREF="../rtree/ABL.html" title="class in rtree">ABL</A>[] <B>INNSearch</B>(<A HREF="../rtree/Node.html" title="class in rtree">Node</A>&nbsp;node,
                        <A HREF="../rtree/Point.html" title="class in rtree">Point</A>&nbsp;pt,
                        <A HREF="../rtree/ABL.html" title="class in rtree">ABL</A>[]&nbsp;nrstElements,
                        <A HREF="../rtree/RTree.Nearest.html" title="class in rtree">RTree.Nearest</A>&nbsp;nrstDist)
                 throws <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A>,
                        java.io.FileNotFoundException,
                        java.io.IOException,
                        <A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A>,
                        <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                        <A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></PRE>
<DL>
<DD>Improved Nearest Neighbour Search - Cheung, theory Roussopoulos
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE><A HREF="../rtree/NodeReadException.html" title="class in rtree">NodeReadException</A></CODE>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE><A HREF="../rtree/NodeWriteException.html" title="class in rtree">NodeWriteException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="insertArray(rtree.ABL[], rtree.ABL, rtree.RTree.Nearest)"><!-- --></A><H3>
insertArray</H3>
<PRE>
protected void <B>insertArray</B>(<A HREF="../rtree/ABL.html" title="class in rtree">ABL</A>[]&nbsp;arr,
                           <A HREF="../rtree/ABL.html" title="class in rtree">ABL</A>&nbsp;elmt,
                           <A HREF="../rtree/RTree.Nearest.html" title="class in rtree">RTree.Nearest</A>&nbsp;nrstDist)
                    throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></PRE>
<DL>
<DD>A utility method for the search algorithm that inserts an element into the
     the correct position and adjusts the array accordingly.
     Assumes that the new 'element' is lesser than the last element of 'arr'.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="nearestSearch(rtree.Point, long)"><!-- --></A><H3>
nearestSearch</H3>
<PRE>
public java.util.Vector <B>nearestSearch</B>(<A HREF="../rtree/Point.html" title="class in rtree">Point</A>&nbsp;pt,
                                      long&nbsp;range)
                               throws <A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A>,
                                      <A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></PRE>
<DL>
<DD>Another version of the <code>nearestSearch</code> method(not overloaded). This 
     method finds all the objects within the given range.<b> To understand 
     this method please refer to the other <code>nearestSearch</code> method.</b>
     <br>When the no. of objects required is less then a few thousands, this 
     method would be many <b>times</b> slower than the above method. 
     If possible use the other method.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>vector of ABL objects within the given range.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../rtree/RTreeException.html" title="class in rtree">RTreeException</A></CODE>
<DD><CODE><A HREF="../rtree/IllegalValueException.html" title="class in rtree">IllegalValueException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="INNSearch(rtree.Node, rtree.Point, java.util.Vec