KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jofti > btree > IResultNode


1 /*
2  * Created on 07-Oct-2004
3  *
4  */

5 package com.jofti.btree;
6
7 import java.util.Collection JavaDoc;
8
9 /**
10  *
11  * The node returned from the tree that contains the data from the real node that was a result of the search. It is really
12  * a wrapper object to a snapshot of the real node's entry list and the sibling node links. This node is immutable and changes to the underlying node are not reflected in the result node.
13  * <p>
14  * @author Steve Woodcock<br>
15  * @version 1.5<br>
16  */

17 public interface IResultNode extends INode {
18
19     /**
20      * Returns the leaf node Entry that matches the value, or null if none found.
21      *
22      * @param value - the value to change.
23      * @return - a leaf node entry or Null.
24      */

25     LeafNodeEntry getEntry(Comparable JavaDoc value);
26     
27         
28     /**
29      * Returns the entries (if any) that are smaller than the value in the node.
30      * <p>
31      * @param value -
32      * @return a list of leaf node entries, or an empty list if none found.
33      */

34     Collection JavaDoc getEntriesBefore(Comparable JavaDoc value);
35     
36     
37 }
38
Popular Tags