org.dspace.app.util

Class SyndicationFeed

java.lang.Object

org.dspace.app.util.SyndicationFeed

public class SyndicationFeed
extends java.lang.Object

Invoke ROME library to assemble a generic model of a syndication for the given list of Items and scope. Consults configuration for the metadata bindings to feed elements. Uses ROME's output drivers to return any of the implemented formats, e.g. RSS 1.0, RSS 2.0, ATOM 1.0. The feed generator and OpenSearch call on this class so feed contents are uniform for both.

Author:

Larry Stone

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_FEED_DESCRIPTION
static java.lang.String	MSG_FEED_TITLE
static java.lang.String	MSG_LOGO_TITLE
static java.lang.String	MSG_METADATA
static java.lang.String	MSG_UITYPE
static java.lang.String	MSG_UNTITLED i18n key values
static java.lang.String	UITYPE_JSPUI
static java.lang.String	UITYPE_XMLUI

Constructor Summary

Constructors

Constructor and Description
SyndicationFeed(java.lang.String ui) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModule(com.sun.syndication.feed.module.Module m) Add a ROME plugin module (e.g.
static java.lang.String[]	getDescriptionSelectors() Returns list of metadata selectors used to compose the description element
void	output(java.io.Writer writer) send the output to designated Writer
java.lang.String	outputString()
org.w3c.dom.Document	outputW3CDom()
void	populate(javax.servlet.http.HttpServletRequest request, DSpaceObject dso, DSpaceObject[] items, java.util.Map<java.lang.String,java.lang.String> labels) Fills in the feed and entry-level metadata from DSpace objects.
void	setType(java.lang.String feedType) Sets the feed type for XML delivery, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_UNTITLED

public static final java.lang.String MSG_UNTITLED

i18n key values

See Also:

Constant Field Values

MSG_LOGO_TITLE

public static final java.lang.String MSG_LOGO_TITLE

See Also:

Constant Field Values

MSG_FEED_TITLE

public static final java.lang.String MSG_FEED_TITLE

See Also:

Constant Field Values

MSG_FEED_DESCRIPTION

public static final java.lang.String MSG_FEED_DESCRIPTION

See Also:

Constant Field Values

MSG_METADATA

public static final java.lang.String MSG_METADATA

See Also:

Constant Field Values

MSG_UITYPE

public static final java.lang.String MSG_UITYPE

See Also:

Constant Field Values

UITYPE_XMLUI

public static final java.lang.String UITYPE_XMLUI

See Also:

Constant Field Values

UITYPE_JSPUI

public static final java.lang.String UITYPE_JSPUI

See Also:

Constant Field Values

Constructor Detail

SyndicationFeed

public SyndicationFeed(java.lang.String ui)

Constructor.

Parameters:

ui - either "xmlui" or "jspui"

Method Detail

getDescriptionSelectors

public static java.lang.String[] getDescriptionSelectors()

Returns list of metadata selectors used to compose the description element

Returns:

selector list - format 'schema.element[.qualifier]'

populate

public void populate(javax.servlet.http.HttpServletRequest request,
            DSpaceObject dso,
            DSpaceObject[] items,
            java.util.Map<java.lang.String,java.lang.String> labels)

Fills in the feed and entry-level metadata from DSpace objects.

setType

public void setType(java.lang.String feedType)

Sets the feed type for XML delivery, e.g. "rss_1.0", "atom_1.0" Must match one of ROME's configured generators, see rome.properties (currently rss_1.0, rss_2.0, atom_1.0, atom_0.3)

outputW3CDom

public org.w3c.dom.Document outputW3CDom()
                                  throws com.sun.syndication.io.FeedException

Returns:

the feed we built as DOM Document

Throws:

com.sun.syndication.io.FeedException

outputString

public java.lang.String outputString()
                              throws com.sun.syndication.io.FeedException

Returns:

the feed we built as serialized XML string

Throws:

com.sun.syndication.io.FeedException

output

public void output(java.io.Writer writer)
            throws com.sun.syndication.io.FeedException,
                   java.io.IOException

send the output to designated Writer

Throws:

com.sun.syndication.io.FeedException

java.io.IOException

addModule

public void addModule(com.sun.syndication.feed.module.Module m)

Add a ROME plugin module (e.g. for OpenSearch) at the feed level.