org.apache.abdera.ext.rss
Class RssCategory

java.lang.Object
  org.apache.abdera.model.ElementWrapper
      org.apache.abdera.model.ExtensibleElementWrapper
          org.apache.abdera.ext.rss.RssCategory

All Implemented Interfaces:

Cloneable, Iterable<Element>, Base, Category, Element, ExtensibleElement

public class RssCategory
extends ExtensibleElementWrapper
implements Category

Constructor Summary

RssCategory(Element internal)

RssCategory(Factory factory, QName qname)

Method Summary

<T extends ExtensibleElement> T	addExtension(Element extension) Adds an individual extension element
<T extends Element> T	addExtension(QName qname) Adds an individual extension element
<T extends Element> T	addExtension(String namespace, String localPart, String prefix) Adds an individual extension element
Element	addSimpleExtension(QName qname, String value) Adds a simple extension (text content only)
Element	addSimpleExtension(String namespace, String localPart, String prefix, String value) Adds a simple extension (text content only)
<T extends Element> T	getExtension(Class<T> _class) Find an extension by Class rather than QName
<T extends Element> T	getExtension(QName qname) Returns the first extension element with the XML qualified name
List<Element>	getExtensions() Returns the complete set of extension elements
<T extends Element> List<T>	getExtensions(QName qname) Returns the complete set of extension elements using the specified XML qualified name
List<Element>	getExtensions(String uri) Returns the complete set of extension elements using the specified XML Namespace URI
String	getLabel() RFC4287: The "label" attribute provides a human-readable label for display in end-user applications.
IRI	getScheme() RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme.
String	getSimpleExtension(QName qname) Gets the value of a simple extension
String	getSimpleExtension(String namespace, String localPart, String prefix) Gets the value of a simple extension
String	getTerm() RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs.
Category	setLabel(String label) RFC4287: The "label" attribute provides a human-readable label for display in end-user applications.
Category	setScheme(String scheme) RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme.
Category	setTerm(String term) RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs.

Methods inherited from class org.apache.abdera.model.ExtensibleElementWrapper

addExtension, addExtension, getExtInternal, getMustPreserveWhitespace, setMustPreserveWhitespace

Methods inherited from class org.apache.abdera.model.ElementWrapper

addComment, clone, complete, declareNS, discard, equals, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDefaultWriterOptions, getDocument, getElements, getExtensionAttributes, getFactory, getFirstChild, getFirstChild, getInternal, getLanguage, getLanguageTag, getLocale, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, hashCode, iterator, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setParentElement, setText, setText, toString, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.abdera.model.ExtensibleElement

addExtension, addExtension

Methods inherited from interface org.apache.abdera.model.Element

declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText

Methods inherited from interface org.apache.abdera.model.Base

addComment, clone, complete, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

RssCategory

public RssCategory(Element internal)

RssCategory

public RssCategory(Factory factory,
                   QName qname)

Method Detail

getLabel

public String getLabel()

Description copied from interface: Category

RFC4287: The "label" attribute provides a human-readable label for display in end-user applications. The content of the "label" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Category elements MAY have a "label" attribute.

Specified by:

getLabel in interface Category

Returns:

The value of the human-readable label

getScheme

public IRI getScheme()

Description copied from interface: Category

RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute.

Specified by:

getScheme in interface Category

Returns:

The IRI value of the scheme attribute

getTerm

public String getTerm()

Description copied from interface: Category

RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute.

Specified by:

getTerm in interface Category

Returns:

The string value of the term attribute

setLabel

public Category setLabel(String label)

Description copied from interface: Category

RFC4287: The "label" attribute provides a human-readable label for display in end-user applications. The content of the "label" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Category elements MAY have a "label" attribute.

Specified by:

setLabel in interface Category

Parameters:

label - The value of the human-readable label

setScheme

public Category setScheme(String scheme)

Description copied from interface: Category

RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute.

Specified by:

setScheme in interface Category

Parameters:

scheme - The IRI of the scheme

setTerm

public Category setTerm(String term)

Description copied from interface: Category

RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute.

Specified by:

setTerm in interface Category

Parameters:

term - The string value of the term attribute

addExtension

public <T extends ExtensibleElement> T addExtension(Element extension)

Description copied from interface: ExtensibleElement

Adds an individual extension element

Specified by:

addExtension in interface ExtensibleElement

Overrides:

addExtension in class ExtensibleElementWrapper

Parameters:

extension - An extension element to add

addExtension

public <T extends Element> T addExtension(QName qname)

Description copied from interface: ExtensibleElement

Adds an individual extension element

Specified by:

addExtension in interface ExtensibleElement

Overrides:

addExtension in class ExtensibleElementWrapper

Parameters:

qname - An extension element to create

Returns:

The newly created extension element

addExtension

public <T extends Element> T addExtension(String namespace,
                                          String localPart,
                                          String prefix)

Description copied from interface: ExtensibleElement

Adds an individual extension element

Specified by:

addExtension in interface ExtensibleElement

Overrides:

addExtension in class ExtensibleElementWrapper

Parameters:

namespace - An XML namespace

localPart - A localname

prefix - A XML namespace prefix

Returns:

The newly creatd extension element

addSimpleExtension

public Element addSimpleExtension(QName qname,
                                  String value)

Description copied from interface: ExtensibleElement

Adds a simple extension (text content only)

Specified by:

addSimpleExtension in interface ExtensibleElement

Overrides:

addSimpleExtension in class ExtensibleElementWrapper

Parameters:

qname - An XML QName

value - The simple text value of the element

Returns:

The newly created extension element

addSimpleExtension

public Element addSimpleExtension(String namespace,
                                  String localPart,
                                  String prefix,
                                  String value)

Description copied from interface: ExtensibleElement

Adds a simple extension (text content only)

Specified by:

addSimpleExtension in interface ExtensibleElement

Overrides:

addSimpleExtension in class ExtensibleElementWrapper

Parameters:

namespace - An XML namespace

localPart - A local name

prefix - A namespace prefix

value - The simple text value

Returns:

The newly created extension element

getExtension

public <T extends Element> T getExtension(QName qname)

Description copied from interface: ExtensibleElement

Returns the first extension element with the XML qualified name

Specified by:

getExtension in interface ExtensibleElement

Overrides:

getExtension in class ExtensibleElementWrapper

Parameters:

qname - An XML QName

Returns:

An extension with the specified qname

getExtension

public <T extends Element> T getExtension(Class<T> _class)

Description copied from interface: ExtensibleElement

Find an extension by Class rather than QName

Specified by:

getExtension in interface ExtensibleElement

Overrides:

getExtension in class ExtensibleElementWrapper

Parameters:

_class - The implementation class of the extension

Returns:

The extension element

getExtensions

public List<Element> getExtensions()

Description copied from interface: ExtensibleElement

Returns the complete set of extension elements

Specified by:

getExtensions in interface ExtensibleElement

Overrides:

getExtensions in class ExtensibleElementWrapper

Returns:

a listing of extensions

getExtensions

public List<Element> getExtensions(String uri)

Description copied from interface: ExtensibleElement

Returns the complete set of extension elements using the specified XML Namespace URI

Specified by:

getExtensions in interface ExtensibleElement

Overrides:

getExtensions in class ExtensibleElementWrapper

Parameters:

uri - A namespace URI

Returns:

A listing of extensions using the specified XML namespace

getExtensions

public <T extends Element> List<T> getExtensions(QName qname)

Description copied from interface: ExtensibleElement

Returns the complete set of extension elements using the specified XML qualified name

Specified by:

getExtensions in interface ExtensibleElement

Overrides:

getExtensions in class ExtensibleElementWrapper

Parameters:

qname - An XML QName

Returns:

A listing of extensions with the specified QName

getSimpleExtension

public String getSimpleExtension(QName qname)

Description copied from interface: ExtensibleElement

Gets the value of a simple extension

Specified by:

getSimpleExtension in interface ExtensibleElement

Overrides:

getSimpleExtension in class ExtensibleElementWrapper

Parameters:

qname - An XML QName

Returns:

The string value of the extension

getSimpleExtension

public String getSimpleExtension(String namespace,
                                 String localPart,
                                 String prefix)

Description copied from interface: ExtensibleElement

Gets the value of a simple extension

Specified by:

getSimpleExtension in interface ExtensibleElement

Overrides:

getSimpleExtension in class ExtensibleElementWrapper

Parameters:

namespace - An XML namespace

localPart - A localname

prefix - A namespace prefix

Returns:

The string value of the extension