org.apache.abdera.parser.stax
Class FOMWorkspace

java.lang.Object
  org.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.FOMWorkspace

All Implemented Interfaces:

Cloneable, Iterable<Element>, Base, Element, ExtensibleElement, Workspace, 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 FOMWorkspace
extends FOMExtensibleElement
implements Workspace

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

	FOMWorkspace()
protected	FOMWorkspace(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected	FOMWorkspace(org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
protected	FOMWorkspace(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)
protected	FOMWorkspace(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory, org.apache.axiom.om.OMXMLParserWrapper builder)
	FOMWorkspace(String title)
protected	FOMWorkspace(String name, org.apache.axiom.om.OMNamespace namespace, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)

Method Summary

Workspace	addCollection(Collection collection) Adds an individual collection to this workspace
Collection	addCollection(String title, String href) Adds an individual collection to this workspace
Collection	addMultipartCollection(String title, String href) Adds a multipart collection to this workspace
Collection	getCollection(String title) Returns the named collection
List<Collection>	getCollections() Returns the full set of collections in this workspace
List<Collection>	getCollectionsThatAccept(javax.activation.MimeType... types) Returns collections that accept the specified media types
List<Collection>	getCollectionsThatAccept(String... types) Returns collections that accept the specified media types
Collection	getCollectionThatAccepts(javax.activation.MimeType... types) Returns a collection that accepts the specified media types
Collection	getCollectionThatAccepts(String... types) Returns a collection that accepts the specified media types
String	getTitle() Return the workspace title
Text	getTitleElement() Return the atom:title
Text	setTitle(String title) Set the workspace title
Text	setTitleAsHtml(String title) Set the workspace title as escaped HTML
Text	setTitleAsXHtml(String title) Set the workspace title as XHTML

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

FOMWorkspace

public FOMWorkspace()

FOMWorkspace

public FOMWorkspace(String title)

FOMWorkspace

protected FOMWorkspace(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

FOMWorkspace

protected FOMWorkspace(QName qname,
                       org.apache.axiom.om.OMContainer parent,
                       org.apache.axiom.om.OMFactory factory)
                throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

FOMWorkspace

protected FOMWorkspace(QName qname,
                       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

FOMWorkspace

protected FOMWorkspace(org.apache.axiom.om.OMContainer parent,
                       org.apache.axiom.om.OMFactory factory)
                throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

FOMWorkspace

protected FOMWorkspace(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

getTitle

public String getTitle()

Description copied from interface: Workspace

Return the workspace title

Specified by:

getTitle in interface Workspace

Returns:

The atom:title value

setTitle

public Text setTitle(String title)

Description copied from interface: Workspace

Set the workspace title

Specified by:

setTitle in interface Workspace

Parameters:

title - The atom:title value

Returns:

The newly created atom:title

setTitleAsHtml

public Text setTitleAsHtml(String title)

Description copied from interface: Workspace

Set the workspace title as escaped HTML

Specified by:

setTitleAsHtml in interface Workspace

Parameters:

title - The atom:title value

Returns:

The newly created atom:title

setTitleAsXHtml

public Text setTitleAsXHtml(String title)

Description copied from interface: Workspace

Set the workspace title as XHTML

Specified by:

setTitleAsXHtml in interface Workspace

Parameters:

title - The atom:title value

Returns:

the newly created atom:title

getTitleElement

public Text getTitleElement()

Description copied from interface: Workspace

Return the atom:title

Specified by:

getTitleElement in interface Workspace

Returns:

The atom:title element

getCollections

public List<Collection> getCollections()

Description copied from interface: Workspace

Returns the full set of collections in this workspace

Specified by:

getCollections in interface Workspace

Returns:

A listing of app:collection elements

getCollection

public Collection getCollection(String title)

Description copied from interface: Workspace

Returns the named collection

Specified by:

getCollection in interface Workspace

Parameters:

title - A collection title

Returns:

A matching app:collection

addCollection

public Workspace addCollection(Collection collection)

Description copied from interface: Workspace

Adds an individual collection to this workspace

Specified by:

addCollection in interface Workspace

Parameters:

collection - The collection to add

addCollection

public Collection addCollection(String title,
                                String href)

Description copied from interface: Workspace

Adds an individual collection to this workspace

Specified by:

addCollection in interface Workspace

Parameters:

title - The collection title

href - The collection HREF

Returns:

The newly created app:collection

addMultipartCollection

public Collection addMultipartCollection(String title,
                                         String href)

Description copied from interface: Workspace

Adds a multipart collection to this workspace

Specified by:

addMultipartCollection in interface Workspace

Parameters:

title - The collection title

href - The collection HREF

Returns:

The newly created app:collection

getCollectionThatAccepts

public Collection getCollectionThatAccepts(javax.activation.MimeType... types)

Description copied from interface: Workspace

Returns a collection that accepts the specified media types

Specified by:

getCollectionThatAccepts in interface Workspace

Returns:

A matching app:collection element

getCollectionThatAccepts

public Collection getCollectionThatAccepts(String... types)

Description copied from interface: Workspace

Returns a collection that accepts the specified media types

Specified by:

getCollectionThatAccepts in interface Workspace

Returns:

A matching app:collection element

getCollectionsThatAccept

public List<Collection> getCollectionsThatAccept(javax.activation.MimeType... types)

Description copied from interface: Workspace

Returns collections that accept the specified media types

Specified by:

getCollectionsThatAccept in interface Workspace

Returns:

A listing matching app:collection elements

getCollectionsThatAccept

public List<Collection> getCollectionsThatAccept(String... types)

Description copied from interface: Workspace

Returns collections that accept the specified media types

Specified by:

getCollectionsThatAccept in interface Workspace

Returns:

A listing of matching app:collection elements