Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jdesktop.swingx.ws.yahoo.search.websearch
[Java] Class YahooSpellingSuggestion

java.lang.Object
  org.jdesktop.beans.AbstractBean
      org.jdesktop.swingx.ws.yahoo.search.YahooSearch
          org.jdesktop.swingx.ws.yahoo.search.websearch.YahooWebSearchService
              org.jdesktop.swingx.ws.yahoo.search.websearch.YahooSpellingSuggestion

public final class YahooSpellingSuggestion
extends YahooWebSearchService

The YahooSpellingSuggestion bean provides a suggested spelling correction for a given term. The Yahoo! website for more information.

The #readResults method in this class simply returns a ResultsList of Strings that met the spelling suggestion requirement.

Authors:
rbair

Nested Class Summary
private static class YahooSpellingSuggestion.Parser

 
Field Summary
private String appId

private String query

 
Fields inherited from class YahooSearch
URL_PREFIX
 
Constructor Summary
YahooSpellingSuggestion()

Creates a new instance of YahooSpellingSuggestion
 
Method Summary
String getAppId()

Returns:
the Yahoo!
protected String getMethod()

@inheritDoc
protected Map getParameters()

@inheritDoc
String getQuery()

@return the search query to use
protected ResultsList readResults(InputStream in)

@inheritDoc
void setAppId(String appId)

Sets the Yahoo app id to use with this component.

void setQuery(String query)

Sets the search query to use.

 
Methods inherited from class YahooWebSearchService
getServiceName, getVersionNumber
 
Methods inherited from class YahooSearch
constructUrl, getDefaultResultCount, getMethod, getParameters, getServiceName, getVersionNumber, readResults, search, search
 
Methods inherited from class org.jdesktop.beans.AbstractBean
org.jdesktop.beans.AbstractBean#clone(), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(), org.jdesktop.beans.AbstractBean#wait(), org.jdesktop.beans.AbstractBean#wait(long), org.jdesktop.beans.AbstractBean#wait(long, int), org.jdesktop.beans.AbstractBean#equals(java.lang.Object), org.jdesktop.beans.AbstractBean#toString(), org.jdesktop.beans.AbstractBean#hashCode(), org.jdesktop.beans.AbstractBean#getClass(), org.jdesktop.beans.AbstractBean#notify(), org.jdesktop.beans.AbstractBean#notifyAll()
 

Field Detail

appId

private String appId

query

private String query

 
Constructor Detail

YahooSpellingSuggestion

public YahooSpellingSuggestion()
Creates a new instance of YahooSpellingSuggestion

 
Method Detail

getAppId

public String getAppId()
Returns:
the Yahoo! app id in use for this component

getMethod

protected final String getMethod()
inheritDoc:

getParameters

protected Map getParameters()
inheritDoc:

getQuery

public String getQuery()
Returns:
the search query to use

readResults

protected ResultsList readResults(InputStream in)
inheritDoc:

setAppId

public void setAppId(String appId)
Sets the Yahoo app id to use with this component. Without an app id, no searches can be executed. You must get an app id from yahoo. See the Yahoo docs for more info.
Parameters:
appId

setQuery

public void setQuery(String query)
Sets the search query to use. This follows all the same conventions as the web based Yahoo! search engine

 

Groovy Documentation