org.dbunit.util.search.ISearchAlgorithm Maven / Gradle / Ivy

/*
 *
 * The DbUnit Database Testing Framework
 * Copyright (C)2005, DbUnit.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

package org.dbunit.util.search;

import java.util.Set;

import org.apache.commons.collections.set.ListOrderedSet;

/**
 * Interface representing an algorithm that searches a graph.
 * 
 * @author Felipe Leme ([email protected])
 * @version $Revision$
 * @since Aug 25, 2005
 * 
 */
public interface ISearchAlgorithm {

  /**
   * Search all nodes that originates from a set of nodes.
   * 
   * @param nodesFrom input nodes
   * @param callback helper callback
   * @return all nodes, in the right dependent order (like a LinkedHashSet)
   * @throws Exception exception wrapper
   */
    ListOrderedSet search(Set nodesFrom, ISearchCallback callback) throws SearchException;

}