org.apache.commons.digester.rss
Class Channel

java.lang.Object
  extended by org.apache.commons.digester.rss.Channel
All Implemented Interfaces:
java.io.Serializable

public class Channel
extends java.lang.Object
implements java.io.Serializable

Implementation object representing a channel in the Rich Site Summary DTD, version 0.91. This class may be subclassed to further specialize its behavior.

See Also:
Serialized Form

Field Summary
protected  java.lang.String copyright
          The channel copyright (1-100 characters).
protected  java.lang.String description
          The channel description (1-500 characters).
protected  java.lang.String docs
          The channel description file URL (1-500 characters).
protected  Image image
          The image describing this channel.
protected  java.util.ArrayList items
          The set of items associated with this Channel.
protected  java.lang.String language
          The channel language (2-5 characters).
protected  java.lang.String lastBuildDate
          The channel last build date (1-100 characters).
protected  java.lang.String link
          The channel link (1-500 characters).
protected  java.lang.String managingEditor
          The managing editor (1-100 characters).
protected  java.lang.String pubDate
          The channel publication date (1-100 characters).
protected  java.lang.String rating
          The channel rating (20-500 characters).
protected  java.util.ArrayList skipDays
          The set of skip days for this channel.
protected  java.util.ArrayList skipHours
          The set of skip hours for this channel.
protected  TextInput textInput
          The text input description for this channel.
protected  java.lang.String title
          The channel title (1-100 characters).
protected  double version
          The RSS specification version number used to create this Channel.
protected  java.lang.String webMaster
          The webmaster email address (1-100 characters).
 
Constructor Summary
Channel()
           
 
Method Summary
 void addItem(Item item)
          Add an additional item.
 void addSkipDay(java.lang.String skipDay)
          Add an additional skip day name.
 void addSkipHour(java.lang.String skipHour)
          Add an additional skip hour name.
 Item[] findItems()
          Return the items for this channel.
 java.lang.String[] findSkipDays()
          Return the skip days for this channel.
 java.lang.String[] findSkipHours()
          Return the skip hours for this channel.
 java.lang.String getCopyright()
           
 java.lang.String getDescription()
           
 java.lang.String getDocs()
           
 Image getImage()
           
 Item[] getItems()
          Return the items for this channel.
 java.lang.String getLanguage()
           
 java.lang.String getLastBuildDate()
           
 java.lang.String getLink()
           
 java.lang.String getManagingEditor()
           
 java.lang.String getPubDate()
           
 java.lang.String getRating()
           
 java.lang.String[] getSkipDays()
          Return the skip days for this channel.
 java.lang.String[] getSkipHours()
          Return the skip hours for this channel.
 TextInput getTextInput()
           
 java.lang.String getTitle()
           
 double getVersion()
           
 java.lang.String getWebMaster()
           
 void removeItem(Item item)
          Remove an item for this channel.
 void removeSkipDay(java.lang.String skipDay)
          Remove a skip day for this channel.
 void removeSkipHour(java.lang.String skipHour)
          Remove a skip hour for this channel.
 void render(java.io.OutputStream stream)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified output stream, with no indication of character encoding.
 void render(java.io.OutputStream stream, java.lang.String encoding)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified output stream, with the specified character encoding.
 void render(java.io.PrintWriter writer)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, with no indication of character encoding.
 void render(java.io.PrintWriter writer, java.lang.String encoding)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, indicating the specified character encoding.
 void render(java.io.Writer writer)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, with no indication of character encoding.
 void render(java.io.Writer writer, java.lang.String encoding)
          Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, indicating the specified character encoding.
 void setCopyright(java.lang.String copyright)
           
 void setDescription(java.lang.String description)
           
 void setDocs(java.lang.String docs)
           
 void setImage(Image image)
           
 void setLanguage(java.lang.String language)
           
 void setLastBuildDate(java.lang.String lastBuildDate)
           
 void setLink(java.lang.String link)
           
 void setManagingEditor(java.lang.String managingEditor)
           
 void setPubDate(java.lang.String pubDate)
           
 void setRating(java.lang.String rating)
           
 void setTextInput(TextInput textInput)
           
 void setTitle(java.lang.String title)
           
 void setVersion(double version)
           
 void setWebMaster(java.lang.String webMaster)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

items

protected java.util.ArrayList items
The set of items associated with this Channel.


skipDays

protected java.util.ArrayList skipDays
The set of skip days for this channel.


skipHours

protected java.util.ArrayList skipHours
The set of skip hours for this channel.


copyright

protected java.lang.String copyright
The channel copyright (1-100 characters).


description

protected java.lang.String description
The channel description (1-500 characters).


docs

protected java.lang.String docs
The channel description file URL (1-500 characters).


image

protected Image image
The image describing this channel.


language

protected java.lang.String language
The channel language (2-5 characters).


lastBuildDate

protected java.lang.String lastBuildDate
The channel last build date (1-100 characters).


link

protected java.lang.String link
The channel link (1-500 characters).


managingEditor

protected java.lang.String managingEditor
The managing editor (1-100 characters).


pubDate

protected java.lang.String pubDate
The channel publication date (1-100 characters).


rating

protected java.lang.String rating
The channel rating (20-500 characters).


textInput

protected TextInput textInput
The text input description for this channel.


title

protected java.lang.String title
The channel title (1-100 characters).


version

protected double version
The RSS specification version number used to create this Channel.


webMaster

protected java.lang.String webMaster
The webmaster email address (1-100 characters).

Constructor Detail

Channel

public Channel()
Method Detail

getCopyright

public java.lang.String getCopyright()

setCopyright

public void setCopyright(java.lang.String copyright)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getDocs

public java.lang.String getDocs()

setDocs

public void setDocs(java.lang.String docs)

getImage

public Image getImage()

setImage

public void setImage(Image image)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getLastBuildDate

public java.lang.String getLastBuildDate()

setLastBuildDate

public void setLastBuildDate(java.lang.String lastBuildDate)

getLink

public java.lang.String getLink()

setLink

public void setLink(java.lang.String link)

getManagingEditor

public java.lang.String getManagingEditor()

setManagingEditor

public void setManagingEditor(java.lang.String managingEditor)

getPubDate

public java.lang.String getPubDate()

setPubDate

public void setPubDate(java.lang.String pubDate)

getRating

public java.lang.String getRating()

setRating

public void setRating(java.lang.String rating)

getTextInput

public TextInput getTextInput()

setTextInput

public void setTextInput(TextInput textInput)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getVersion

public double getVersion()

setVersion

public void setVersion(double version)

getWebMaster

public java.lang.String getWebMaster()

setWebMaster

public void setWebMaster(java.lang.String webMaster)

addItem

public void addItem(Item item)
Add an additional item.

Parameters:
item - The item to be added

addSkipDay

public void addSkipDay(java.lang.String skipDay)
Add an additional skip day name.

Parameters:
skipDay - The skip day to be added

addSkipHour

public void addSkipHour(java.lang.String skipHour)
Add an additional skip hour name.

Parameters:
skipHour - The skip hour to be added

findItems

public Item[] findItems()
Return the items for this channel.


getItems

public Item[] getItems()
Return the items for this channel.


findSkipDays

public java.lang.String[] findSkipDays()
Return the skip days for this channel.


getSkipHours

public java.lang.String[] getSkipHours()
Return the skip hours for this channel.


findSkipHours

public java.lang.String[] findSkipHours()
Return the skip hours for this channel.


getSkipDays

public java.lang.String[] getSkipDays()
Return the skip days for this channel.


removeItem

public void removeItem(Item item)
Remove an item for this channel.

Parameters:
item - The item to be removed

removeSkipDay

public void removeSkipDay(java.lang.String skipDay)
Remove a skip day for this channel.

Parameters:
skipDay - The skip day to be removed

removeSkipHour

public void removeSkipHour(java.lang.String skipHour)
Remove a skip hour for this channel.

Parameters:
skipHour - The skip hour to be removed

render

public void render(java.io.OutputStream stream)
Render this channel as XML conforming to the RSS 0.91 specification, to the specified output stream, with no indication of character encoding.

Parameters:
stream - The output stream to write to

render

public void render(java.io.OutputStream stream,
                   java.lang.String encoding)
            throws java.io.UnsupportedEncodingException
Render this channel as XML conforming to the RSS 0.91 specification, to the specified output stream, with the specified character encoding.

Parameters:
stream - The output stream to write to
encoding - The character encoding to declare, or null for no declaration
Throws:
java.io.UnsupportedEncodingException - if the named encoding is not supported

render

public void render(java.io.Writer writer)
Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, with no indication of character encoding.

Parameters:
writer - The writer to render output to

render

public void render(java.io.Writer writer,
                   java.lang.String encoding)
Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, indicating the specified character encoding.

Parameters:
writer - The writer to render output to
encoding - The character encoding to declare, or null for no declaration

render

public void render(java.io.PrintWriter writer)
Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, with no indication of character encoding.

Parameters:
writer - The writer to render output to

render

public void render(java.io.PrintWriter writer,
                   java.lang.String encoding)
Render this channel as XML conforming to the RSS 0.91 specification, to the specified writer, indicating the specified character encoding.

Parameters:
writer - The writer to render output to
encoding - The character encoding to declare, or null for no declaration


Copyright 2002-2008 The Apache Software Foundation. All Rights Reserved.