yarfraw.core.datamodel
Class Text

java.lang.Object
  yarfraw.core.datamodel.Text

All Implemented Interfaces:

Serializable

public class Text
extends Object

This class is mapped to element of type xs:string as well as to text constructs element in Atom 1.0.
Only the text content is used for Rss 1.0 and Rss 2.0, all other fields are ignored.
for information about Atom 1.0, see http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html#rfc.section.4.1.2

Author:

jliang

See Also:

Serialized Form

Nested Class Summary

static class

Text.TextType

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

Text()

Text(String text)
This constructs a Text of type 'text'

Text(Text.TextType textType)
Type of the text.

Method Summary

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	getText() The text content of this text element.
Text.TextType	getType() Type of the text.
Element	getXhtmlDiv() Atom 1.0 only The single xhtml div element if the text construct is an xhtml construct
int	hashCode()
Text	setBase(String base) Atom 1.0 only Any element defined by this specification MAY have an xml:base attribute [W3C.REC-xmlbase-20010627].
Text	setLang(Locale lang) Rss 2.0 - <language> element.
Text	setLang(String lang) Rss 2.0 - <language> element.
Text	setText(String text)
Text	setType(Text.TextType type) Type of the text.
Text	setXhtmlDiv(Element xhtmlDiv) Atom 1.0 only The single xhtml div element if the text construct is an xhtml construct
Text	setXhtmlDiv(String xhtmlDiv) Atom 1.0 only The single xhtml div element if the text construct is an xhtml construct.
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

Text

public Text()

Text

public Text(String text)

This constructs a Text of type 'text'

Text

public Text(Text.TextType textType)

Type of the text.

Parameters:

textType -

Method Detail

getText

public String getText()

The text content of this text element.

Returns:

setText

public Text setText(String text)

Parameters:

text - The text content of this text element.

Returns:

this

getXhtmlDiv

public Element getXhtmlDiv()

Atom 1.0 only
The single xhtml div element if the text construct is an xhtml construct

setXhtmlDiv

public Text setXhtmlDiv(Element xhtmlDiv)

Atom 1.0 only
The single xhtml div element if the text construct is an xhtml construct

setXhtmlDiv

public Text setXhtmlDiv(String xhtmlDiv)
                 throws SAXException,
                        IOException,
                        ParserConfigurationException

Atom 1.0 only
The single xhtml div element if the text construct is an xhtml construct.
This method parses the input xhtml string into an Element and put it to the xhtmlDiv field. Therefore it should be a single <div> element.

Parameters:

xhtmlDiv - any valid xhtml string

Returns:

this

Throws:

SAXException

IOException

ParserConfigurationException

getType

public Text.TextType getType()

Type of the text.

Returns:

setType

public Text setType(Text.TextType type)

Type of the text.

Returns:

setBase

public Text 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 Text 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 Text 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