ddf.catalog.federation.base

Class AbstractFederationStrategy

java.lang.Object

ddf.catalog.federation.base.AbstractFederationStrategy

All Implemented Interfaces:

FederationStrategy

Direct Known Subclasses:

SortedFederationStrategy

public abstract class AbstractFederationStrategy
extends Object
implements FederationStrategy

This class serves as a base implementation of the FederationStrategy interface. Other classes can extend this class to create specific attributes to sort by.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<PostFederatedQueryPlugin>	postQuery The List of post-federated query plugins to execute on the query request after the query is executed on the Source.
protected List<PreFederatedQueryPlugin>	preQuery The List of pre-federated query plugins to execute on the query request before the query is executed on the Source.

Constructor Summary

Constructors

Constructor and Description
AbstractFederationStrategy(ExecutorService queryExecutorService) Deprecated. - only to provide support for deprecated FifoFederationStrategy and SortedFederationStrategy
AbstractFederationStrategy(ExecutorService queryExecutorService, List<PreFederatedQueryPlugin> preQuery, List<PostFederatedQueryPlugin> postQuery) Instantiates an AbstractFederationStrategy with the provided ExecutorService.

Method Summary

Modifier and Type	Method and Description
protected abstract Runnable	createMonitor(ExecutorService queryExecutorService, Map<Source,Future<SourceResponse>> futures, QueryResponseImpl returnResults, Query query) Creates the monitor for federated queries.
QueryResponse	federate(List<Source> sources, QueryRequest queryRequest) Federate the given query to the List of Sources, returning a QueryResponse back to the user that will include the matching Results.
void	setMaxStartIndex(int maxStartIndex) To be set via Spring/Blueprint

Methods inherited from class java.lang.Object

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

Field Detail

preQuery

protected List<PreFederatedQueryPlugin> preQuery

The List of pre-federated query plugins to execute on the query request before the query is executed on the Source.

postQuery

protected List<PostFederatedQueryPlugin> postQuery

The List of post-federated query plugins to execute on the query request after the query is executed on the Source.

Constructor Detail

AbstractFederationStrategy

public AbstractFederationStrategy(ExecutorService queryExecutorService)

Deprecated. - only to provide support for deprecated FifoFederationStrategy and SortedFederationStrategy

Instantiates an AbstractFederationStrategy with the provided ExecutorService.

Parameters:

queryExecutorService - the ExecutorService for queries

AbstractFederationStrategy

public AbstractFederationStrategy(ExecutorService queryExecutorService,
                                  List<PreFederatedQueryPlugin> preQuery,
                                  List<PostFederatedQueryPlugin> postQuery)

Instantiates an AbstractFederationStrategy with the provided ExecutorService.

Parameters:

queryExecutorService - the ExecutorService for queries

Method Detail

createMonitor

protected abstract Runnable createMonitor(ExecutorService queryExecutorService,
                                          Map<Source,Future<SourceResponse>> futures,
                                          QueryResponseImpl returnResults,
                                          Query query)

Creates the monitor for federated queries.

Parameters:

queryExecutorService -

futures -

returnResults - the query results

query -

Returns:

the Runnable

federate

public QueryResponse federate(List<Source> sources,
                              QueryRequest queryRequest)

Description copied from interface: FederationStrategy

Federate the given query to the List of Sources, returning a QueryResponse back to the user that will include the matching Results.

Specified by:

federate in interface FederationStrategy

Parameters:

sources - the List of Sources to be queried. Cannot be null or empty.

queryRequest - the QueryRequest to execute. Cannot be null.

Returns:

QueryResponse which contains the list of Results.

setMaxStartIndex

public void setMaxStartIndex(int maxStartIndex)

To be set via Spring/Blueprint

Parameters:

maxStartIndex - the new default max start index value