yarfraw.core.datamodel
Class Generator

java.lang.Object
  yarfraw.core.datamodel.Generator

All Implemented Interfaces:

Serializable

public class Generator
extends Object

Rss 1.0 - Not supported, this is ignored.

Rss 2.0 - <generator> A string indicating the program used to generate the channel.

Atom 1.0 - <generator> The "atom:generator" element's content identifies the agent used to generate a feed, for debugging and other purposes.

Author:

jliang

See Also:

Serialized Form

Field Summary

protected String	_about
protected String	_base
protected String	_lang
protected Map<QName,String>	_otherAttributes
protected List<Element>	_otherElements
protected String	_resource

Constructor Summary

Generator(String generatorValue)

Method Summary

Generator	addOtherAttributes(QName namespace, String attribute) Add an attribute that is not in the RSS 2.0 specs.
boolean	equals(Object other)
String	getAbout() This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput).
String	getAttributeValueByLocalName(String localName) Search for attributes that are not in the spec by its local name.
String	getAttributeValueByQName(QName name) Search for attributes that are not in the spec by its QName.
String	getBase() This maps to the 'base' attribute that is common in all Atom 1.0 elements.
Element	getElementByLocalName(String localName) Search through the other element list and return the FIRST element that matches the input localName.
Element	getElementByNS(String namespaceURI, String localName) Search through the other element list and return the first element that matches both input the namespaceURI and the localName.
String	getLang() The language attribute indicates the language that is used by the enclosed element.
Locale	getLangAsLocale() The language attribute indicates the language that is used by the enclosed element.
Map<QName,String>	getOtherAttributes() Any other attribute that is not in the RSS specs.
List<Element>	getOtherElements() Other additional elements that are not in the Rss specs.
String	getResource() This maps to the optional 'resource' attribute that present in some Rss 1.0 elements.
String	getUri() Rss 1.0 - Not supported. Rss 2.0 - - Not supported.
String	getValue() Rss 1.0 - Not supported. Rss 2.0 - the text content of the <generator> Atom 1.0 - The content of this element, when present, MUST be a string that is a human-readable name for the generating agent.
String	getVersion() Rss 1.0 - Not supported. Rss 2.0 - - Not supported.
int	hashCode()
Generator	setBase(String base) Atom 1.0 only Any element defined by this specification MAY have an xml:base attribute [W3C.REC-xmlbase-20010627].
Generator	setLang(Locale lang) Rss 2.0 - <language> element.
Generator	setLang(String lang) Rss 2.0 - <language> element.
Generator	setOtherAttributes(Map<QName,String> otherAttributes) Any other attribute that is not in the RSS 2.0 specs.
Generator	setUri(String uri) Rss 1.0 - Not supported. Rss 2.0 - - Not supported.
Generator	setValue(String value) Rss 1.0 - Not supported. Rss 2.0 - the text content of the <generator> Atom 1.0 - The content of this element, when present, MUST be a string that is a human-readable name for the generating agent.
Generator	setVersion(String version) Rss 1.0 - Not supported. Rss 2.0 - - Not supported.
String	toString()
void	validate(FeedFormat format)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_base

protected String _base

_lang

protected String _lang

_resource

protected String _resource

_about

protected String _about

_otherAttributes

protected Map<QName,String> _otherAttributes

_otherElements

protected List<Element> _otherElements

Constructor Detail

Generator

public Generator(String generatorValue)

Method Detail

getValue

public String getValue()

Rss 1.0 - Not supported.

Rss 2.0 - the text content of the <generator>

Atom 1.0 - The content of this element, when present, MUST be a string that is a human-readable name for the generating agent. The escaped versions of characters such as "&" and ">" represent those characters, not markup.

Returns:

setValue

public Generator setValue(String value)

Rss 1.0 - Not supported.

Rss 2.0 - the text content of the <generator>

Atom 1.0 - The content of this element, when present, MUST be a string that is a human-readable name for the generating agent. The escaped versions of characters such as "&" and ">" represent those characters, not markup.

Parameters:

value -

getUri

public String getUri()

Rss 1.0 - Not supported.

Rss 2.0 - - Not supported.

Atom 1.0 - The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987]. When dereferenced, the resulting URI (mapped from an IRI, if necessary) SHOULD produce a representation that is relevant to that agent.

Returns:

setUri

public Generator setUri(String uri)

Rss 1.0 - Not supported.

Rss 2.0 - - Not supported.

Atom 1.0 - The atom:generator element MAY have a "uri" attribute whose value MUST be an IRI reference [RFC3987]. When dereferenced, the resulting URI (mapped from an IRI, if necessary) SHOULD produce a representation that is relevant to that agent.

Parameters:

uri -

Returns:

getVersion

public String getVersion()

Rss 1.0 - Not supported.

Rss 2.0 - - Not supported.

Atom 1.0 - The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.

Returns:

setVersion

public Generator setVersion(String version)

Rss 1.0 - Not supported.

Rss 2.0 - - Not supported.

Atom 1.0 - The atom:generator element MAY have a "version" attribute that indicates the version of the generating agent.

Parameters:

version -

setOtherAttributes

public Generator setOtherAttributes(Map<QName,String> otherAttributes)

Any other attribute that is not in the RSS 2.0 specs.

addOtherAttributes

public Generator addOtherAttributes(QName namespace,
                                    String attribute)

Add an attribute that is not in the RSS 2.0 specs.

setBase

public Generator setBase(String base)

Atom 1.0 only
Any element defined by this specification MAY have an xml:base attribute [W3C.REC-xmlbase-20010627]. When xml:base is used in an Atom Document, it serves the function described in section 5.1.1 of [RFC3986], establishing the base URI (or IRI) for resolving any relative references found within the effective scope of the xml:base attribute.

Parameters:

base -

Returns:

setLang

public Generator setLang(String lang)

Rss 2.0 - <language> element. The language the channel is written in. This allows aggregators to group all Italian language sites, for example, on a single page. A list of allowable values for this element, as provided by Netscape, is here. You may also use values defined by the W3C. Only <channel> support this element.

Rss 1.0 - <dc:language> element. A language of the intellectual content of the resource. Only <channel> and <item> support this element.

Atom 1.0 - 'lang' attribute

Note: for Rss 2.0 and Rss 1.0, only <channel> and <item>

Parameters:

lang -

Returns:

setLang

public Generator setLang(Locale lang)

Rss 2.0 - <language> element. The language the channel is written in. This allows aggregators to group all Italian language sites, for example, on a single page. A list of allowable values for this element, as provided by Netscape, is here. You may also use values defined by the W3C. Only <channel> support this element.

Rss 1.0 - <dc:language> element. A language of the intellectual content of the resource. Only <channel> and <item> support this element.

Atom 1.0 - 'lang' attribute

Note: for Rss 2.0 and Rss 1.0, only <channel> and <item>

Parameters:

lang -

Returns:

validate

public void validate(FeedFormat format)
              throws ValidationException

Throws:

ValidationException

getBase

public String getBase()

This maps to the 'base' attribute that is common in all Atom 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getLang

public String getLang()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- attribute value.

getLangAsLocale

public Locale getLangAsLocale()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- a new Locale Object by parsing the lang attribute.

getResource

public String getResource()

This maps to the optional 'resource' attribute that present in some Rss 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getAbout

public String getAbout()

This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput). Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getOtherElements

public List<Element> getOtherElements()

Other additional elements that are not in the Rss specs.

getElementByNS

public Element getElementByNS(String namespaceURI,
                              String localName)

Search through the other element list and return the first element that matches both input the namespaceURI and the localName.

Parameters:

namespaceURI - - namespaceURI of the element to be search for

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getElementByLocalName

public Element getElementByLocalName(String localName)

Search through the other element list and return the FIRST element that matches the input localName.

Parameters:

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Any other attribute that is not in the RSS specs.

getAttributeValueByLocalName

public String getAttributeValueByLocalName(String localName)

Search for attributes that are not in the spec by its local name.

Parameters:

localName - localName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

getAttributeValueByQName

public String getAttributeValueByQName(QName name)

Search for attributes that are not in the spec by its QName.

Parameters:

name - QName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object