info.magnolia.module.rssaggregator.generator

Class PageSyndicator

java.lang.Object

info.magnolia.module.rssaggregator.generator.AbstractSyndFeedGenerator

info.magnolia.module.rssaggregator.generator.PageSyndicator

All Implemented Interfaces:

FeedGenerator, Cloneable

public class PageSyndicator
extends AbstractSyndFeedGenerator
implements Cloneable

Model class providing plumbing required for generating a Feed from a SyndFeed.

FeedGeneratorResolver will try to populate this class. Required parameters are:

• FeedGeneratorResolver.REQUIRED_PARAMETER, which would correspond to generatorName=templateContent
• templateType, e.g. templateType=content (see: info.magnolia.rendering.template.type.DefaultTemplateTypes)
• templateSubtype, e.g. templateType=news (optional, defaults to null)
• siteRoot, e.g. siteRoot=/some-path-to-a-site-root (optional, defaults to /)

See Also:

FeedSyndicationServlet, FeedGeneratorResolver, info.magnolia.rendering.template.type.DefaultTemplateTypes

Field Summary

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

PROPERTY_NAME_ABSTRACT, PROPERTY_NAME_AUTHOR, PROPERTY_NAME_CATEGORIES, PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_PUB_DATE, PROPERTY_NAME_TITLE

Constructor Summary

Constructors

Constructor and Description
PageSyndicator(info.magnolia.templating.functions.TemplatingFunctions templatingFunctions, info.magnolia.cms.beans.config.ServerConfiguration serverConfiguration)

Method Summary

Modifier and Type	Method and Description
Object	clone()
String	getSiteRoot()
String	getTemplateSubtype()
String	getTemplateType()
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.
void	setFeedInfo(com.rometools.rome.feed.synd.SyndFeed feed) Template method for subclasses are to override in order to set appropriate Feed meta data.
void	setSiteRoot(String siteRoot)
void	setTemplateSubtype(String templateSubtype)
void	setTemplateType(String templateType)

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

PageSyndicator

@Inject
public PageSyndicator(info.magnolia.templating.functions.TemplatingFunctions templatingFunctions,
                              info.magnolia.cms.beans.config.ServerConfiguration serverConfiguration)

Method Detail

loadFeedEntries

public List<com.rometools.rome.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

setFeedInfo

public void setFeedInfo(com.rometools.rome.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

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

setTemplateSubtype

public void setTemplateSubtype(String templateSubtype)

setTemplateType

public void setTemplateType(String templateType)

setSiteRoot

public void setSiteRoot(String siteRoot)

getTemplateSubtype

public String getTemplateSubtype()

getTemplateType

public String getTemplateType()

getSiteRoot

public String getSiteRoot()