View Javadoc
1   /*
2    *
3    * The DbUnit Database Testing Framework
4    * Copyright (C)2005, DbUnit.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or (at your option) any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   *
20   */
21  
22  package org.dbunit.util.search;
23  
24  import java.util.SortedSet;
25  
26  /**
27   * Callback used by the search algorithms.<br>
28   * This interface is responsible for providing the edges of the graph and it can
29   * be notified of some events generated by the search.
30   * 
31   * @author Felipe Leme (dbunit@felipeal.net)
32   * @version $Revision$
33   * @since Aug 25, 2005
34   */
35  public interface ISearchCallback {
36  
37      /**
38       * Get the edges originating from a node.
39       * 
40       * @param fromNode node from
41       * @return all edges originating from this node.
42       * @throws Exception
43       *           exception wrapper
44       */
45      SortedSet getEdges(Object fromNode) throws SearchException;
46  
47      /**
48       * Notifies the callback that a node has been added to the search result.
49       * 
50       * @param fromNode
51       *          node that has been added.
52       * @throws Exception
53       *           exception wrapper
54       */
55      void nodeAdded(Object fromNode) throws SearchException;
56  
57      /**
58       * Decides if a node should be searched or not
59       * 
60       * @param node
61       *          node to be filtered
62       * @return true if the node should be searched
63       * @throws Exception
64       *           exception wrapper
65       */
66      boolean searchNode(Object node) throws SearchException;
67  }