no.sesat.search.mode.config
Class YahooWebCommandConfig

java.lang.Object
  no.sesat.search.mode.config.CommandConfig
      no.sesat.search.mode.config.AbstractXmlSearchConfiguration
          no.sesat.search.mode.config.AbstractYahooSearchConfiguration
              no.sesat.search.mode.config.YahooWebCommandConfig

All Implemented Interfaces:

Serializable, BaseSearchConfiguration, SearchConfiguration, SearchConfiguration.ModesW3cDomDeserialiser

@CommandConfig.Controller(value="YahooWebSearchCommand")
public class YahooWebCommandConfig
extends AbstractYahooSearchConfiguration

Configuration for searches against Yahoo's Contextual Web Service. see http://developer.yahoo.com/search/web/V1/contextSearch.html

Version:

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

YahooWebCommandConfig()

Method Summary

boolean	getAdult() Getter for property adult.
String	getAppid() Getter for property appid.
String	getCountry() Getter for property country.
String	getFormat() Getter for property format.
String	getLanguage() Getter for property language.
boolean	getSimilar() Getter for property similar.
String	getSite() Getter for property site.
SearchConfiguration	readSearchConfiguration(Element element, SearchConfiguration inherit, SearchModeFactory.Context context) Apply the attributes found in element to 'this'.
void	setAdult(boolean adult) Setter for property adult.
void	setAppid(String appid) Setter for property appid.
void	setCountry(String country) Setter for property country.
void	setFormat(String format) Setter for property format.
void	setLanguage(String language) Setter for property language.
void	setSimilar(boolean similar) Setter for property uniqusimilare.
void	setSite(String site) Setter for property site.

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

getPartnerId, setPartnerId

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

getEncoding, getHost, getHostHeader, getPort, setEncoding, setHost, setHostHeader, setPort

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

YahooWebCommandConfig

public YahooWebCommandConfig()

Method Detail

getSimilar

public boolean getSimilar()

Getter for property similar.

Returns:

Value of property similar.

setSimilar

public void setSimilar(boolean similar)

Setter for property uniqusimilare.

Parameters:

similar - New value of property similar.

getCountry

public String getCountry()

Getter for property country.

Returns:

Value of property country.

setCountry

public void setCountry(String country)

Setter for property country. Available values written in http://developer.yahoo.com/search/countries.html

Parameters:

country - New value of property country.

getAppid

public String getAppid()

Getter for property appid.

Returns:

Value of property appid.

setAppid

public void setAppid(String appid)

Setter for property appid. This value will be propagated to setPartnerId(..) in readSearchConfigurationAfter. Apply for a application ID here http://developer.yahoo.com/faq/index.html#appid

Parameters:

appid - New value of property appid.

getLanguage

public String getLanguage()

Getter for property language.

Returns:

Value of property language.

setLanguage

public void setLanguage(String language)

Setter for property language. see supported languages http://developer.yahoo.com/search/languages.html

Parameters:

language - New value of property language.

getSite

public String getSite()

Getter for property site.

Returns:

Value of property site.

setSite

public void setSite(String site)

Setter for property site.

Parameters:

site - New value of property site.

getFormat

public String getFormat()

Getter for property format.

Returns:

Value of property format.

setFormat

public void setFormat(String format)

Setter for property format.

Parameters:

format - New value of property format.

getAdult

public boolean getAdult()

Getter for property adult.

Returns:

Value of property adult.

setAdult

public void setAdult(boolean adult)

Setter for property adult.

Parameters:

adult - New value of property adult.

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)