Package org.dbunit.util.search

Interface ISearchCallback

All Known Implementing Classes:
AbstractExcludeNodesSearchCallback, AbstractIncludeNodesSearchCallback, AbstractMetaDataBasedSearchCallback, AbstractNodesFilterSearchCallback, ExportedKeysSearchCallback, ImportedAndExportedKeysSearchCallback, ImportedAndExportedKeysSearchCallbackFilteredByPKs, ImportedKeysSearchCallback, ImportedKeysSearchCallbackFilteredByPKs
public interface ISearchCallback
Callback used by the search algorithms.
This interface is responsible for providing the edges of the graph and it can be notified of some events generated by the search.
Since:
Aug 25, 2005
Version:
$Revision$
Author:
Felipe Leme (dbunit@felipeal.net)

  • Method Summary

    Modifier and Type
    Method
    Description
    SortedSet
    getEdges(Object fromNode)
    Get the edges originating from a node.
    void
    nodeAdded(Object fromNode)
    Notifies the callback that a node has been added to the search result.
    boolean
    searchNode(Object node)
    Decides if a node should be searched or not

  • Method Details

    • getEdges

      SortedSet getEdges(Object fromNode) throws SearchException
      Get the edges originating from a node.
      Parameters:
      fromNode - node from
      Returns:
      all edges originating from this node.
      Throws:
      SearchException - if the edges originating from the node cannot be determined.

    • nodeAdded

      void nodeAdded(Object fromNode) throws SearchException
      Notifies the callback that a node has been added to the search result.
      Parameters:
      fromNode - node that has been added.
      Throws:
      SearchException - if the callback cannot process the added node.

    • searchNode

      boolean searchNode(Object node) throws SearchException
      Decides if a node should be searched or not
      Parameters:
      node - node to be filtered
      Returns:
      true if the node should be searched
      Throws:
      SearchException - if the callback cannot decide whether the node should be searched.