01: /*
02: *
03: * The DbUnit Database Testing Framework
04: * Copyright (C)2005, DbUnit.org
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * 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: 493 $
33: * @since Aug 25, 2005
34: */
35: public interface ISearchCallback {
36:
37: /**
38: * Get the edges originating from a node.
39: *
40: * @param node
41: * node from
42: * @return all edges originating from this node.
43: * @throws Exception
44: * exception wrapper
45: */
46: SortedSet getEdges(Object fromNode) throws SearchException;
47:
48: /**
49: * Notifies the callback that a node has been added to the search result.
50: *
51: * @param fromNode
52: * node that has been added.
53: * @throws Exception
54: * exception wrapper
55: */
56: void nodeAdded(Object fromNode) throws SearchException;
57:
58: /**
59: * Decides if a node should be searched or not
60: *
61: * @param node
62: * node to be filtered
63: * @return true if the node should be searched
64: * @throws Exception
65: * exception wrapper
66: */
67: boolean searchNode(Object node) throws SearchException;
68: }
|