info.magnolia.module.rssaggregator.generator
Class RSSModuleFeedGenerator

java.lang.Object
  info.magnolia.module.rssaggregator.generator.AbstractSyndFeedGenerator
      info.magnolia.module.rssaggregator.generator.RSSModuleFeedGenerator

All Implemented Interfaces:

FeedGenerator, Cloneable

public class RSSModuleFeedGenerator
extends AbstractSyndFeedGenerator
implements Cloneable

Generates a SyndFeed based on aggregate feeds defined via the RSS Aggregator Module.

Author:

Rob van der Linden Vooren

Constructor Summary

RSSModuleFeedGenerator()
Construct a new RSSModuleSyndFeedGenerator that generates a SyndFeed for the aggregate feed defined via the RSS Aggregator Module at the given feedPath.

Method Summary

Object	clone()
List<com.sun.syndication.feed.synd.SyndEntry>	loadFeedEntries() Template method for subclasses to implement in order to provide the feed entries to include in the Feed to generate.
void	setFeedInfo(com.sun.syndication.feed.synd.SyndFeed feed) Template method for subclasses are to override in order to set appropriate Feed meta data.
void	setFeedPath(String feedPath)

Methods inherited from class info.magnolia.module.rssaggregator.generator.AbstractSyndFeedGenerator

generate, newSyndFeed, syndFeedToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

RSSModuleFeedGenerator

public RSSModuleFeedGenerator()

Construct a new RSSModuleSyndFeedGenerator that generates a SyndFeed for the aggregate feed defined via the RSS Aggregator Module at the given feedPath.

Method Detail

setFeedPath

public void setFeedPath(String feedPath)

Parameters:

feedPath - the path of the aggregate feed in the RSS Aggregator module (eg. "/rssaggregator/blogsaggregate")

setFeedInfo

public void setFeedInfo(com.sun.syndication.feed.synd.SyndFeed feed)

Description copied from class: AbstractSyndFeedGenerator

Template method for subclasses are to override in order to set appropriate Feed meta data. Typical use cases would be to set the title , link and description. The given feed will never be null.

Specified by:

setFeedInfo in class AbstractSyndFeedGenerator

Parameters:

feed - the syndication feed that is generated to set the feed meta data for

loadFeedEntries

public List<com.sun.syndication.feed.synd.SyndEntry> loadFeedEntries()

Description copied from class: AbstractSyndFeedGenerator

Template method for subclasses to implement in order to provide the feed entries to include in the Feed to generate.

Specified by:

loadFeedEntries in class AbstractSyndFeedGenerator

Returns:

the feed entries to include in the Feed to generate

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException