ptdb.kernel.bl.search

Interface ResultHandler

All Known Implementing Classes:

AbstractSearcher, AttributeSearcher, CommandSearcher, GraphSearcher, HierarchyFetcher, NameSearcher, PatternMatchGraphSearcher, SearchResultBuffer, XQueryGraphSearcher

public interface ResultHandler

Handles the results from the searched models, according to different implementation of the actual handling function.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Alek Wang

Pt.AcceptedRating:

red (wenjiaow)

Pt.ProposedRating:

red (wenjiaow)

Method Summary

Modifier and Type	Method and Description
void	handleIntermediateResults(java.util.List<XMLDBModel> intermediateResults, ResultHandler resultHandler) Handle the intermediate results that got from a certain ResultHandler instance.
void	handleResults(java.util.ArrayList<XMLDBModel> modelResults) To be implemented by the concrete classes to implement the function to handle the results of searched models.
boolean	isSearchCancelled() Check whether the searching process has been canceled by the user.
void	passErrorModels(java.util.List<XMLDBModel> errorModels) In the case of getting some models that cannot be parsed or contains some error, use this method to pass these error models to store for error handling.
void	setConnection(DBConnection connection) Set the DB connection for this result handler.
void	wholeSearchDone() Notify the search result buffer that the searching is done.

Method Detail

handleIntermediateResults

void handleIntermediateResults(java.util.List<XMLDBModel> intermediateResults,
                               ResultHandler resultHandler)

Handle the intermediate results that got from a certain ResultHandler instance.

Parameters:

intermediateResults - The intermediate results set to be handled in this ResultHandler.

resultHandler - The ResultHandler instance that gets the passed intermediate results.

handleResults

void handleResults(java.util.ArrayList<XMLDBModel> modelResults)
            throws DBConnectionException,
                   DBExecutionException

To be implemented by the concrete classes to implement the function to handle the results of searched models.

Parameters:

modelResults - The searched model results to be handled.

Throws:

DBConnectionException - Database connection problem occurs during handling the results through searching in the database.

DBExecutionException - Thrown from the database layer when there is error occurring in the execution.

isSearchCancelled

boolean isSearchCancelled()

Check whether the searching process has been canceled by the user.

Returns:

true - The search has been canceled by the user.
false - The search hasn't been canceled.

passErrorModels

void passErrorModels(java.util.List<XMLDBModel> errorModels)

In the case of getting some models that cannot be parsed or contains some error, use this method to pass these error models to store for error handling.

Parameters:

errorModels - The error models.

setConnection

void setConnection(DBConnection connection)

Set the DB connection for this result handler.

Parameters:

connection - The DBConnection instance to be set in this result handler.

wholeSearchDone

void wholeSearchDone()
              throws DBConnectionException

Notify the search result buffer that the searching is done.

Throws:

DBConnectionException - Thrown if the DB connection cannot be obtained.