org.apache.wink.common.model.opensearch
Class OpenSearchImage

java.lang.Object
  org.apache.wink.common.model.opensearch.OpenSearchImage

public class OpenSearchImage
extends java.lang.Object

The "Image" element per OpenSearch specification

 The "Image" element
 
 Contains a URL that identifies the location of an image that can be used in association 
 with this search content.
 
 Image sizes are offered as a hint to the search client. 
 The search client will chose the most appropriate image for the 
 available space and should give preference to those listed first in the 
 OpenSearch description document. Square aspect ratios are recommended. 
 When possible, search engines should offer a 16x16 image of 
 type "image/x-icon" or "image/vnd.microsoft.icon" (the Microsoft ICON format) 
 and a 64x64 image of type "image/jpeg" or "image/png".
 
     Parent: OpenSearchDescription 
     Attributes:
 
         height - Contains the height, in pixels, of this image.
 
             Restrictions: The value must be a non-negative integer. 
             Requirements: This attribute is optional. 
 
         width - Contains the width, in pixels, of this image.
 
             Restrictions: The value must be a non-negative integer. 
             Requirements: This attribute is optional. 
 
         type - Contains the the MIME type of this image.
 
             Restrictions: The value must be a valid MIME type. 
             Requirements: This attribute is optional. 
 
     Restrictions: The value must be a URI. 
     Requirements: This element may appear zero, one, or more times. 
 
 Examples:
 
  <Image height="16" width="16" type="image/x-icon">http://example.com/favicon.ico</Image>
  
  <Image height="64" width="64" type="image/png">http://example.com/websearch.png</Image>
 

Field Summary

protected java.math.BigInteger	height
protected java.lang.String	type
protected java.lang.String	value
protected java.math.BigInteger	width

Constructor Summary

OpenSearchImage()
Default Constructor

Method Summary

java.math.BigInteger	getHeight() Gets the value of the height property.
java.lang.String	getType() Gets the value of the type property.
java.lang.String	getValue() Gets the value of the value property.
java.math.BigInteger	getWidth() Gets the value of the width property.
void	setHeight(java.math.BigInteger value) Sets the value of the height property.
void	setType(java.lang.String value) Sets the value of the type property.
void	setValue(java.lang.String value) Sets the value of the value property.
void	setWidth(java.math.BigInteger value) Sets the value of the width property.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected java.lang.String value

height

protected java.math.BigInteger height

width

protected java.math.BigInteger width

type

protected java.lang.String type

Constructor Detail

OpenSearchImage

public OpenSearchImage()

Default Constructor

Method Detail

getValue

public java.lang.String getValue()

Gets the value of the value property.

Returns:

possible object is String

setValue

public void setValue(java.lang.String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

getHeight

public java.math.BigInteger getHeight()

Gets the value of the height property.

Returns:

possible object is BigInteger

setHeight

public void setHeight(java.math.BigInteger value)

Sets the value of the height property.

Parameters:

value - allowed object is BigInteger

getWidth

public java.math.BigInteger getWidth()

Gets the value of the width property.

Returns:

possible object is BigInteger

setWidth

public void setWidth(java.math.BigInteger value)

Sets the value of the width property.

Parameters:

value - allowed object is BigInteger

getType

public java.lang.String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

public void setType(java.lang.String value)

Sets the value of the type property.

Parameters:

value - allowed object is String