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.imagesearch
[Java] Class YahooImageSearch

java.lang.Object
  org.jdesktop.beans.AbstractBean
      org.jdesktop.swingx.ws.yahoo.search.YahooSearch
          org.jdesktop.swingx.ws.yahoo.search.imagesearch.YahooImageSearch

public final class YahooImageSearch
extends YahooSearch

A non visual JavaBean that leverages the Yahoo! image search service.

Authors:
rbair

Nested Class Summary
private class YahooImageSearch.Parser

static class YahooImageSearch.Result

@author rbair
 
Field Summary
private boolean adultOk

private String appId

private Coloration coloration

private FileFormat format

private String query

private Set sites

private Type type

 
Fields inherited from class YahooSearch
URL_PREFIX
 
Constructor Summary
YahooImageSearch()

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

Returns:
the Yahoo!
Coloration getColoration()

@return the coloration code
FileFormat getFileFormat()

@return the file format code
protected String getMethod()

@inheritDoc
protected Map getParameters()

@inheritDoc
String getQuery()

@return the search query to use
protected String getServiceName()

@inheritDoc
Type getType()

@return the Type
protected String getVersionNumber()

@inheritDoc
boolean isAdultOk()

@return true if adult content is ok
protected ResultsList readResults(InputStream in)

@inheritDoc
void setAdultOk(boolean adultOk)

Sets the adult ok boolean.

void setAppId(String appId)

Sets the Yahoo app id to use with this component.

void setColoration(Coloration coloration)

Sets the format code.

void setFileFormat(FileFormat format)

Sets the file format code.

void setQuery(String query)

Sets the search query to use.

void setType(Type type)

Sets the type code.

 
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

coloration

private Coloration coloration

format

private FileFormat format

query

private String query

sites

private Set sites

type

private Type type

 
Constructor Detail

YahooImageSearch

public YahooImageSearch()
Creates a new instance of YahooWebContextSearch

 
Method Detail

getAppId

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

getColoration

public Coloration getColoration()
Returns:
the coloration code

getFileFormat

public FileFormat getFileFormat()
Returns:
the file format code

getMethod

protected final String getMethod()
inheritDoc:

getParameters

protected final Map getParameters()
inheritDoc:

getQuery

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

getServiceName

protected final String getServiceName()
inheritDoc:

getType

public Type getType()
Returns:
the Type

getVersionNumber

protected final String getVersionNumber()
inheritDoc:

isAdultOk

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

readResults

protected ResultsList readResults(InputStream in)
inheritDoc:

setAdultOk

public void setAdultOk(boolean adultOk)
Sets the adult ok boolean. See Yahoo! for more info

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

setColoration

public void setColoration(Coloration coloration)
Sets the format code. See Yahoo! for more info

setFileFormat

public void setFileFormat(FileFormat format)
Sets the file format code. See Yahoo! for more info

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

setType

public void setType(Type type)
Sets the type code. See Yahoo! for more info

 

Groovy Documentation