org.apache.wink.common.model.rss
Class RssImage

java.lang.Object
  extended by org.apache.wink.common.model.rss.RssImage

public class RssImage
extends java.lang.Object

Java class for "image" element of RSS 2.0 Specification.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="rssImage">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="url" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="title" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="link" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
         <element name="width" minOccurs="0">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               <maxInclusive value="144"/>
             </restriction>
           </simpleType>
         </element>
         <element name="height" minOccurs="0">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}int">
               <maxInclusive value="400"/>
             </restriction>
           </simpleType>
         </element>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </all>
     </restriction>
   </complexContent>
 </complexType>
 
<image> sub-element of <channel>

<image> is an optional sub-element of <channel>, which contains three required and three optional sub-elements.

<url> is the URL of a GIF, JPEG or PNG image that represents the channel.

<title> describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.

<link> is the URL of the site, when the channel is rendered, the image is a link to the site. (Note, in practice the image <title> and <link> should have the same value as the channel's <title> and <link>.)

Optional elements include <width> and <height>, numbers, indicating the width and height of the image in pixels. <description> contains text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.

Maximum value for width is 144, default value is 88.

Maximum value for height is 400, default value is 31.


Field Summary
protected  java.lang.String description
           
protected  java.lang.Integer height
           
protected  java.lang.String link
           
protected  java.lang.String title
           
protected  java.lang.String url
           
protected  java.lang.Integer width
           
 
Constructor Summary
RssImage()
           
 
Method Summary
 java.lang.String getDescription()
          Gets the value of the description property.
 java.lang.Integer getHeight()
          Gets the value of the height property.
 java.lang.String getLink()
          Gets the value of the link property.
 java.lang.String getTitle()
          Gets the value of the title property.
 java.lang.String getUrl()
          Gets the value of the url property.
 java.lang.Integer getWidth()
          Gets the value of the width property.
 void setDescription(java.lang.String value)
          Sets the value of the description property.
 void setHeight(java.lang.Integer value)
          Sets the value of the height property.
 void setLink(java.lang.String value)
          Sets the value of the link property.
 void setTitle(java.lang.String value)
          Sets the value of the title property.
 void setUrl(java.lang.String value)
          Sets the value of the url property.
 void setWidth(java.lang.Integer 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

url

protected java.lang.String url

title

protected java.lang.String title

link

protected java.lang.String link

width

protected java.lang.Integer width

height

protected java.lang.Integer height

description

protected java.lang.String description
Constructor Detail

RssImage

public RssImage()
Method Detail

getUrl

public java.lang.String getUrl()
Gets the value of the url property.

Returns:
possible object is String

setUrl

public void setUrl(java.lang.String value)
Sets the value of the url property.

Parameters:
value - allowed object is String

getTitle

public java.lang.String getTitle()
Gets the value of the title property.

Returns:
possible object is String

setTitle

public void setTitle(java.lang.String value)
Sets the value of the title property.

Parameters:
value - allowed object is String

getLink

public java.lang.String getLink()
Gets the value of the link property.

Returns:
possible object is String

setLink

public void setLink(java.lang.String value)
Sets the value of the link property.

Parameters:
value - allowed object is String

getWidth

public java.lang.Integer getWidth()
Gets the value of the width property.

Returns:
possible object is Integer

setWidth

public void setWidth(java.lang.Integer value)
Sets the value of the width property.

Parameters:
value - allowed object is Integer

getHeight

public java.lang.Integer getHeight()
Gets the value of the height property.

Returns:
possible object is Integer

setHeight

public void setHeight(java.lang.Integer value)
Sets the value of the height property.

Parameters:
value - allowed object is Integer

getDescription

public java.lang.String getDescription()
Gets the value of the description property.

Returns:
possible object is String

setDescription

public void setDescription(java.lang.String value)
Sets the value of the description property.

Parameters:
value - allowed object is String


Copyright © 2009-2010 The Apache Software Foundation. All Rights Reserved.