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 and Description
java.util.SortedSet	getEdges(java.lang.Object fromNode) Get the edges originating from a node.
void	nodeAdded(java.lang.Object fromNode) Notifies the callback that a node has been added to the search result.
boolean	searchNode(java.lang.Object node) Decides if a node should be searched or not

Method Detail

getEdges

java.util.SortedSet getEdges(java.lang.Object fromNode)
                      throws SearchException

Get the edges originating from a node.

Parameters:

fromNode - node from

Returns:

all edges originating from this node.

Throws:

java.lang.Exception - exception wrapper

SearchException

nodeAdded

void nodeAdded(java.lang.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:

java.lang.Exception - exception wrapper

SearchException

searchNode

boolean searchNode(java.lang.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:

java.lang.Exception - exception wrapper

SearchException