|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.impl.llom.OMNodeImpl
org.apache.axiom.om.impl.llom.OMElementImpl
org.apache.abdera.parser.stax.FOMElement
org.apache.abdera.parser.stax.FOMExtensibleElement
org.apache.abdera.parser.stax.FOMCategories
public class FOMCategories
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.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.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 |
---|
public 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
org.apache.axiom.om.OMException
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(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory) throws org.apache.axiom.om.OMException
org.apache.axiom.om.OMException
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
org.apache.axiom.om.OMException
Method Detail |
---|
public Categories addCategory(Category category)
Categories
addCategory
in interface Categories
category
- The atom:category to add to the listingpublic Category addCategory(String term)
Categories
addCategory
in interface Categories
term
- The string term
public Category addCategory(String scheme, String term, String label)
Categories
addCategory
in interface Categories
scheme
- The scheme IRI for the newly created categoryterm
- The string termlabel
- The human readable label for the category
public List<Category> getCategories()
Categories
getCategories
in interface Categories
public List<Category> getCategories(String scheme)
Categories
getCategories
in interface Categories
scheme
- The IRI of an atom:category scheme
public List<Category> getCategoriesWithScheme()
Categories
getCategoriesWithScheme
in interface Categories
public List<Category> getCategoriesWithScheme(String scheme)
Categories
getCategoriesWithScheme
in interface Categories
scheme
- A scheme IRI
public IRI getScheme()
Categories
getScheme
in interface Categories
public boolean isFixed()
Categories
isFixed
in interface Categories
public Categories setFixed(boolean fixed)
Categories
setFixed
in interface Categories
fixed
- True if the app:categories listing is fixedpublic Categories setScheme(String scheme)
Categories
setScheme
in interface Categories
scheme
- The default scheme used for this listing of categoriespublic IRI getHref()
Categories
getHref
in interface Categories
public IRI getResolvedHref()
Categories
getResolvedHref
in interface Categories
public Categories setHref(String href)
Categories
setHref
in interface Categories
href
- The location of an Atompub Categories Documentpublic boolean contains(String term)
Categories
contains
in interface Categories
term
- The term to look for
public boolean contains(String term, String scheme)
Categories
contains
in interface Categories
term
- The term to look forscheme
- The IRI scheme
public boolean isOutOfLine()
Categories
isOutOfLine
in interface Categories
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |