no.sesat.search.mode.config
Class EspFastCommandConfig

java.lang.Object
  no.sesat.search.mode.config.CommandConfig
      no.sesat.search.mode.config.FastCommandConfig
          no.sesat.search.mode.config.EspFastCommandConfig

All Implemented Interfaces:

Serializable, BaseSearchConfiguration, SearchConfiguration, SearchConfiguration.ModesW3cDomDeserialiser

Direct Known Subclasses:

NavigatableEspFastCommandConfig

@CommandConfig.Controller(value="ESPFastSearchCommand")
public class EspFastCommandConfig
extends FastCommandConfig

Version:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class no.sesat.search.mode.config.CommandConfig

CommandConfig.Controller

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

SearchConfiguration.ModesW3cDomDeserialiser

Field Summary

Fields inherited from class no.sesat.search.mode.config.CommandConfig

DEFAULT_DOCUMENTS_TO_RETURN

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

DEFAULT_PAGING_PARAMETER, DEFAULT_USER_SORT_PARAMETER

Constructor Summary

EspFastCommandConfig()

Method Summary

void	addNavigator(Navigator navigator, String navKey)
String	getAlternativeSortBy() This is used as an alternetive sort order that can be swiched to from the client
Navigator	getNavigator(String navigatorKey)
Map<String,Navigator>	getNavigators()
String	getQtPipeline()
String	getQueryServer()
String	getSortBy()
int	getTimeout()
String	getView()
boolean	isCollapsingEnabled()
boolean	isCollapsingRemoves()
boolean	isExpansionEnabled() Returns true if expansion is enabled.
boolean	isLemmatize()
SearchConfiguration	readSearchConfiguration(Element element, SearchConfiguration inherit, SearchModeFactory.Context context) Apply the attributes found in element to 'this'.
void	setAlternativeSortBy(String alternativeSortBy)
void	setCollapsingEnabled(boolean collapsingEnabled)
void	setCollapsingRemoves(boolean collapsingRemoves)
void	setExpansionEnabled(boolean expansionEnabled) Setter for the expansionEnabled property.
void	setLemmatize(boolean lemmatize)
void	setQtPipeline(String qtPipeline)
void	setQueryServer(String queryServer)
void	setSortBy(String sortBy)
void	setTimeout(int integer) Fast ESP supports timeout on query with BaseParameter.TIMEOUT.
void	setView(String view)

Methods inherited from class no.sesat.search.mode.config.FastCommandConfig

addCollections, getCollectionFilterString, getCollections, getFilter, getFiltertype, getOffensiveScoreLimit, getProject, getQueryServerUrl, getQueryType, getResultView, getSearchParameterMap, getSearchParameters, getSpamScoreLimit, getSpellchecklanguage, isClustering, isCollapsing, isExpansion, isIgnoreNavigation, isKeywordClusteringEnabled, isLemmatise, isRelevantQueries, isSpellcheck, setClustering, setCollapsing, setExpansion, setFilter, setFiltertype, setIgnoreNavigation, setKeywordClusteringEnabled, setLemmatise, setOffensiveScoreLimit, setProject, setQueryServerUrl, setQueryType, setRelevantQueries, setResultView, setSearchParameters, setSpamScoreLimit, setSpellcheck, setSpellchecklanguage

Methods inherited from class no.sesat.search.mode.config.CommandConfig

addQueryTransformer, addResultField, addResultFields, addResultHandler, clearFieldFilters, clearQueryTransformers, clearResultHandlers, getFieldFilterMap, getId, getInitialQueryTransformer, getName, getPagingParameter, getQueryBuilder, getQueryParameter, getQueryTransformers, getResultFieldMap, getResultFields, getResultHandlers, getResultsToReturn, getStatisticalName, getUserSortParameter, isAlwaysRun, isAsynchronous, isRunBlank, parseNavigators, setAlwaysRun, setAsynchronous, setFieldFilters, setId, setInitialQueryTransformer, setPagingParameter, setQueryBuilder, setQueryParameter, setResultsToReturn, setRunBlank, setStatisticalName, setUserSortParameter, toString, toStringLong

Methods inherited from class java.lang.Object

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

Constructor Detail

EspFastCommandConfig

public EspFastCommandConfig()

Method Detail

setCollapsingEnabled

public void setCollapsingEnabled(boolean collapsingEnabled)

Parameters:

collapsingEnabled -

isCollapsingEnabled

public boolean isCollapsingEnabled()

Returns:

isExpansionEnabled

public boolean isExpansionEnabled()

Returns true if expansion is enabled. Expansion means the possibility to retrieve all of the documents that has been collapsed for a domain. If this is set to false the templates won't get the information that there are collapsed documents.

Returns:

true if expansion is enabled.

setExpansionEnabled

public void setExpansionEnabled(boolean expansionEnabled)

Setter for the expansionEnabled property.

Parameters:

expansionEnabled -

isCollapsingRemoves

public boolean isCollapsingRemoves()

Returns:

setCollapsingRemoves

public void setCollapsingRemoves(boolean collapsingRemoves)

Parameters:

collapsingRemoves -

getView

public String getView()

Returns:

setView

public void setView(String view)

Parameters:

view -

getQueryServer

public String getQueryServer()

Returns:

setQueryServer

public void setQueryServer(String queryServer)

Parameters:

queryServer -

getSortBy

public String getSortBy()

Overrides:

getSortBy in class FastCommandConfig

Returns:

setSortBy

public void setSortBy(String sortBy)

Overrides:

setSortBy in class FastCommandConfig

Parameters:

sortBy -

getAlternativeSortBy

public String getAlternativeSortBy()

This is used as an alternetive sort order that can be swiched to from the client

Overrides:

getAlternativeSortBy in class FastCommandConfig

Returns:

setAlternativeSortBy

public void setAlternativeSortBy(String alternativeSortBy)

Overrides:

setAlternativeSortBy in class FastCommandConfig

getNavigators

public Map<String,Navigator> getNavigators()

Overrides:

getNavigators in class FastCommandConfig

Returns:

addNavigator

public void addNavigator(Navigator navigator,
                         String navKey)

Overrides:

addNavigator in class FastCommandConfig

Parameters:

navigator -

navKey -

getNavigator

public Navigator getNavigator(String navigatorKey)

Overrides:

getNavigator in class FastCommandConfig

Parameters:

navigatorKey -

Returns:

setQtPipeline

public void setQtPipeline(String qtPipeline)

Overrides:

setQtPipeline in class FastCommandConfig

Parameters:

qtPipeline -

getQtPipeline

public String getQtPipeline()

Overrides:

getQtPipeline in class FastCommandConfig

Returns:

setLemmatize

public void setLemmatize(boolean lemmatize)

Parameters:

lemmatize -

isLemmatize

public boolean isLemmatize()

Returns:

setTimeout

public void setTimeout(int integer)

Fast ESP supports timeout on query with BaseParameter.TIMEOUT. Specified in milliseconds. Default is one second. Only actived when root log4j logger is set to INFO or higher. Rationale here is that we don't want timeouts in debugging environments.

Parameters:

integer -

getTimeout

public int getTimeout()

Returns:

See Also:

#setTimeout(java.lang.Integer)

readSearchConfiguration

public SearchConfiguration readSearchConfiguration(Element element,
                                                   SearchConfiguration inherit,
                                                   SearchModeFactory.Context context)

Description copied from interface: SearchConfiguration.ModesW3cDomDeserialiser

Apply the attributes found in element to 'this'. If some attributes are not found in element then try to fetch them from inherit and set them on 'this'.

Specified by:

readSearchConfiguration in interface SearchConfiguration.ModesW3cDomDeserialiser

Overrides:

readSearchConfiguration in class FastCommandConfig

Returns:

The newly read configuration (chaining pattern)