no.sesat.search.mode.config
Class FastCommandConfig

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

All Implemented Interfaces:

Serializable, BaseSearchConfiguration, SearchConfiguration, SearchConfiguration.ModesW3cDomDeserialiser

Direct Known Subclasses:

AdvancedFastCommandConfig, CorrectingFast4CommandConfig, EspFastCommandConfig, NewsCommandConfig, SensisCommandConfig, WebCommandConfig

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

Configure a Fast 4 search command

Version:

$Id: FastCommandConfig.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

FastCommandConfig()

Method Summary

void	addCollections(String[] collectionArray)
void	addNavigator(Navigator navigator, String navKey)
String	getAlternativeSortBy()
String	getCollectionFilterString()
String[]	getCollections()
String	getFilter()
String	getFiltertype()
Navigator	getNavigator(String navigatorKey)
Map<String,Navigator>	getNavigators()
int	getOffensiveScoreLimit()
String	getProject()
String	getQtPipeline()
String	getQueryServerUrl()
String	getQueryType()
String	getResultView()
Map<String,String>	getSearchParameterMap()
String[]	getSearchParameters()
String	getSortBy()
int	getSpamScoreLimit()
String	getSpellchecklanguage()
boolean	isClustering()
boolean	isCollapsing()
boolean	isExpansion() Returns true if expansion is enabled.
boolean	isIgnoreNavigation()
boolean	isKeywordClusteringEnabled()
boolean	isLemmatise()
boolean	isRelevantQueries()
boolean	isSpellcheck()
SearchConfiguration	readSearchConfiguration(Element element, SearchConfiguration inherit, SearchModeFactory.Context context) Apply the attributes found in element to 'this'.
void	setAlternativeSortBy(String alternativeSortBy)
void	setClustering(boolean clusteringEnabled) Setter for property clustering.
void	setCollapsing(boolean collapsingEnabled)
void	setExpansion(boolean expansion) Setter for the expansionEnabled property.
void	setFilter(String filter) Setter for property filter.
void	setFiltertype(String filtertype)
void	setIgnoreNavigation(boolean ignoreNavigationEnabled)
void	setKeywordClusteringEnabled(boolean keywordClusteringEnabled)
void	setLemmatise(boolean lemmatise)
void	setOffensiveScoreLimit(int offensiveScoreLimit) Setter for property offensiveScoreLimit.
void	setProject(String project)
void	setQtPipeline(String qtPipeline)
void	setQueryServerUrl(String queryServerUrl)
void	setQueryType(String queryType) Set the query type @see BaseParameter.TYPE "any" for simple query syntax "adv" for advanced
void	setRelevantQueries(boolean relevantQueriesEnabled) Setter for property relevantQueries.
void	setResultView(String resultView)
void	setSearchParameters(String[] parameters)
void	setSortBy(String sortBy)
void	setSpamScoreLimit(int i)
void	setSpellcheck(boolean spellcheckEnabled)
void	setSpellchecklanguage(String spellchecklanguage)

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

FastCommandConfig

public FastCommandConfig()

Method Detail

getCollections

public String[] getCollections()

Returns:

addCollections

public void addCollections(String[] collectionArray)

Parameters:

collectionArray - Add collections to this configuration.

getCollectionFilterString

public String getCollectionFilterString()

Returns:

getQueryServerUrl

public String getQueryServerUrl()

Returns:

getSearchParameterMap

public Map<String,String> getSearchParameterMap()

Returns:

setSearchParameters

public void setSearchParameters(String[] parameters)

Parameters:

parameters - Add search parameters

getSearchParameters

public String[] getSearchParameters()

Returns:

Array of search parameters.

isLemmatise

public boolean isLemmatise()

Returns:

setLemmatise

public void setLemmatise(boolean lemmatise)

Parameters:

lemmatise -

isSpellcheck

public boolean isSpellcheck()

Returns:

setSpellcheck

public void setSpellcheck(boolean spellcheckEnabled)

Parameters:

spellcheckEnabled -

getSpellchecklanguage

public String getSpellchecklanguage()

Returns:

setSpellchecklanguage

public void setSpellchecklanguage(String spellchecklanguage)

Parameters:

spellchecklanguage -

getNavigators

public Map<String,Navigator> getNavigators()

Returns:

addNavigator

public void addNavigator(Navigator navigator,
                         String navKey)

Parameters:

navigator -

navKey -

getNavigator

public Navigator getNavigator(String navigatorKey)

Parameters:

navigatorKey -

Returns:

getSortBy

public String getSortBy()

Returns:

setSortBy

public void setSortBy(String sortBy)

Parameters:

sortBy -

getAlternativeSortBy

public String getAlternativeSortBy()

setAlternativeSortBy

public void setAlternativeSortBy(String alternativeSortBy)

isCollapsing

public boolean isCollapsing()

Returns:

setCollapsing

public void setCollapsing(boolean collapsingEnabled)

Parameters:

collapsingEnabled -

getResultView

public String getResultView()

Returns:

setResultView

public void setResultView(String resultView)

Parameters:

resultView -

setQueryServerUrl

public void setQueryServerUrl(String queryServerUrl)

Parameters:

queryServerUrl -

isKeywordClusteringEnabled

public boolean isKeywordClusteringEnabled()

Returns:

setKeywordClusteringEnabled

public void setKeywordClusteringEnabled(boolean keywordClusteringEnabled)

Parameters:

keywordClusteringEnabled -

getQtPipeline

public String getQtPipeline()

Returns:

setQtPipeline

public void setQtPipeline(String qtPipeline)

Parameters:

qtPipeline -

isClustering

public boolean isClustering()

Returns:

isIgnoreNavigation

public boolean isIgnoreNavigation()

Returns:

setIgnoreNavigation

public void setIgnoreNavigation(boolean ignoreNavigationEnabled)

Parameters:

ignoreNavigationEnabled -

getOffensiveScoreLimit

public int getOffensiveScoreLimit()

Returns:

getSpamScoreLimit

public int getSpamScoreLimit()

Returns:

isRelevantQueries

public boolean isRelevantQueries()

Returns:

getFilter

public String getFilter()

Returns:

getFiltertype

public String getFiltertype()

Returns:

setFiltertype

public void setFiltertype(String filtertype)

Parameters:

filtertype -

getQueryType

public String getQueryType()

Returns:

See Also:

setQueryType(java.lang.String)

setQueryType

public void setQueryType(String queryType)

Set the query type @see BaseParameter.TYPE "any" for simple query syntax "adv" for advanced

Parameters:

queryType -

getProject

public String getProject()

Returns:

setProject

public void setProject(String project)

Parameters:

project -

setSpamScoreLimit

public void setSpamScoreLimit(int i)

setClustering

public void setClustering(boolean clusteringEnabled)

Setter for property clustering.

Parameters:

clusteringEnabled - New value of property clustering.

setFilter

public void setFilter(String filter)

Setter for property filter.

Parameters:

filter - New value of property filter.

setOffensiveScoreLimit

public void setOffensiveScoreLimit(int offensiveScoreLimit)

Setter for property offensiveScoreLimit.

Parameters:

offensiveScoreLimit - New value of property offensiveScoreLimit.

setRelevantQueries

public void setRelevantQueries(boolean relevantQueriesEnabled)

Setter for property relevantQueries.

Parameters:

relevantQueriesEnabled - New value of property relevantQueries.

isExpansion

public boolean isExpansion()

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.

setExpansion

public void setExpansion(boolean expansion)

Setter for the expansionEnabled property.

Parameters:

expansion -

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 CommandConfig

Returns:

The newly read configuration (chaining pattern)