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.Set;
25  
26  import org.apache.commons.collections.set.ListOrderedSet;
27  
28  /**
29   * Interface representing an algorithm that searches a graph.
30   * 
31   * @author Felipe Leme (dbunit@felipeal.net)
32   * @version $Revision$
33   * @since Aug 25, 2005
34   * 
35   */
36  public interface ISearchAlgorithm {
37  
38    /**
39     * Search all nodes that originates from a set of nodes.
40     * 
41     * @param nodesFrom input nodes
42     * @param callback helper callback
43     * @return all nodes, in the right dependent order (like a LinkedHashSet)
44     * @throws Exception exception wrapper
45     */
46      ListOrderedSet search(Set nodesFrom, ISearchCallback callback) throws SearchException;
47  
48  }