com.yahoo.search.xmlparser
Class XmlParserImageSearchResults.XmlParserImageSearchResult

java.lang.Object
  com.yahoo.search.xmlparser.XmlParserImageSearchResults.XmlParserImageSearchResult

All Implemented Interfaces:

ImageSearchResult

Enclosing class:

XmlParserImageSearchResults

public static class XmlParserImageSearchResults.XmlParserImageSearchResult
extends Object
implements ImageSearchResult

Constructor Summary

XmlParserImageSearchResults.XmlParserImageSearchResult(Map result)

Method Summary

String	getClickUrl() The URL for linking to the image file.
String	getCopyright() The copyright owner.
String	getFileFormat() One of bmp, gif, jpg, or png.
BigInteger	getFileSize() The size of the file in bytes.
BigInteger	getHeight() The height of the image in pixels.
String	getPublisher() The creator of the image file.
String	getRefererUrl() The URL of the web page hosting the content.
String	getRestrictions() Provides any restrictions for this media object.
String	getSummary() Summary text associated with the image file.
ImageThumbnail	getThumbnail() The URL of the thumbnail file and its height and width in pixels.
String	getTitle() The title of the image file.
String	getUrl() The URL for the image file.
BigInteger	getWidth() The width of the image in pixels.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlParserImageSearchResults.XmlParserImageSearchResult

public XmlParserImageSearchResults.XmlParserImageSearchResult(Map result)

Method Detail

getTitle

public String getTitle()

Description copied from interface: ImageSearchResult

The title of the image file.

Specified by:

getTitle in interface ImageSearchResult

Returns:

The title of the image file.

getSummary

public String getSummary()

Description copied from interface: ImageSearchResult

Summary text associated with the image file.

Specified by:

getSummary in interface ImageSearchResult

Returns:

Summary text associated with the image file.

getUrl

public String getUrl()

Description copied from interface: ImageSearchResult

The URL for the image file.

Specified by:

getUrl in interface ImageSearchResult

Returns:

The URL for the image file.

getClickUrl

public String getClickUrl()

Description copied from interface: ImageSearchResult

The URL for linking to the image file. See URL linking for more information.

Specified by:

getClickUrl in interface ImageSearchResult

Returns:

The URL for linking to the image file.

getRefererUrl

public String getRefererUrl()

Description copied from interface: ImageSearchResult

The URL of the web page hosting the content.

Specified by:

getRefererUrl in interface ImageSearchResult

Returns:

The URL of the web page hosting the content.

getFileSize

public BigInteger getFileSize()

Description copied from interface: ImageSearchResult

The size of the file in bytes.

Specified by:

getFileSize in interface ImageSearchResult

Returns:

The size of the file in bytes.

getFileFormat

public String getFileFormat()

Description copied from interface: ImageSearchResult

One of bmp, gif, jpg, or png.

NOTE: The value returned is not guaranteed to be one of the above options. The XML schema for image search specifies that FileFormat is of type xs:string. It is possible you may receive something other than the previously mentioned formats.

Specified by:

getFileFormat in interface ImageSearchResult

Returns:

One of bmp, gif, jpg, or png.

getHeight

public BigInteger getHeight()

Description copied from interface: ImageSearchResult

The height of the image in pixels. This field is optional.

Specified by:

getHeight in interface ImageSearchResult

Returns:

The height of the image in pixels.

getWidth

public BigInteger getWidth()

Description copied from interface: ImageSearchResult

The width of the image in pixels. This field is optional.

Specified by:

getWidth in interface ImageSearchResult

Returns:

The width of the image in pixels.

getThumbnail

public ImageThumbnail getThumbnail()

Description copied from interface: ImageSearchResult

The URL of the thumbnail file and its height and width in pixels.

Specified by:

getThumbnail in interface ImageSearchResult

Returns:

The URL of the thumbnail file and its height and width in pixels.

getPublisher

public String getPublisher()

Description copied from interface: ImageSearchResult

The creator of the image file. This field is optional.

Specified by:

getPublisher in interface ImageSearchResult

Returns:

The creator of the image file.

getRestrictions

public String getRestrictions()

Description copied from interface: ImageSearchResult

Provides any restrictions for this media object. Restrictions include noframe and noinline. This field is optional.

• Noframe means that you should not display it with a framed page on your site.
• Noinline means that you should not inline the object in the frame up top (it won't work because the site has some protection based on the "referrer" field).

NOTE: The value returned is not guaranteed to be one of the above options. The XML schema for image search specifies that Restrictions is of type xs:string. It is possible you may receive something other than the previously mentioned numbers.

Specified by:

getRestrictions in interface ImageSearchResult

Returns:

Provides any restrictions for this media object. Restrictions include noframe and noinline.

getCopyright

public String getCopyright()

Description copied from interface: ImageSearchResult

The copyright owner. This field is optional.

Specified by:

getCopyright in interface ImageSearchResult

Returns:

The copyright owner.