org.apache.abdera.parser.stax
Class FOMCategories

java.lang.Object
  extended by org.apache.axiom.om.impl.llom.OMNodeImpl
      extended by org.apache.axiom.om.impl.llom.OMElementImpl
          extended by org.apache.abdera.parser.stax.FOMElement
              extended by org.apache.abdera.parser.stax.FOMExtensibleElement
                  extended by org.apache.abdera.parser.stax.FOMCategories
All Implemented Interfaces:
Cloneable, Iterable<Element>, Base, Categories, Element, ExtensibleElement, Constants, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMNode

public class FOMCategories
extends FOMExtensibleElement
implements Categories


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
builder, done, factory, nextSibling, nodeType, parent, previousSibling
 
Fields inherited from interface org.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.abdera.util.Constants
ACCEPT, AID, ALTERNATE, APP_MEDIA_TYPE, APP_NS, APP_NS_PRE_RFC, APP_PREFIX, ATITLE, ATOM_MEDIA_TYPE, ATOM_NS, AURI, AUTHOR, BASE, CAT_MEDIA_TYPE, CATEGORIES, CATEGORY, CLASS, COLLECTION, CONFIG_FACTORY, CONFIG_PARSER, CONFIG_PARSERFACTORY, CONFIG_STREAMWRITER, CONFIG_WRITER, CONFIG_WRITERFACTORY, CONFIG_XPATH, CONTENT, CONTRIBUTOR, CONTROL, CONTROL_NS, CONTROL_PREFIX, DEFAULT_FACTORY, DEFAULT_PARSER, DEFAULT_PARSERFACTORY, DEFAULT_STREAMWRITER, DEFAULT_WRITER, DEFAULT_WRITERFACTORY, DEFAULT_XPATH, DIV, DRAFT, EDITED, EMAIL, ENTRY, ENTRY_MEDIA_TYPE, FEED, FEED_MEDIA_TYPE, FIXED, GENERATOR, HREF, HREFLANG, HTML, ICON, ID, LABEL, LANG, LENGTH, LINK, LN_ACCEPT, LN_ALTERNATE, LN_ALTERNATE_MULTIPART_RELATED, LN_AUTHOR, LN_BASE, LN_CATEGORIES, LN_CATEGORY, LN_CLASS, LN_COLLECTION, LN_CONTENT, LN_CONTRIBUTOR, LN_CONTROL, LN_DIV, LN_DRAFT, LN_EDITED, LN_EMAIL, LN_ENTRY, LN_FEED, LN_FIXED, LN_GENERATOR, LN_HREF, LN_HREFLANG, LN_ICON, LN_ID, LN_LABEL, LN_LANG, LN_LENGTH, LN_LINK, LN_LOGO, LN_NAME, LN_PUBLISHED, LN_REL, LN_RIGHTS, LN_SCHEME, LN_SERVICE, LN_SOURCE, LN_SPACE, LN_SRC, LN_SUBTITLE, LN_SUMMARY, LN_TERM, LN_TITLE, LN_TYPE, LN_UPDATED, LN_URI, LN_VERSION, LN_WORKSPACE, LOGO, MULTIPART_RELATED_TYPE, NAME, NAMED_PARSER, NAMED_WRITER, NO, PRE_RFC_ACCEPT, PRE_RFC_CATEGORIES, PRE_RFC_COLLECTION, PRE_RFC_CONTROL, PRE_RFC_DRAFT, PRE_RFC_EDITED, PRE_RFC_SERVICE, PRE_RFC_WORKSPACE, PREFIX, PREFIXED_TITLE, PUBLISHED, REL, RIGHTS, SCHEME, SERVICE, SOURCE, SPACE, SRC, STREAM_WRITER, SUBTITLE, SUMMARY, TERM, TEXT, TITLE, TYPE, UPDATED, URI, VERSION, WORKSPACE, XHTML, XHTML_NS, XML, XML_MEDIA_TYPE, XML_NS, YES
 
Fields inherited from interface org.apache.axiom.om.OMConstants
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
  FOMCategories()
           
protected FOMCategories(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMCategories(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMCategories(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
protected FOMCategories(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
           
protected FOMCategories(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
           
 
Method Summary
 Categories addCategory(Category category)
          Add an atom:category to the listing
 Category addCategory(String term)
          Create and add an atom:category to the listing
 Category addCategory(String scheme, String term, String label)
          Create an add an atom:category to the listing
 boolean contains(String term)
          Returns true if this app:categories listing contains a category with the specified term
 boolean contains(String term, String scheme)
          Returns true if this app:categories listing contains a category with the specified term and scheme
 List<Category> getCategories()
          Lists the complete set of categories
 List<Category> getCategories(String scheme)
          Lists the complete set of categories that use the specified scheme
 List<Category> getCategoriesWithScheme()
          Returns a copy of the complete set of categories with the scheme attribute set
 List<Category> getCategoriesWithScheme(String scheme)
          Returns a copy of the complete set of categories with the scheme attribute set as specified in 7.2.1.
 IRI getHref()
          When contained within an app:collection element, the app:categories element can have an href attribute whose value MUST point to an Atompub Categories Document.
 IRI getResolvedHref()
          Returns the value of the href attribute resolved against the in-scope Base URI
 IRI getScheme()
          The app:categories element may specify a default scheme attribute for listed atom:category elements that do not have their own scheme attribute.
 boolean isFixed()
          If an app:categories element is marked as fixed, then the set of atom:category elements is considered to be a closed set.
 boolean isOutOfLine()
          Returns true if the href attribute is set
 Categories setFixed(boolean fixed)
          Sets whether or not this is a fixed listing of categories.
 Categories setHref(String href)
          Sets the value of the href attribute.
 Categories setScheme(String scheme)
          Sets the default scheme for this listing of categories
 
Methods inherited from class org.apache.abdera.parser.stax.FOMExtensibleElement
addExtension, addExtension, addExtension, addExtension, addExtension, addExtensions, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
Methods inherited from class org.apache.abdera.parser.stax.FOMElement
_copyElement, _create, _getChildrenAsSet, _getElementValue, _getStringValue, _getUriValue, _parse, _removeAllChildren, _removeChildren, _resolve, _setChild, _setElementValue, addComment, clone, complete, declareIfNecessary, declareNS, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDefaultWriterOptions, getDocument, getElements, getExtensionAttributes, getFactory, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getResolvedBaseUri, getText, getText, getTextElement, getWrapped, isDeclared, iterator, removeAttribute, removeAttribute, selectLink, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setHtmlText, setLanguage, setMustPreserveWhitespace, setParentDocument, setParentElement, setText, setText, setTextElement, setTextText, setXhtmlText, setXhtmlText, toFormattedString, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, addChild, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.abdera.model.ExtensibleElement
addExtension, addExtension, addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension
 
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
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, toString, toStringWithConsume
 
Methods inherited from interface org.apache.axiom.om.OMNode
build, buildWithAttachments, close, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Constructor Detail

FOMCategories

public FOMCategories()

FOMCategories

protected FOMCategories(String name,
                        org.apache.axiom.om.OMNamespace namespace,
                        org.apache.axiom.om.OMContainer parent,
                        org.apache.axiom.om.OMFactory factory)
                 throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException

FOMCategories

protected FOMCategories(QName qname,
                        org.apache.axiom.om.OMContainer parent,
                        org.apache.axiom.om.OMFactory factory)

FOMCategories

protected FOMCategories(QName qname,
                        org.apache.axiom.om.OMContainer parent,
                        org.apache.axiom.om.OMFactory factory,
                        org.apache.axiom.om.OMXMLParserWrapper builder)

FOMCategories

protected FOMCategories(org.apache.axiom.om.OMContainer parent,
                        org.apache.axiom.om.OMFactory factory)
                 throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException

FOMCategories

protected FOMCategories(org.apache.axiom.om.OMContainer parent,
                        org.apache.axiom.om.OMFactory factory,
                        org.apache.axiom.om.OMXMLParserWrapper builder)
                 throws org.apache.axiom.om.OMException
Throws:
org.apache.axiom.om.OMException
Method Detail

addCategory

public Categories addCategory(Category category)
Description copied from interface: Categories
Add an atom:category to the listing

Specified by:
addCategory in interface Categories
Parameters:
category - The atom:category to add to the listing

addCategory

public Category addCategory(String term)
Description copied from interface: Categories
Create and add an atom:category to the listing

Specified by:
addCategory in interface Categories
Parameters:
term - The string term
Returns:
The newly created atom:category

addCategory

public Category addCategory(String scheme,
                            String term,
                            String label)
Description copied from interface: Categories
Create an add an atom:category to the listing

Specified by:
addCategory in interface Categories
Parameters:
scheme - The scheme IRI for the newly created category
term - The string term
label - The human readable label for the category
Returns:
The newly created atom:category

getCategories

public List<Category> getCategories()
Description copied from interface: Categories
Lists the complete set of categories

Specified by:
getCategories in interface Categories
Returns:
This app:categories listing of atom:category elements

getCategories

public List<Category> getCategories(String scheme)
Description copied from interface: Categories
Lists the complete set of categories that use the specified scheme

Specified by:
getCategories in interface Categories
Parameters:
scheme - The IRI of an atom:category scheme
Returns:
A listing of atom:category elements that use the specified scheme

getCategoriesWithScheme

public List<Category> getCategoriesWithScheme()
Description copied from interface: Categories
Returns a copy of the complete set of categories with the scheme attribute set

Specified by:
getCategoriesWithScheme in interface Categories
Returns:
A listing of atom:category elements using the default scheme specified by the app:categories scheme attribute

getCategoriesWithScheme

public List<Category> getCategoriesWithScheme(String scheme)
Description copied from interface: Categories
Returns a copy of the complete set of categories with the scheme attribute set as specified in 7.2.1. (child categories that do not have a scheme attribute inherit the scheme attribute of the parent)

Specified by:
getCategoriesWithScheme in interface Categories
Parameters:
scheme - A scheme IRI
Returns:
A listing of atom:category elements

getScheme

public IRI getScheme()
Description copied from interface: Categories
The app:categories element may specify a default scheme attribute for listed atom:category elements that do not have their own scheme attribute.

Specified by:
getScheme in interface Categories
Returns:
The scheme IRI

isFixed

public boolean isFixed()
Description copied from interface: Categories
If an app:categories element is marked as fixed, then the set of atom:category elements is considered to be a closed set. That is, Atom Publishing Protocol clients SHOULD only use the atom:category elements listed. The default is false (fixed="no")

Specified by:
isFixed in interface Categories
Returns:
True if the categories listing is fixed

setFixed

public Categories setFixed(boolean fixed)
Description copied from interface: Categories
Sets whether or not this is a fixed listing of categories. If set to false, the fixed attribute will be removed from the app:categories element.

Specified by:
setFixed in interface Categories
Parameters:
fixed - True if the app:categories listing is fixed

setScheme

public Categories setScheme(String scheme)
Description copied from interface: Categories
Sets the default scheme for this listing of categories

Specified by:
setScheme in interface Categories
Parameters:
scheme - The default scheme used for this listing of categories

getHref

public IRI getHref()
Description copied from interface: Categories
When contained within an app:collection element, the app:categories element can have an href attribute whose value MUST point to an Atompub Categories Document.

Specified by:
getHref in interface Categories
Returns:
The href attribute value

getResolvedHref

public IRI getResolvedHref()
Description copied from interface: Categories
Returns the value of the href attribute resolved against the in-scope Base URI

Specified by:
getResolvedHref in interface Categories
Returns:
The fully resolved href attribute value

setHref

public Categories setHref(String href)
Description copied from interface: Categories
Sets the value of the href attribute.

Specified by:
setHref in interface Categories
Parameters:
href - The location of an Atompub Categories Document

contains

public boolean contains(String term)
Description copied from interface: Categories
Returns true if this app:categories listing contains a category with the specified term

Specified by:
contains in interface Categories
Parameters:
term - The term to look for
Returns:
True if the term is found

contains

public boolean contains(String term,
                        String scheme)
Description copied from interface: Categories
Returns true if this app:categories listing contains a category with the specified term and scheme

Specified by:
contains in interface Categories
Parameters:
term - The term to look for
scheme - The IRI scheme
Returns:
True if the term and scheme are found

isOutOfLine

public boolean isOutOfLine()
Description copied from interface: Categories
Returns true if the href attribute is set

Specified by:
isOutOfLine in interface Categories


Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.