no.sesat.search.mode.config
Interface BaseSearchConfiguration

All Superinterfaces:

SearchConfiguration, Serializable

All Known Implementing Classes:

AbstractWebServiceSearchConfiguration, AbstractXmlSearchConfiguration, AbstractYahooSearchConfiguration, AdvancedFastCommandConfig, BlendingNewsCommandConfig, ClusteringEspFastCommandConfig, CommandConfig, CorrectingFast4CommandConfig, EspFastCommandConfig, FastCommandConfig, MathCommandConfig, MobileCommandConfig, NavigatableEspFastCommandConfig, NewsAggregatorCommandConfig, NewsCommandConfig, NewsEspCommandConfig, NewsMyNewsCommandConfig, OverturePpcCommandConfig, PictureCommandConfig, PlatefoodPpcCommandConfig, PropertiesCommandConfig, SensisCommandConfig, SolrCommandConfig, StaticCommandConfig, StockCommandConfig, WebCommandConfig, YahooIdpCommandConfig, YahooMediaCommandConfig, YahooWebCommandConfig, YoutubeCommandConfig

public interface BaseSearchConfiguration
extends SearchConfiguration

Minimum behavior defined for any AbstractSearchConfiguration implementation.

Version:

$Id: BaseSearchConfiguration.java 7225 2009-04-09 00:32:20Z ssmiweve $

Nested Class Summary

Nested classes/interfaces inherited from interface no.sesat.search.mode.config.SearchConfiguration

SearchConfiguration.ModesW3cDomDeserialiser

Field Summary

Fields inherited from interface no.sesat.search.mode.config.SearchConfiguration

DEFAULT_PAGING_PARAMETER, DEFAULT_USER_SORT_PARAMETER

Method Summary

void	addQueryTransformer(QueryTransformerConfig transformer) Adds a QueryTransformerConfig to the list of transformeres.
void	addResultHandler(ResultHandlerConfig handler) Adds a ResultHandlerConfig to the list of handlers.
void	clearQueryTransformers()
void	clearResultHandlers() Remove all result handlers.
QueryTransformerConfig	getInitialQueryTransformer()
QueryBuilderConfig	getQueryBuilder()
List<QueryTransformerConfig>	getQueryTransformers() Returns a (defensive copy) list of QueryTransformerConfig that should be applied to the query before the query is sent to search indices.
List<ResultHandlerConfig>	getResultHandlers() Returns a (defensive copy) list of ResultHandlerConfig that should act on the search result.
void	setInitialQueryTransformer(QueryTransformerConfig initialQueryTransformer)
void	setQueryBuilder(QueryBuilderConfig queryBuilderConfig)

Methods inherited from interface no.sesat.search.mode.config.SearchConfiguration

addResultField, clearFieldFilters, getFieldFilterMap, getId, getName, getPagingParameter, getQueryParameter, getResultFieldMap, getResultsToReturn, getStatisticalName, getUserSortParameter, isAlwaysRun, isAsynchronous, isRunBlank

Method Detail

clearQueryTransformers

void clearQueryTransformers()

getQueryTransformers

List<QueryTransformerConfig> getQueryTransformers()

Returns a (defensive copy) list of QueryTransformerConfig that should be applied to the query before the query is sent to search indices.

Returns:

The list of query.

addQueryTransformer

void addQueryTransformer(QueryTransformerConfig transformer)

Adds a QueryTransformerConfig to the list of transformeres.

Parameters:

transformer - The query transformer to add.

clearResultHandlers

void clearResultHandlers()

Remove all result handlers.

getResultHandlers

List<ResultHandlerConfig> getResultHandlers()

Returns a (defensive copy) list of ResultHandlerConfig that should act on the search result.

Returns:

The list of handlers.

addResultHandler

void addResultHandler(ResultHandlerConfig handler)

Adds a ResultHandlerConfig to the list of handlers.

Parameters:

handler - The handler to add.

getQueryBuilder

QueryBuilderConfig getQueryBuilder()

setQueryBuilder

void setQueryBuilder(QueryBuilderConfig queryBuilderConfig)

getInitialQueryTransformer

QueryTransformerConfig getInitialQueryTransformer()

setInitialQueryTransformer

void setInitialQueryTransformer(QueryTransformerConfig initialQueryTransformer)