org.licas_text.stream

Class FeedParser

java.lang.Object

org.licas_text.EventStream

org.licas_text.stream.FeedParser

public class FeedParser
extends EventStream

Reads and parses an online rss/atom feed. Based on http://www.vogella.com/tutorials/RSSFeed/article.html.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
FeedParser(java.lang.String feedUrl) Create a new instance of FeedParser.

Method Summary

Modifier and Type	Method and Description
static org.licas_xml.abs.Element	getAtomElement(org.licas_xml.abs.Element rootElem) Get the base atom element, if maybe part of a larger document.
static org.licas_xml.abs.Element	getFeedElement(org.licas_xml.abs.Element rootElem) Get the base rss element, if maybe part of a larger document.
static org.licas_xml.abs.Element	getRssElement(org.licas_xml.abs.Element rootElem) Get the base rss element, if maybe part of a larger document.
protected static boolean	hasItems(org.licas_xml.abs.Element rootElem) Return true if the element has item child elements.
static boolean	isAuthor(java.lang.String feedTkn) Return true if the text token indicates a feed author description.
static boolean	isChannel(java.lang.String feedTkn) Return true if the text token indicates a feed channel.
static boolean	isCopyright(java.lang.String feedTkn) Return true if the text token indicates a feed copyright description.
static boolean	isDescription(java.lang.String feedTkn) Return true if the text token indicates a feed item description.
static boolean	isFeedElement(org.licas_xml.abs.Element feedElem) Return true if the root element is a feed element defined as the rss or atom type.
static boolean	isGuid(java.lang.String feedTkn) Return true if the text token indicates a feed id.
static boolean	isItem(java.lang.String feedTkn) Return true if the text token indicates a feed item.
static boolean	isLanguage(java.lang.String feedTkn) Return true if the text token indicates a feed language description.
static boolean	isLink(java.lang.String feedTkn) Return true if the text token indicates a feed link.
static boolean	isPubDate(java.lang.String feedTkn) Return true if the text token indicates a feed publication date.
static boolean	isTitle(java.lang.String feedTkn) Return true if the text token indicates a feed title.
static Feed	parseFeed(org.licas_xml.abs.Element feedElem) Parse the feed contents to create a feed.
Feed	readFeed() Read the feed contents online from the rss resource.

Methods inherited from class org.licas_text.EventStream

getStream, read

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedParser

public FeedParser(java.lang.String feedUrl)

Create a new instance of FeedParser.

Parameters:

feedUrl - the address to query.

Method Detail

readFeed

public Feed readFeed()

Read the feed contents online from the rss resource.

Returns:

the feed contents.

parseFeed

public static Feed parseFeed(org.licas_xml.abs.Element feedElem)

Parse the feed contents to create a feed. The root element should be the rss or atom element, with Item elements for each feed item.

Parameters:

feedElem - the root element to parse from.

Returns:

the feed contents.

getFeedElement

public static org.licas_xml.abs.Element getFeedElement(org.licas_xml.abs.Element rootElem)
                                                throws java.lang.Exception

Get the base rss element, if maybe part of a larger document.

Parameters:

rootElem - the root element to parse from.

Returns:

the first recognised rss base element, or null otherwise.

Throws:

java.lang.Exception - any error.

getRssElement

public static org.licas_xml.abs.Element getRssElement(org.licas_xml.abs.Element rootElem)
                                               throws java.lang.Exception

Get the base rss element, if maybe part of a larger document.

Parameters:

rootElem - the root element to parse from.

Returns:

the first recognised rss base element, or null otherwise.

Throws:

java.lang.Exception - any error.

getAtomElement

public static org.licas_xml.abs.Element getAtomElement(org.licas_xml.abs.Element rootElem)
                                                throws java.lang.Exception

Get the base atom element, if maybe part of a larger document.

Parameters:

rootElem - the root element to parse from.

Returns:

the first recognised atom base element, or null otherwise.

Throws:

java.lang.Exception - any error.

isFeedElement

public static boolean isFeedElement(org.licas_xml.abs.Element feedElem)

Return true if the root element is a feed element defined as the rss or atom type.

Parameters:

feedElem - the element to check.

Returns:

true if a base feed element.

isTitle

public static boolean isTitle(java.lang.String feedTkn)

Return true if the text token indicates a feed title.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed title.

isChannel

public static boolean isChannel(java.lang.String feedTkn)

Return true if the text token indicates a feed channel.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed channel.

hasItems

protected static boolean hasItems(org.licas_xml.abs.Element rootElem)

Return true if the element has item child elements.

Parameters:

rootElem - the root element to check to check.

Returns:

true if it has immediate child item elements.

isItem

public static boolean isItem(java.lang.String feedTkn)

Return true if the text token indicates a feed item.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed item.

isDescription

public static boolean isDescription(java.lang.String feedTkn)

Return true if the text token indicates a feed item description.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed item description.

isLink

public static boolean isLink(java.lang.String feedTkn)

Return true if the text token indicates a feed link.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed link.

isAuthor

public static boolean isAuthor(java.lang.String feedTkn)

Return true if the text token indicates a feed author description.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed author description.

isGuid

public static boolean isGuid(java.lang.String feedTkn)

Return true if the text token indicates a feed id.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed guid.

isPubDate

public static boolean isPubDate(java.lang.String feedTkn)

Return true if the text token indicates a feed publication date.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed publication date.

isCopyright

public static boolean isCopyright(java.lang.String feedTkn)

Return true if the text token indicates a feed copyright description.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed copyright description.

isLanguage

public static boolean isLanguage(java.lang.String feedTkn)

Return true if the text token indicates a feed language description.

Parameters:

feedTkn - the string token to check.

Returns:

true if it indicates a feed language description.