com.jalios.util
Class RssChannel

java.lang.Object
  extended by com.jalios.util.RssChannel

public class RssChannel
extends Object

This class implements a RSS Channel parser/container.

Version:
$Revision: 28652 $

Field Summary
static String REVISION
           
 
Constructor Summary
RssChannel(File file)
          Create a new RssChannel.
RssChannel(File file, List<RssEventListener> eventListeners)
          Create a new RssChannel.
RssChannel(String url, long ufreq)
          Create a new RssChannel.
RssChannel(String url, long ufreq, int timeout)
          Create a new RssChannel.
RssChannel(String url, long ufreq, int timeout, List<RssEventListener> eventListeners)
          Create a new RssChannel.
RssChannel(String url, long ufreq, List<RssEventListener> eventListeners)
          Create a new RssChannel.
 
Method Summary
 void addListener(RssEventListener listener)
          Add RssEventListener
 void addListeners(List<RssEventListener> listeners)
          Add RssEventListener list to existing listeners
static Date convertDate(String date)
           
static String generateID(String id, int maxLength)
          compute a id from parameter.
 Date getBuildDate()
           
 String getCopyright()
          Get the value of copyright.
 String getDescription()
          Get the value of description.
 String getDocs()
          Get the value of docs.
 String getId()
           
 String getImageDescription()
          Get the value of imageDescription.
 int getImageHeight()
          Get the value of imageHeight.
 String getImageLink()
          Get the value of imageLink.
 String getImageTitle()
          Get the value of imageTitle.
 String getImageUrl()
          Get the value of imageUrl.
 int getImageWidth()
          Get the value of imageWidth.
 List<RssItem> getItemList()
          Retrieve the list of RssItem of this feed.
 String getLanguage()
          Get the value of language.
 String getLastBuildDate()
          Deprecated.  
 Date getLastUpdate()
          Retrieve the Date at which this RssChannel was last build and parsed.
 String getLink()
          Get the value of link.
 List<RssEventListener> getListeners()
          returns the RssEventListener list
 String getManagingEditor()
          Get the value of managingEditor.
 Date getNextUpdate()
          Retrieve the Date at which this RssChannel should be left and parsed again.
 String getPubDate()
          Deprecated.  
 Date getPublicationDate()
           
 String getRating()
          Get the value of rating.
 String getSource()
          Retrieve the source of this RssChannel (used only for debugging purpose).
 String getTextinputDescription()
          Get the value of textinputDescription.
 String getTextinputLink()
          Get the value of textinputLink.
 String getTextinputName()
          Get the value of textinputName.
 String getTextinputTitle()
          Get the value of textinputTitle.
 String getTitle()
          Retrieve the title of this RSS.
 long getTtl()
          Retrieve the number of minutes indicating how long this channel can be cached before being refreshed from the source.
 long getUfreq()
          Retrieve the update frequency of this RssChannel.
 String getVersion()
          Retrieve the RSS version of this channel (such as 0.91, 1.0 for rdf, 2.0, ...).
 String getWebMaster()
          Get the value of webMaster.
 boolean needToRefresh()
          Determine if the channel must be refreshed
 void removeListener(RssEventListener listener)
          Remove RssEventListener from existing listener
 void removeListeners(List<RssEventListener> listeners)
          Remove RssEventListener from listener list
 void setBuildDate(Date buildDate)
           
 void setCopyright(String v)
          Set the value of copyright.
 void setDescription(String v)
          Set the value of description.
 void setDocs(String v)
          Set the value of docs.
 void setId(String id)
           
 void setImageDescription(String v)
          Set the value of imageDescription.
 void setImageHeight(int v)
          Set the value of imageHeight.
 void setImageHeightStr(String heightStr)
          Set the value of imageHeight.
 void setImageLink(String val)
          Set the value of imageLink.
 void setImageTitle(String v)
          Set the value of imageTitle.
 void setImageUrl(String v)
          Set the value of imageUrl.
 void setImageWidth(int v)
          Set the value of imageWidth.
 void setImageWidthStr(String widthStr)
          Set the value of imageWidth.
 void setItemList(List<RssItem> list)
          Set the list of RssItem of this feed.
 void setLanguage(String v)
          Set the value of language.
 void setLastBuildDate(String v)
          Deprecated.  
 void setLink(String v)
          Set the value of link.
 void setListeners(List<RssEventListener> listeners)
           
 void setManagingEditor(String v)
          Set the value of managingEditor.
 void setPubDate(String v)
          Deprecated.  
 void setPublicationDate(Date publicationDate)
           
 void setRating(String v)
          Set the value of rating.
 void setTextinputDescription(String v)
          Set the value of textinputDescription.
 void setTextinputLink(String v)
          Set the value of textinputLink.
 void setTextinputName(String v)
          Set the value of textinputName.
 void setTextinputTitle(String v)
          Set the value of textinputTitle.
 void setTitle(String title)
          Set the title of this RSS.
 void setTtl(long ttl)
          Set the time to live of this RssChannel
 void setTtl(String ttlStr)
          Set the time to live of this RssChannel
 void setUfreq(long ufreq)
          Set the update frequency of this RssChannel.
 void setVersion(String version)
          Set the RSS version of this channel.
 void setWebMaster(String v)
          Set the value of webMaster.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values
Constructor Detail

RssChannel

public RssChannel(String url,
                  long ufreq)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
url - the URL of the RSS channel (a remote location using http or https)
ufreq - the update frequency, in minutes
Throws:
RssException - if an error occured while getting or parsing the RSS

RssChannel

public RssChannel(String url,
                  long ufreq,
                  int timeout)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
url - the URL of the RSS channel (a remote location using http or https)
ufreq - the update frequency, in minutes
timeout - the time (in milliseconds) to wait for a connection to become available. Default value is 3000 (3 seconds). Default value will be used if zero or a negative value is specified.
Throws:
RssException - if an error occured while getting or parsing the RSS

RssChannel

public RssChannel(File file)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
file - the RSS XML file to read
Throws:
RssException - if an error occured while reading or parsing the RSS

RssChannel

public RssChannel(String url,
                  long ufreq,
                  List<RssEventListener> eventListeners)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
url - the URL of the RSS channel (a remote location using http or https)
ufreq - the update frequency, in minutes
eventListeners - list of RssEventListener
Throws:
RssException - if an error occured while getting or parsing the RSS
Since:
JCMS 6.3

RssChannel

public RssChannel(String url,
                  long ufreq,
                  int timeout,
                  List<RssEventListener> eventListeners)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
url - the URL of the RSS channel (a remote location using http or https)
ufreq - the update frequency, in minutes
timeout - the time (in milliseconds) to wait for a connection to become available. Default value is 3000 (3 seconds). Default value will be used if zero or a negative value is specified.
eventListeners - list of RssEventListener
Throws:
RssException - if an error occured while getting or parsing the RSS
Since:
JCMS 6.3

RssChannel

public RssChannel(File file,
                  List<RssEventListener> eventListeners)
           throws RssException
Create a new RssChannel. Fill this object with the data located at the given URI. Set the update frequency.

Parameters:
file - the RSS XML file to read
eventListeners - list of RssEventListener
Throws:
RssException - if an error occured while reading or parsing the RSS
Since:
JCMS 6.3
Method Detail

needToRefresh

public boolean needToRefresh()
Determine if the channel must be refreshed

Returns:
true if the channel must be refreshed

getLastUpdate

public Date getLastUpdate()
Retrieve the Date at which this RssChannel was last build and parsed.

Returns:
the last update Date.

getNextUpdate

public Date getNextUpdate()
Retrieve the Date at which this RssChannel should be left and parsed again.

Returns:
the next update Date == last update + (ttl || ufreq).

toString

public String toString()
Overrides:
toString in class Object

getVersion

public String getVersion()
Retrieve the RSS version of this channel (such as 0.91, 1.0 for rdf, 2.0, ...).

Returns:
the rss version.

setVersion

public void setVersion(String version)
Set the RSS version of this channel.

Parameters:
version - the rss version (such as 0.91, 1.0 for rdf, 2.0, ...)

getTitle

public String getTitle()
Retrieve the title of this RSS.

Returns:
the rss' title.

setTitle

public void setTitle(String title)
Set the title of this RSS.

Parameters:
title - the new title value

getLink

public String getLink()
Get the value of link.

Returns:
Value of link.

setLink

public void setLink(String v)
Set the value of link.

Parameters:
v - Value to assign to link.

getDescription

public String getDescription()
Get the value of description.

Returns:
Value of description.

setDescription

public void setDescription(String v)
Set the value of description.

Parameters:
v - Value to assign to description.

getRating

public String getRating()
Get the value of rating.

Returns:
Value of rating.

setRating

public void setRating(String v)
Set the value of rating.

Parameters:
v - Value to assign to rating.

getLanguage

public String getLanguage()
Get the value of language.

Returns:
Value of language.

setLanguage

public void setLanguage(String v)
Set the value of language.

Parameters:
v - Value to assign to language.

getCopyright

public String getCopyright()
Get the value of copyright.

Returns:
Value of copyright.

setCopyright

public void setCopyright(String v)
Set the value of copyright.

Parameters:
v - Value to assign to copyright.

getManagingEditor

public String getManagingEditor()
Get the value of managingEditor.

Returns:
Value of managingEditor.

setManagingEditor

public void setManagingEditor(String v)
Set the value of managingEditor.

Parameters:
v - Value to assign to managingEditor.

getWebMaster

public String getWebMaster()
Get the value of webMaster.

Returns:
Value of webMaster.

setWebMaster

public void setWebMaster(String v)
Set the value of webMaster.

Parameters:
v - Value to assign to webMaster.

getImageTitle

public String getImageTitle()
Get the value of imageTitle.

Returns:
Value of imageTitle.

setImageTitle

public void setImageTitle(String v)
Set the value of imageTitle.

Parameters:
v - Value to assign to imageTitle.

getImageUrl

public String getImageUrl()
Get the value of imageUrl.

Returns:
Value of imageUrl.

setImageUrl

public void setImageUrl(String v)
Set the value of imageUrl.

Parameters:
v - Value to assign to imageUrl.

getImageLink

public String getImageLink()
Get the value of imageLink.

Returns:
Value of imageLink.

setImageLink

public void setImageLink(String val)
Set the value of imageLink.

Parameters:
val - Value to assign to imageLink.

setImageWidthStr

public void setImageWidthStr(String widthStr)
Set the value of imageWidth.

Parameters:
widthStr - Value to assign to imageWidth.

getImageWidth

public int getImageWidth()
Get the value of imageWidth.

Returns:
Value of imageWidth.

setImageWidth

public void setImageWidth(int v)
Set the value of imageWidth.

Parameters:
v - Value to assign to imageWidth.

setImageHeightStr

public void setImageHeightStr(String heightStr)
Set the value of imageHeight.

Parameters:
heightStr - Value to assign to imageHeight.

getImageHeight

public int getImageHeight()
Get the value of imageHeight.

Returns:
Value of imageHeight.

setImageHeight

public void setImageHeight(int v)
Set the value of imageHeight.

Parameters:
v - Value to assign to imageHeight.

getImageDescription

public String getImageDescription()
Get the value of imageDescription.

Returns:
Value of imageDescription.

setImageDescription

public void setImageDescription(String v)
Set the value of imageDescription.

Parameters:
v - Value to assign to imageDescription.

getTextinputTitle

public String getTextinputTitle()
Get the value of textinputTitle.

Returns:
Value of textinputTitle.

setTextinputTitle

public void setTextinputTitle(String v)
Set the value of textinputTitle.

Parameters:
v - Value to assign to textinputTitle.

getTextinputDescription

public String getTextinputDescription()
Get the value of textinputDescription.

Returns:
Value of textinputDescription.

setTextinputDescription

public void setTextinputDescription(String v)
Set the value of textinputDescription.

Parameters:
v - Value to assign to textinputDescription.

getTextinputName

public String getTextinputName()
Get the value of textinputName.

Returns:
Value of textinputName.

setTextinputName

public void setTextinputName(String v)
Set the value of textinputName.

Parameters:
v - Value to assign to textinputName.

getTextinputLink

public String getTextinputLink()
Get the value of textinputLink.

Returns:
Value of textinputLink.

setTextinputLink

public void setTextinputLink(String v)
Set the value of textinputLink.

Parameters:
v - Value to assign to textinputLink.

getPubDate

@Deprecated
public String getPubDate()
Deprecated. 

Get the value of pubDate. This method is deprecated. getPublicationDate must be use instead This method returns date in ISO 8601 format

Returns:
Value of pubDate.

setPubDate

@Deprecated
public void setPubDate(String v)
Deprecated. 

Set the value of pubDate. This methos is deprecated and setPublication(Date date) must be use instead

Parameters:
v - Value to assign to pubDate.

getLastBuildDate

@Deprecated
public String getLastBuildDate()
Deprecated. 

Get the value of lastBuildDate.This method is deprecated. getBuildDate must be use instead This method returns date in ISO 8601 format

Returns:
Value of lastBuildDate.

setLastBuildDate

@Deprecated
public void setLastBuildDate(String v)
Deprecated. 

Set the value of lastBuildDate. This methos is deprecated and setBuildDate(Date date) must be use instead

Parameters:
v - Value to assign to lastBuildDate.

getBuildDate

public Date getBuildDate()
Returns:
the buildDate

setBuildDate

public void setBuildDate(Date buildDate)
Parameters:
buildDate - the buildDate to set

getDocs

public String getDocs()
Get the value of docs.

Returns:
Value of docs.

setDocs

public void setDocs(String v)
Set the value of docs.

Parameters:
v - Value to assign to docs.

getItemList

public List<RssItem> getItemList()
Retrieve the list of RssItem of this feed.

Returns:
a list of RssItem, never return null.

setItemList

public void setItemList(List<RssItem> list)
Set the list of RssItem of this feed.

Parameters:
list - a list list of RssItem, must not be null

getTtl

public long getTtl()
Retrieve the number of minutes indicating how long this channel can be cached before being refreshed from the source.

Returns:
the "time to live" in minutes.

setTtl

public void setTtl(long ttl)
Set the time to live of this RssChannel

Parameters:
ttl - time to live in minutes.

setTtl

public void setTtl(String ttlStr)
Set the time to live of this RssChannel

Parameters:
ttlStr - time to live in minutes.

getUfreq

public long getUfreq()
Retrieve the update frequency of this RssChannel.

Returns:
the update frequency in minutes.

setUfreq

public void setUfreq(long ufreq)
Set the update frequency of this RssChannel.

Parameters:
ufreq - the new update frequency value, in minutes.

getSource

public String getSource()
Retrieve the source of this RssChannel (used only for debugging purpose).


getPublicationDate

public Date getPublicationDate()
Returns:
the publicationDate

setPublicationDate

public void setPublicationDate(Date publicationDate)
Parameters:
publicationDate - the publicationDate to set

getId

public String getId()
Returns:
the id

setId

public void setId(String id)
Parameters:
id - the id to set

convertDate

public static Date convertDate(String date)

getListeners

public List<RssEventListener> getListeners()
returns the RssEventListener list

Returns:
the list
Since:
JCMS 6.3

setListeners

public void setListeners(List<RssEventListener> listeners)
Parameters:
listeners - the RssEventListener list to set
Since:
JCMS 6.3

addListeners

public void addListeners(List<RssEventListener> listeners)
Add RssEventListener list to existing listeners

Parameters:
listeners - the list
Since:
JCMS 6.3

removeListeners

public void removeListeners(List<RssEventListener> listeners)
Remove RssEventListener from listener list

Parameters:
listeners - the RssEventListener to remove
Since:
JCMS 6.3

addListener

public void addListener(RssEventListener listener)
Add RssEventListener

Parameters:
listener - the RssEventListener
Since:
JCMS 6.3

removeListener

public void removeListener(RssEventListener listener)
Remove RssEventListener from existing listener

Parameters:
listener - the RssEventListener
Since:
JCMS 6.3

generateID

public static String generateID(String id,
                                int maxLength)
compute a id from parameter. If the id length is less than maxLength parameter, the id is returned. Else the id is truncated and an MD5sum of id is added to the length of the string

Parameters:
id - the string which should be an id
maxLength - the max length of the id
Returns:
the computed id


Copyright © 2001-2010 Jalios SA. All Rights Reserved.