Package ddf.catalog.plugin

Interface PreQueryPlugin

public interface PreQueryPlugin

A PreQueryPlugin is used to execute functionality after a query has been executed. For example if a query needed to be altered, a PreQueryPlugin could be implemented to alter the query prior to execution.

Method Summary

Modifier and Type	Method	Description
QueryRequest	process(QueryRequest input)	Processes a QueryRequest prior to execution of the Query.

Method Details

process

QueryRequest process(QueryRequest input)
              throws PluginExecutionException,
StopProcessingException

Processes a QueryRequest prior to execution of the Query.

Parameters:

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreQueryPlugin, or if this is the last PreQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryRequest

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.