info.magnolia.module.rssaggregator.generator

Class AbstractSyndFeedGenerator

java.lang.Object

info.magnolia.module.rssaggregator.generator.AbstractSyndFeedGenerator

All Implemented Interfaces:

FeedGenerator

Direct Known Subclasses:

PageSyndicator, PlanetFeedGenerator, RSSModuleFeedGenerator

public abstract class AbstractSyndFeedGenerator
extends Object
implements FeedGenerator

Convenience base class providing plumbing required for generating a Feed from a SyndFeed. The generated feed will by default be of type RSSAggregator.DEFAULT_FEEDTYPE. Subclasses need implement the template methods loadFeedEntries() and setFeedInfo(SyndFeed) to have a Feed generated.

See Also:

FeedGenerator, SyndFeed, Feed

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME_ABSTRACT
static String	PROPERTY_NAME_AUTHOR
static String	PROPERTY_NAME_CATEGORIES
static String	PROPERTY_NAME_DESCRIPTION
static String	PROPERTY_NAME_PUB_DATE
static String	PROPERTY_NAME_TITLE

Constructor Summary

Constructors

Constructor and Description
AbstractSyndFeedGenerator()

Method Summary

Modifier and Type	Method and Description
Feed	generate() Generate a SyndFeed.
abstract List<com.rometools.rome.feed.synd.SyndEntry>	loadFeedEntries() Template method for subclasses to implement in order to provide the feed entries to include in the Feed to generate.
protected com.rometools.rome.feed.synd.SyndFeedImpl	newSyndFeed() Construct a new SyndFeed instance.
abstract void	setFeedInfo(com.rometools.rome.feed.synd.SyndFeed feed) Template method for subclasses are to override in order to set appropriate Feed meta data.
protected String	syndFeedToXml(com.rometools.rome.feed.synd.SyndFeed feed)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_TITLE

public static final String PROPERTY_NAME_TITLE

See Also:

Constant Field Values

PROPERTY_NAME_DESCRIPTION

public static final String PROPERTY_NAME_DESCRIPTION

See Also:

Constant Field Values

PROPERTY_NAME_AUTHOR

public static final String PROPERTY_NAME_AUTHOR

See Also:

Constant Field Values

PROPERTY_NAME_PUB_DATE

public static final String PROPERTY_NAME_PUB_DATE

See Also:

Constant Field Values

PROPERTY_NAME_ABSTRACT

public static final String PROPERTY_NAME_ABSTRACT

See Also:

Constant Field Values

PROPERTY_NAME_CATEGORIES

public static final String PROPERTY_NAME_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

AbstractSyndFeedGenerator

public AbstractSyndFeedGenerator()

Method Detail

generate

public Feed generate()
              throws FeedGenerationException

Generate a SyndFeed.

Specified by:

generate in interface FeedGenerator

Returns:

the generated SyndFeed

Throws:

FeedGenerationException - when an exception occurs while generating the aggregate feed

syndFeedToXml

protected String syndFeedToXml(com.rometools.rome.feed.synd.SyndFeed feed)
                        throws com.rometools.rome.io.FeedException

Throws:

com.rometools.rome.io.FeedException

newSyndFeed

protected com.rometools.rome.feed.synd.SyndFeedImpl newSyndFeed()

Construct a new SyndFeed instance.

Returns:

the new SyndFeed instance

loadFeedEntries

public abstract List<com.rometools.rome.feed.synd.SyndEntry> loadFeedEntries()

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

Returns:

the feed entries to include in the Feed to generate

setFeedInfo

public abstract void setFeedInfo(com.rometools.rome.feed.synd.SyndFeed feed)

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.

Parameters:

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