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 YahooWebSearch

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.YahooWebSearch

public final class YahooWebSearch
extends YahooWebSearchService

Non visual JavaBean for calling Yahoo! search and retrieving the search results. To use, simply specify a query and your appId. (AppId is a value you get from Yahoo -- each application must have an id).

This bean is related to the Yahoo! Web Search web service.

Authors:
rbair

Nested Class Summary
private class YahooWebSearch.Parser

static class YahooWebSearch.Result

The Result of performing a search.

 
Field Summary
private boolean adultOk

private String appId

private Country country

private Format format

private Language language

private License license

private String query

private Region region

private boolean similarOk

private Set sites

private Set subscriptions

Creates a new instance of YahooWebContextSearch
private Type type

 
Fields inherited from class YahooSearch
URL_PREFIX
 
Constructor Summary
YahooWebSearch()

 
Method Summary
String getAppId()

Returns:
the Yahoo!
Country getCountry()

@return the country code
Format getFormat()

@return the format code
Language getLanguage()

@return the language code
License getLicense()

@return the license code
protected String getMethod()

@inheritDoc
protected Map getParameters()

@inheritDoc
String getQuery()

@return the search query to use
Region getRegion()

@return the region code
Type getType()

boolean isAdultOk()

@return true if adult content is ok
boolean isSimilarOk()

@return true if similar results are ok
protected ResultsList readResults(InputStream in)

@inheritDoc
void setAdultOk(boolean adultOk)

void setAppId(String appId)

void setCountry(Country country)

void setFormat(Format format)

void setLanguage(Language language)

void setLicense(License license)

void setQuery(String query)

void setRegion(Region region)

void setSimilarOk(boolean similarOk)

void setType(Type type)

 
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

adultOk

private boolean adultOk

appId

private String appId

country

private Country country

format

private Format format

language

private Language language

license

private License license

query

private String query

region

private Region region

similarOk

private boolean similarOk

sites

private Set sites

subscriptions

private Set subscriptions
Creates a new instance of YahooWebContextSearch

type

private Type type

 
Constructor Detail

YahooWebSearch

public YahooWebSearch()

 
Method Detail

getAppId

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

getCountry

public Country getCountry()
Returns:
the country code

getFormat

public Format getFormat()
Returns:
the format code

getLanguage

public Language getLanguage()
Returns:
the language code

getLicense

public License getLicense()
Returns:
the license code

getMethod

protected final String getMethod()
inheritDoc:

getParameters

protected final Map getParameters()
inheritDoc:

getQuery

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

getRegion

public Region getRegion()
Returns:
the region code

getType

public Type getType()

isAdultOk

public boolean isAdultOk()
Returns:
true if adult content is ok

isSimilarOk

public boolean isSimilarOk()
Returns:
true if similar results are ok

readResults

protected ResultsList readResults(InputStream in)
inheritDoc:

setAdultOk

public void setAdultOk(boolean adultOk)

setAppId

public void setAppId(String appId)

setCountry

public void setCountry(Country country)

setFormat

public void setFormat(Format format)

setLanguage

public void setLanguage(Language language)

setLicense

public void setLicense(License license)

setQuery

public void setQuery(String query)

setRegion

public void setRegion(Region region)

setSimilarOk

public void setSimilarOk(boolean similarOk)

setType

public void setType(Type type)

 

Groovy Documentation