rome 2.1.0 · com.rometools.rome.io.impl.Atom10Parser

Modifier and Type	Field and Description
pack-priv static Pattern	absoluteURIPattern
private static final Namespace	ATOM_10_NS
private static final String	ATOM_10_URI
private static boolean	resolveURIs

Access	Constructor and Description
public	Atom10Parser()
protected	Atom10Parser(final String type)

Method Summary

Modifier and Type	Method and Description
private String	findAtomLink(final Element Consider only children of this parent element parent, final String Consider only links with this relationship rel) Return URL string of Atom link element under parent element.
private String	findBaseURI(final Element Root element of feed. root) Find base URI of feed considering relative URIs.
private static String	formURI(String Base of URI, may end with trailing slash base, String String to append, may begin with slash or ".." append) Form URI by combining base with append portion and giving special consideration to append portions that begin with ".."
protected Namespace	getAtomNamespace()
public static boolean	getResolveURIs()
public static boolean	isAbsoluteURI(final String uri)
public boolean	isMyType(final Document XML Document (JDOM) to check if it can be parsed by this parser. document) Implements com.rometools.rome.io.WireFeedParser.isMyType. Inspects an XML Document (JDOM) to check if it can parse it.
public static boolean	isRelativeURI(final String uri) Returns true if URI is relative.
public WireFeed	parse(final Document XML document (JDOM) to parse. document, final boolean indicates if the feed should be strictly validated (NOT YET IMPLEMENTED). validate, final Locale locale) Implements com.rometools.rome.io.WireFeedParser.parse. Parses an XML document (JDOM Document) into a feed bean.
private List<Link>	parseAlternateLinks(final Feed feed, final Entry entry, final String baseURI, final List<Element> eLinks)
private List<Category>	parseCategories(final String baseURI, final List<Element> eCategories)
private Category	parseCategory(final String baseURI, final Element eCategory)
private Content	parseContent(final Element e)
protected List<Entry>	parseEntries(final Feed feed, final String baseURI, final List<Element> eEntries, final Locale locale)
protected Entry	parseEntry(final Feed feed, final Element eEntry, final String baseURI, final Locale locale)
public static Entry	parseEntry(final Reader rd, final String baseURI, final Locale locale) Parse entry from reader.
protected WireFeed	parseFeed(final Element eFeed, final Locale locale)
private Feed	parseFeedMetadata(final String baseURI, final Element eFeed, final Locale locale)
private Link	parseLink(final Feed feed, final Entry entry, final String baseURI, final Element eLink)
private List<Link>	parseOtherLinks(final Feed feed, final Entry entry, final String baseURI, final List<Element> eLinks)
private Person	parsePerson(final String baseURI, final Element ePerson, final Locale locale)
private List<SyndPerson>	parsePersons(final String baseURI, final List<Element> ePersons, final Locale locale)
private String	parseTextConstructToString(final Element e)
public static String	resolveURI(final String Base URI used to fetch the XML document baseURI, final Parent Parent element from which to consider xml:base parent, String URL to be resolved url) Resolve URI via base URL and parent element.
public static void	setResolveURIs(final boolean resolveURIs)
private static String	stripStartingSlash(String s) Strip starting slash from beginning of string.
private static String	stripTrailingSlash(String s) Strip trailing slash from end of string.
protected void	validateFeed(final Document document)

Inherited from com.rometools.rome.io.impl.BaseWireFeedParser:: extractForeignMarkup getAttribute getAttributeValue getStyleSheet getType parseFeedModules parseItemModules parsePersonModules

absoluteURIPattern	back to summary
pack-priv static Pattern absoluteURIPattern

ATOM_10_NS	back to summary
private static final Namespace ATOM_10_NS

ATOM_10_URI	back to summary
private static final String ATOM_10_URI

resolveURIs	back to summary
private static boolean resolveURIs

Atom10Parser	back to summary
public Atom10Parser()

Atom10Parser	back to summary
protected Atom10Parser(final String type)

Method Detail

findAtomLink	back to summary
private String findAtomLink(final Element parent, final String rel) Return URL string of Atom link element under parent element. Link with no rel attribute is considered to be rel="alternate" Parameters parent:Element Consider only children of this parent element rel:String Consider only links with this relationship

findAtomLink

back to summary

private String findAtomLink(final Element parent, final String rel)

Return URL string of Atom link element under parent element. Link with no rel attribute is considered to be rel="alternate"

Parameters

parent:Element: Consider only children of this parent element
rel:String: Consider only links with this relationship

findBaseURI	back to summary
private String findBaseURI(final Element root) throws MalformedURLException Find base URI of feed considering relative URIs. Parameters root:Element Root element of feed.

findBaseURI

back to summary

private String findBaseURI(final Element root) throws MalformedURLException

Find base URI of feed considering relative URIs.

Parameters

root:Element: Root element of feed.

formURI	back to summary
private static String formURI(String base, String append) Form URI by combining base with append portion and giving special consideration to append portions that begin with ".." Parameters base:String Base of URI, may end with trailing slash append:String String to append, may begin with slash or ".."

formURI

back to summary

private static String formURI(String base, String append)

Form URI by combining base with append portion and giving special consideration to append portions that begin with ".."

Parameters

base:String: Base of URI, may end with trailing slash
append:String: String to append, may begin with slash or ".."

getAtomNamespace	back to summary
protected Namespace getAtomNamespace()

getResolveURIs	back to summary
public static boolean getResolveURIs()

isAbsoluteURI	back to summary
public static boolean isAbsoluteURI(final String uri)

isMyType	back to summary
public boolean isMyType(final Document document) Implements com.rometools.rome.io.WireFeedParser.isMyType. Doc from com.rometools.rome.io.WireFeedParser.isMyType. Inspects an XML Document (JDOM) to check if it can parse it. It checks if the given document if the type of feeds the parser understands. Parameters document:Document XML Document (JDOM) to check if it can be parsed by this parser. Returns:boolean true if the parser know how to parser this feed, false otherwise. Annotations @Override

isMyType

back to summary

public boolean isMyType(final Document document)

Implements com.rometools.rome.io.WireFeedParser.isMyType.

Doc from com.rometools.rome.io.WireFeedParser.isMyType.

Inspects an XML Document (JDOM) to check if it can parse it.

It checks if the given document if the type of feeds the parser understands.

Parameters

document:Document: XML Document (JDOM) to check if it can be parsed by this parser.

Returns:boolean

true if the parser know how to parser this feed, false otherwise.

Annotations

@Override

isRelativeURI	back to summary
public static boolean isRelativeURI(final String uri) Returns true if URI is relative.

parse	back to summary
public WireFeed parse(final Document document, final boolean validate, final Locale locale) throws IllegalArgumentException, FeedException Implements com.rometools.rome.io.WireFeedParser.parse. Doc from com.rometools.rome.io.WireFeedParser.parse. Parses an XML document (JDOM Document) into a feed bean. Parameters document:Document XML document (JDOM) to parse. validate:boolean indicates if the feed should be strictly validated (NOT YET IMPLEMENTED). Returns:WireFeed the resulting feed bean. Annotations @Override Exceptions IllegalArgumentException: thrown if the parser cannot handle the given feed type. FeedException: thrown if a feed bean cannot be created out of the XML document (JDOM).

parse

back to summary

public WireFeed parse(final Document document, final boolean validate, final Locale locale) throws IllegalArgumentException, FeedException

Implements com.rometools.rome.io.WireFeedParser.parse.

Doc from com.rometools.rome.io.WireFeedParser.parse.

Parses an XML document (JDOM Document) into a feed bean.

Parameters

document:Document: XML document (JDOM) to parse.
validate:boolean: indicates if the feed should be strictly validated (NOT YET IMPLEMENTED).

Returns:WireFeed

the resulting feed bean.

Annotations

@Override

Exceptions

IllegalArgumentException:: thrown if the parser cannot handle the given feed type.
FeedException:: thrown if a feed bean cannot be created out of the XML document (JDOM).

parseAlternateLinks	back to summary
private List<Link> parseAlternateLinks(final Feed feed, final Entry entry, final String baseURI, final List<Element> eLinks)

parseCategories	back to summary
private List<Category> parseCategories(final String baseURI, final List<Element> eCategories)

parseCategory	back to summary
private Category parseCategory(final String baseURI, final Element eCategory)

parseContent	back to summary
private Content parseContent(final Element e)

parseEntries	back to summary
protected List<Entry> parseEntries(final Feed feed, final String baseURI, final List<Element> eEntries, final Locale locale)

parseEntry	back to summary
protected Entry parseEntry(final Feed feed, final Element eEntry, final String baseURI, final Locale locale)

parseEntry	back to summary
public static Entry parseEntry(final Reader rd, final String baseURI, final Locale locale) throws JDOMException, IOException, IllegalArgumentException, FeedException Parse entry from reader.

parseFeed	back to summary
protected WireFeed parseFeed(final Element eFeed, final Locale locale) throws FeedException

parseFeedMetadata	back to summary
private Feed parseFeedMetadata(final String baseURI, final Element eFeed, final Locale locale)

parseLink	back to summary
private Link parseLink(final Feed feed, final Entry entry, final String baseURI, final Element eLink)

parseOtherLinks	back to summary
private List<Link> parseOtherLinks(final Feed feed, final Entry entry, final String baseURI, final List<Element> eLinks)

parsePerson	back to summary
private Person parsePerson(final String baseURI, final Element ePerson, final Locale locale)

parsePersons	back to summary
private List<SyndPerson> parsePersons(final String baseURI, final List<Element> ePersons, final Locale locale)

parseTextConstructToString	back to summary
private String parseTextConstructToString(final Element e)

resolveURI	back to summary
public static String resolveURI(final String baseURI, final Parent parent, String url) Resolve URI via base URL and parent element. Resolve URI based considering xml:base and baseURI. Parameters baseURI:String Base URI used to fetch the XML document parent:Parent Parent element from which to consider xml:base url:String URL to be resolved

resolveURI

back to summary

public static String resolveURI(final String baseURI, final Parent parent, String url)

Resolve URI via base URL and parent element. Resolve URI based considering xml:base and baseURI.

Parameters

baseURI:String: Base URI used to fetch the XML document
parent:Parent: Parent element from which to consider xml:base
url:String: URL to be resolved

setResolveURIs	back to summary
public static void setResolveURIs(final boolean resolveURIs)

stripStartingSlash	back to summary
private static String stripStartingSlash(String s) Strip starting slash from beginning of string.

stripTrailingSlash	back to summary
private static String stripTrailingSlash(String s) Strip trailing slash from end of string.

validateFeed	back to summary
protected void validateFeed(final Document document) throws FeedException

public Class Atom10Parser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail