Package ddf.catalog.plugin

Class PreFederatedLocalProviderQueryPlugin

java.lang.Object

ddf.catalog.plugin.PreFederatedLocalProviderQueryPlugin

All Implemented Interfaces:

PreFederatedQueryPlugin

public abstract class PreFederatedLocalProviderQueryPlugin
extends Object
implements PreFederatedQueryPlugin

The PreFederatedLocalProviderQueryPlugin is an abstract class implementing the PreFederatedQueryPlugin. A PreFederatedQueryPlugin that applies only for local Sources should extend the PreFederatedLocalProviderQueryPlugin. This abstract class provides the isLocalSource(ddf.catalog.source.Source) method to check if a given Source is a local Source.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<CatalogProvider>	catalogProviders

Constructor Summary

Constructors

Constructor	Description
PreFederatedLocalProviderQueryPlugin(List<CatalogProvider> catalogProviders)

Method Summary

Modifier and Type	Method	Description
protected boolean	isLocalSource(Source source)	Given a source, determine if it is a registered catalog provider or a cache.
abstract QueryRequest	process(Source source, QueryRequest input)	Processes a QueryRequest prior to execution of the Federated Query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

catalogProviders

protected final List<CatalogProvider> catalogProviders

Constructor Details

PreFederatedLocalProviderQueryPlugin

public PreFederatedLocalProviderQueryPlugin(List<CatalogProvider> catalogProviders)

Method Details

isLocalSource

protected boolean isLocalSource(Source source)

Given a source, determine if it is a registered catalog provider or a cache.

process

public abstract QueryRequest process(Source source,
 QueryRequest input)
                              throws StopProcessingException

Description copied from interface: PreFederatedQueryPlugin

Processes a QueryRequest prior to execution of the Federated Query.

Specified by:

process in interface PreFederatedQueryPlugin

Parameters:

source - the Source the query will be sent to

input - the QueryRequest to process

Returns:

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

Throws:

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