org.apache.axis2.om.impl.dom
Class ElementImpl

java.lang.Object
  org.apache.axis2.om.impl.dom.NodeImpl
      org.apache.axis2.om.impl.dom.ChildNode
          org.apache.axis2.om.impl.dom.ParentNode
              org.apache.axis2.om.impl.dom.ElementImpl

All Implemented Interfaces:

org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList, OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx

Direct Known Subclasses:

SOAPElement, SOAPHeaderBlockImpl

public class ElementImpl

extends ParentNode

implements org.w3c.dom.Element, OMElement, OMConstants

Implementation of the org.w3c.dom.Element and org.apache.axis2.om.Element interfaces.

Author:

Ruchith Fernando (ruchith.fernando@gmail.com)

Field Summary

protected java.lang.String	localName
protected OMNamespace	namespace

Fields inherited from class org.apache.axis2.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axis2.om.impl.dom.ChildNode

nextSibling, parentNode, previousSubling

Fields inherited from class org.apache.axis2.om.impl.dom.NodeImpl

builder, done, FIRSTCHILD, flags, nodeType, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.apache.axis2.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.axis2.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DEFAULT_CHAR_SET_ENCODING, DEFAULT_XML_VERSION, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName)

ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName, NamespaceImpl ns)
Create a new element with the namespace

ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)

ElementImpl(ParentNode parentNode, java.lang.String tagName, NamespaceImpl ns)

ElementImpl(ParentNode parentNode, java.lang.String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)

ElementImpl(java.lang.String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)

Method Summary

OMAttribute	addAttribute(OMAttribute attr) This will add an attribute to this element.
OMAttribute	addAttribute(java.lang.String attributeName, java.lang.String value, OMNamespace ns) The behaviour of this is the same as org.w3c.dom.Element#setAttributeNS
OMElement	cloneOMElement() This method will clone this element.
OMNamespace	declareNamespace(OMNamespace namespace) This will allow overriding an existing declaration if the same prefix was used
OMNamespace	declareNamespace(java.lang.String uri, java.lang.String prefix) This will allow overriding an existing declaration if the same prefix was used
OMNamespace	findNamespace(java.lang.String uri, java.lang.String prefix) This will find a namespace with the given uri and prefix, in the scope of the hierarchy.
OMNamespace	findNamespaceURI(java.lang.String prefix) This will check for a namespace in the context of this element with the given prefix and will return the relevant namespace object, if available.
java.util.Iterator	getAllAttributes() This will return a List of OMAttributes.
java.util.Iterator	getAllDeclaredNamespaces() Returns an iterator for all of the namespaces declared on this element.
OMAttribute	getAttribute(javax.xml.namespace.QName qname) Returns a named attribute if present.
java.lang.String	getAttribute(java.lang.String name) Look in the local list of attributes and return if found if the local list is null return null
org.w3c.dom.Attr	getAttributeNode(java.lang.String name) Retrieves an attribute node by name.
org.w3c.dom.Attr	getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName) Retrieves an Attr node by local name and namespace URI.
java.lang.String	getAttributeNS(java.lang.String namespaceURI, java.lang.String localName) Retrieves an attribute value by local name and namespace URI.
org.w3c.dom.NamedNodeMap	getAttributes() This will return the set of attributes of this node and the namespace declarations available
java.lang.String	getAttributeValue(javax.xml.namespace.QName qname) Return a named attribute's value, if present.
OMXMLParserWrapper	getBuilder() Returns the builder object.
java.util.Iterator	getChildElements() Returns a filtered list of children - just the elements.
org.w3c.dom.NodeList	getElementsByTagName(java.lang.String name)
org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
OMAttribute	getFirstAttribute(javax.xml.namespace.QName qname) Returns the first attribute of the set of attributes if there are any attributes.
OMElement	getFirstElement() Returns the first Element node
java.lang.String	getLocalName() Returns the local name of this element node
OMNamespace	getNamespace() Returns the namespace of this element
java.lang.String	getNamespaceURI() Returns the value of the namespace URI
java.lang.String	getNamespaceURI(java.lang.String prefix) return the namespace uri, given the prefix
java.lang.String	getNodeName()
short	getNodeType()
java.lang.String	getPrefix() returns the namespace prefix of this element node
javax.xml.namespace.QName	getQName() Returns the QName of this element
org.w3c.dom.TypeInfo	getSchemaTypeInfo()
java.lang.String	getTagName()
java.lang.String	getText() select all the text children and concat them to a single string
int	getType() Returns the type of node.
javax.xml.stream.XMLStreamReader	getXMLStreamReader() Returns the pull parser that will generate the pull events relevant to THIS element.
javax.xml.stream.XMLStreamReader	getXMLStreamReaderWithoutCaching() Returns the pull parser that will generate the pull events relevant to THIS element.
boolean	hasAttribute(java.lang.String name)
boolean	hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName) Returns whether the given attr is available or not
boolean	hasAttributes() Returns whether this element contains any attr or not
void	removeAttribute(OMAttribute attr) Removes an attribute fron the element
void	removeAttribute(java.lang.String name) Removes an attribute by name.
org.w3c.dom.Attr	removeAttributeNode(org.w3c.dom.Attr oldAttr) Removes the specified attribute node
void	removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
boolean	removeNamespace(java.lang.String prefix) Remove a declared namespace give its prefix
javax.xml.namespace.QName	resolveQName(java.lang.String qname) Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context unprefixed qnames resolve to the local namespace
void	serialize(OMOutputImpl omOutput) Serialize the node with caching
protected void	serialize(OMOutputImpl omOutput, boolean cache)
void	serializeAndConsume(OMOutputImpl omOutput) Serialize the node without caching
void	setAttribute(java.lang.String name, java.lang.String value)
org.w3c.dom.Attr	setAttributeNode(org.w3c.dom.Attr attr) Adds a new attribute node.
org.w3c.dom.Attr	setAttributeNodeNS(org.w3c.dom.Attr attr)
void	setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) Adds a new attribute
void	setBuilder(OMXMLParserWrapper wrapper) Sets the OM builder
void	setIdAttribute(java.lang.String arg0, boolean arg1)
void	setIdAttributeNode(org.w3c.dom.Attr arg0, boolean arg1)
void	setIdAttributeNS(java.lang.String arg0, java.lang.String arg1, boolean arg2)
void	setLocalName(java.lang.String localName) Set the local name
void	setNamespace(OMNamespace namespace) Set the namespace
protected void	setOwnerDocument(DocumentImpl document) sets the owner document
void	setText(java.lang.String text) Creates a text node with the given value and adds it to the element
void	setType(int nodeType)
java.lang.String	toString() Overridden toString() for ease of debuging
java.lang.String	toStringWithConsume() This is a convenience method only.

Methods inherited from class org.apache.axis2.om.impl.dom.ParentNode

addChild, buildNext, getChildNodes, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, insertBefore, removeChild, replaceChild, setFirstChild

Methods inherited from class org.apache.axis2.om.impl.dom.ChildNode

detach, discard, getNextOMSibling, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling

Methods inherited from class org.apache.axis2.om.impl.dom.NodeImpl

appendChild, build, cloneNode, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOwnerDocument, getTextContent, getUserData, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeWithCache, setComplete, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Methods inherited from interface org.apache.axis2.om.OMElement

setFirstChild

Methods inherited from interface org.apache.axis2.om.OMNode

build, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axis2.om.OMContainer

addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete

Methods inherited from interface org.apache.axis2.om.impl.OMContainerEx

setComplete

Field Detail

namespace

protected OMNamespace namespace

localName

protected java.lang.String localName

Constructor Detail

ElementImpl

public ElementImpl(DocumentImpl ownerDocument,
                   java.lang.String tagName)

Parameters:

ownerDocument -

ElementImpl

public ElementImpl(DocumentImpl ownerDocument,
                   java.lang.String tagName,
                   NamespaceImpl ns)

Create a new element with the namespace

Parameters:

ownerDocument -

tagName -

ns -

ElementImpl

public ElementImpl(DocumentImpl ownerDocument,
                   java.lang.String tagName,
                   NamespaceImpl ns,
                   OMXMLParserWrapper builder)

ElementImpl

public ElementImpl(ParentNode parentNode,
                   java.lang.String tagName,
                   NamespaceImpl ns)

ElementImpl

public ElementImpl(ParentNode parentNode,
                   java.lang.String tagName,
                   NamespaceImpl ns,
                   OMXMLParserWrapper builder)

ElementImpl

public ElementImpl(java.lang.String tagName,
                   NamespaceImpl ns,
                   OMXMLParserWrapper builder)

Method Detail

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()

Returns the value of the namespace URI

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

Overrides:

getNamespaceURI in class NodeImpl

getType

public int getType()
            throws OMException

Description copied from interface: OMNode

Returns the type of node.

Specified by:

getType in interface OMNode

Returns:

One of OMNode.ELEMENT_NODE, OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE, OMNode.COMMENT_NODE, OMNode.DTD_NODE, OMNode.PI_NODE, OMNode.ENTITY_REFERENCE_NODE, OMNode.SPACE_NODE, or OMNode.TEXT_NODE.

Throws:

OMException

setType

public void setType(int nodeType)
             throws OMException

Specified by:

setType in interface OMNodeEx

Throws:

OMException

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in interface org.w3c.dom.Element

removeAttribute

public void removeAttribute(java.lang.String name)
                     throws org.w3c.dom.DOMException

Removes an attribute by name.

Specified by:

removeAttribute in interface org.w3c.dom.Element

Parameters:

name - The name of the attribute to remove

Throws:

org.w3c.dom.DOMException

See Also:

Element.removeAttribute(java.lang.String)

removeAttributeNS

public void removeAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)
                       throws org.w3c.dom.DOMException

Specified by:

removeAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

removeAttributeNode

public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr)
                                     throws org.w3c.dom.DOMException

Removes the specified attribute node

Specified by:

removeAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

See Also:

Element.removeAttributeNode(org.w3c.dom.Attr)

hasAttribute

public boolean hasAttribute(java.lang.String name)

Specified by:

hasAttribute in interface org.w3c.dom.Element

hasAttributeNS

public boolean hasAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)

Returns whether the given attr is available or not

Specified by:

hasAttributeNS in interface org.w3c.dom.Element

See Also:

Element.hasAttributeNS(java.lang.String, java.lang.String)

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Look in the local list of attributes and return if found if the local list is null return null

Specified by:

getAttribute in interface org.w3c.dom.Element

See Also:

Element.getAttribute(java.lang.String)

getAttributeNode

public org.w3c.dom.Attr getAttributeNode(java.lang.String name)

Retrieves an attribute node by name.

Specified by:

getAttributeNode in interface org.w3c.dom.Element

See Also:

Element.getAttributeNode(java.lang.String)

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String localName)

Retrieves an attribute value by local name and namespace URI.

Specified by:

getAttributeNS in interface org.w3c.dom.Element

See Also:

Element.getAttributeNS(java.lang.String, java.lang.String)

getAttributeNodeNS

public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI,
                                           java.lang.String localName)

Retrieves an Attr node by local name and namespace URI.

Specified by:

getAttributeNodeNS in interface org.w3c.dom.Element

See Also:

Element.getAttributeNodeNS(java.lang.String, java.lang.String)

setAttributeNode

public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr attr)
                                  throws org.w3c.dom.DOMException

Adds a new attribute node.

Specified by:

setAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

See Also:

Element.setAttributeNode(org.w3c.dom.Attr)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
                  throws org.w3c.dom.DOMException

Specified by:

setAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNodeNS

public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr attr)
                                    throws org.w3c.dom.DOMException

Specified by:

setAttributeNodeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setAttributeNS

public void setAttributeNS(java.lang.String namespaceURI,
                           java.lang.String qualifiedName,
                           java.lang.String value)
                    throws org.w3c.dom.DOMException

Adds a new attribute

Specified by:

setAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

See Also:

Element.setAttributeNS(java.lang.String, java.lang.String, java.lang.String)

hasAttributes

public boolean hasAttributes()

Returns whether this element contains any attr or not

Specified by:

hasAttributes in interface org.w3c.dom.Node

Overrides:

hasAttributes in class NodeImpl

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
                                                   java.lang.String localName)

Specified by:

getElementsByTagNameNS in interface org.w3c.dom.Element

getElementsByTagName

public org.w3c.dom.NodeList getElementsByTagName(java.lang.String name)

Specified by:

getElementsByTagName in interface org.w3c.dom.Element

addAttribute

public OMAttribute addAttribute(OMAttribute attr)

Description copied from interface: OMElement

This will add an attribute to this element.

There is no order implied by added attributes.

Specified by:

addAttribute in interface OMElement

Parameters:

attr - The attribute to add.

Returns:

The passed in attribute.

See Also:

OMElement.addAttribute(org.apache.axis2.om.OMAttribute)

addAttribute

public OMAttribute addAttribute(java.lang.String attributeName,
                                java.lang.String value,
                                OMNamespace ns)

The behaviour of this is the same as org.w3c.dom.Element#setAttributeNS

Specified by:

addAttribute in interface OMElement

Parameters:

attributeName - The "local name" for the attribute.

value - The string value of the attribute.

ns - The namespace has to be one of the in scope namespace. i.e. the passed namespace must be declared in the parent element of this attribute or ancestors of the parent element of the attribute.

Returns:

The added attribute.

See Also:

OMElement.addAttribute(java.lang.String, java.lang.String, org.apache.axis2.om.OMNamespace)

declareNamespace

public OMNamespace declareNamespace(OMNamespace namespace)

This will allow overriding an existing declaration if the same prefix was used

Specified by:

declareNamespace in interface OMElement

Parameters:

namespace - The namespace to declare

Returns:

The namespace parameter passed.

See Also:

OMElement.declareNamespace(org.apache.axis2.om.OMNamespace)

declareNamespace

public OMNamespace declareNamespace(java.lang.String uri,
                                    java.lang.String prefix)

This will allow overriding an existing declaration if the same prefix was used

Specified by:

declareNamespace in interface OMElement

Parameters:

uri - The namespace to declare in the current scope. The caller is expected to ensure that the URI is a valid namespace name.

prefix - The prefix to associate with the given namespace. The caller is expected to ensure that this is a valid XML prefix.

Returns:

The created namespace information item.

See Also:

OMElement.declareNamespace(java.lang.String, java.lang.String)

findNamespace

public OMNamespace findNamespace(java.lang.String uri,
                                 java.lang.String prefix)

Description copied from interface: OMElement

This will find a namespace with the given uri and prefix, in the scope of the hierarchy.

This will search from the current element and go up the hiararchy until a match is found. If no match is found, return null.

Either prefix or uri should be null. Results are undefined if both are specified.

Specified by:

findNamespace in interface OMElement

Parameters:

uri - The namespace to look for. If this is specified, prefix should be null.

prefix - The prefix to look for. If this is specified, uri should be null.

Returns:

The matching namespace declaration, or null if none was found.

See Also:

OMElement.findNamespace(java.lang.String, java.lang.String)

findNamespaceURI

public OMNamespace findNamespaceURI(java.lang.String prefix)

Description copied from interface: OMElement

This will check for a namespace in the context of this element with the given prefix and will return the relevant namespace object, if available. If not available, will return null.

Specified by:

findNamespaceURI in interface OMElement

Parameters:

prefix -

getAttribute

public OMAttribute getAttribute(javax.xml.namespace.QName qname)

Returns a named attribute if present.

Specified by:

getAttribute in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

an OMAttribute with the given name if found, or null

See Also:

OMElement.getAttribute(javax.xml.namespace.QName)

getAttributeValue

public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)

Return a named attribute's value, if present.

Specified by:

getAttributeValue in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

a String containing the attribute value, or null

getBuilder

public OMXMLParserWrapper getBuilder()

Description copied from interface: OMElement

Returns the builder object.

Specified by:

getBuilder in interface OMElement

Returns:

The builder object used to construct the underlying XML infoset on the fly.

getFirstAttribute

public OMAttribute getFirstAttribute(javax.xml.namespace.QName qname)

Returns the first attribute of the set of attributes if there are any attributes. Otherwise returns null

Specified by:

getFirstAttribute in interface OMElement

Parameters:

qname - The attribute name to match.

Returns:

The attribute, if found, or null otherwise.

See Also:

OMElement.getFirstAttribute(javax.xml.namespace.QName)

getFirstElement

public OMElement getFirstElement()

Returns the first Element node

Specified by:

getFirstElement in interface OMElement

Returns:

The first child element of the element, or null if none was found.

See Also:

OMElement.getFirstElement()

getNamespace

public OMNamespace getNamespace()
                         throws OMException

Returns the namespace of this element

Specified by:

getNamespace in interface OMElement

Returns:

the OMNamespace object associated with this element

Throws:

OMException

See Also:

OMElement.getNamespace()

getQName

public javax.xml.namespace.QName getQName()

Returns the QName of this element

Specified by:

getQName in interface OMElement

Returns:

The QName for the element.

See Also:

OMElement.getQName()

getText

public java.lang.String getText()

select all the text children and concat them to a single string

Specified by:

getText in interface OMElement

Returns:

A String representing the concatenation of the child text nodes.

See Also:

OMElement.getText()

removeAttribute

public void removeAttribute(OMAttribute attr)

Removes an attribute fron the element

Specified by:

removeAttribute in interface OMElement

Parameters:

attr -

See Also:

OMElement.removeAttribute(org.apache.axis2.om.OMAttribute)

setBuilder

public void setBuilder(OMXMLParserWrapper wrapper)

Sets the OM builder

Specified by:

setBuilder in interface OMElement

Parameters:

wrapper -

See Also:

OMElement.setBuilder(org.apache.axis2.om.OMXMLParserWrapper)

setLocalName

public void setLocalName(java.lang.String localName)

Set the local name

Specified by:

setLocalName in interface OMElement

Parameters:

localName -

See Also:

OMElement.setLocalName(java.lang.String)

setNamespace

public void setNamespace(OMNamespace namespace)

Set the namespace

Specified by:

setNamespace in interface OMElement

Parameters:

namespace -

See Also:

OMElement.setNamespace(org.apache.axis2.om.OMNamespace)

setText

public void setText(java.lang.String text)

Creates a text node with the given value and adds it to the element

Specified by:

setText in interface OMElement

Parameters:

text -

See Also:

OMElement.setText(java.lang.String)

serialize

public void serialize(OMOutputImpl omOutput)
               throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serialize the node with caching

Specified by:

serialize in interface OMNodeEx

Parameters:

omOutput -

Throws:

javax.xml.stream.XMLStreamException

See Also:

OMNodeEx.serialize(org.apache.axis2.om.impl.OMOutputImpl)

serializeAndConsume

public void serializeAndConsume(OMOutputImpl omOutput)
                         throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serialize the node without caching

Specified by:

serializeAndConsume in interface OMNodeEx

Parameters:

omOutput -

Throws:

javax.xml.stream.XMLStreamException

serialize

protected void serialize(OMOutputImpl omOutput,
                         boolean cache)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getXMLStreamReaderWithoutCaching

public javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()

Description copied from interface: OMElement

Returns the pull parser that will generate the pull events relevant to THIS element.

Caching is off.

Specified by:

getXMLStreamReaderWithoutCaching in interface OMElement

Returns:

Return an XMLStreamReader relative to this element, with no caching.

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()

Description copied from interface: OMElement

Returns the pull parser that will generate the pull events relevant to THIS element.

Caching is on.

Specified by:

getXMLStreamReader in interface OMElement

Returns:

Return an XMLStreamReader relative to this element.

toStringWithConsume

public java.lang.String toStringWithConsume()
                                     throws javax.xml.stream.XMLStreamException

Description copied from interface: OMElement

This is a convenience method only. This will basically serialize the given OMElement to a String but will NOT build the OMTree in the memory. So you are at your own risk of losing information.

Specified by:

toStringWithConsume in interface OMElement

Throws:

javax.xml.stream.XMLStreamException

toString

public java.lang.String toString()

Overridden toString() for ease of debuging

Specified by:

toString in interface OMElement

See Also:

Object.toString()

getChildElements

public java.util.Iterator getChildElements()

Description copied from interface: OMElement

Returns a filtered list of children - just the elements.

Specified by:

getChildElements in interface OMElement

Returns:

an iterator over the child elements

See Also:

OMContainer.getChildren(), OMContainer.getChildrenWithName(javax.xml.namespace.QName)

getAllDeclaredNamespaces

public java.util.Iterator getAllDeclaredNamespaces()
                                            throws OMException

Description copied from interface: OMElement

Returns an iterator for all of the namespaces declared on this element.

If you're interested in all namespaces in scope, you need to call this function for all parent elements as well. Note that the iterator may be invalidated by any call to either declareNamespace function.

Specified by:

getAllDeclaredNamespaces in interface OMElement

Returns:

An iterator over the OMNamespace items declared on the current element.

Throws:

OMException

See Also:

OMElement.getAllDeclaredNamespaces()

getAllAttributes

public java.util.Iterator getAllAttributes()

Description copied from interface: OMElement

This will return a List of OMAttributes.

Note that the iterator returned by this function will be invalidated by any addAttribute call.

Specified by:

getAllAttributes in interface OMElement

Returns:

Returns an Iterator of OMAttribute items associated with the element.

See Also:

OMElement.getAllAttributes()

getLocalName

public java.lang.String getLocalName()

Returns the local name of this element node

Specified by:

getLocalName in interface org.w3c.dom.Node

Overrides:

getLocalName in class NodeImpl

See Also:

Node.getLocalName()

getPrefix

public java.lang.String getPrefix()

returns the namespace prefix of this element node

Specified by:

getPrefix in interface org.w3c.dom.Node

Overrides:

getPrefix in class NodeImpl

See Also:

Node.getPrefix()

setOwnerDocument

protected void setOwnerDocument(DocumentImpl document)

Description copied from class: NodeImpl

sets the owner document

Overrides:

setOwnerDocument in class NodeImpl

Parameters:

document -

See Also:

NodeImpl.setOwnerDocument(org.apache.axis2.om.impl.dom.DocumentImpl)

resolveQName

public javax.xml.namespace.QName resolveQName(java.lang.String qname)

Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context unprefixed qnames resolve to the local namespace

Specified by:

resolveQName in interface OMElement

Parameters:

qname - prefixed qname string to resolve

Returns:

null for any failure to extract a qname.

cloneOMElement

public OMElement cloneOMElement()

Description copied from interface: OMElement

This method will clone this element. But both elements will be build compleletely. So you will lose the differed building capability.

Specified by:

cloneOMElement in interface OMElement

Returns:

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

This will return the set of attributes of this node and the namespace declarations available

Specified by:

getAttributes in interface org.w3c.dom.Node

Overrides:

getAttributes in class NodeImpl

See Also:

ElementImpl

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

return the namespace uri, given the prefix

Parameters:

prefix -

Returns:

namespace

removeNamespace

public boolean removeNamespace(java.lang.String prefix)

Remove a declared namespace give its prefix

Parameters:

prefix -

Returns:

whether the namespace relevant to the given prefix was removed or not

getSchemaTypeInfo

public org.w3c.dom.TypeInfo getSchemaTypeInfo()

setIdAttribute

public void setIdAttribute(java.lang.String arg0,
                           boolean arg1)
                    throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setIdAttributeNode

public void setIdAttributeNode(org.w3c.dom.Attr arg0,
                               boolean arg1)
                        throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setIdAttributeNS

public void setIdAttributeNS(java.lang.String arg0,
                             java.lang.String arg1,
                             boolean arg2)
                      throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException