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

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

All Implemented Interfaces:

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

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.axiom.om.Element interfaces.

Field Summary

protected java.lang.String	localName
protected OMNamespace	namespace

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

firstChild, lastChild

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

nextSibling, parentNode, previousSibling

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

builder, done, factory, FIRSTCHILD, flags, 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_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

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

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

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

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

ElementImpl(OMFactory factory)

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

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

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

Method Summary

OMAttribute	addAttribute(OMAttribute attr) Adds 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
void	buildWithAttachments() Parses this node and builds the object structure in memory.
org.w3c.dom.Node	cloneNode(boolean deep)
OMElement	cloneOMElement() Creates a clone which belongs to a new document.
OMNamespace	declareDefaultNamespace(java.lang.String uri) We use "" to store the default namespace of this element.
OMNamespace	declareNamespace(OMNamespace namespace) Allows overriding an existing declaration if the same prefix was used.
OMNamespace	declareNamespace(java.lang.String uri, java.lang.String prefix) Allows overriding an existing declaration if the same prefix was used.
void	discard() Discards a node.
OMNamespace	findNamespace(java.lang.String uri, java.lang.String prefix) Finds a namespace with the given uri and prefix, in the scope of the hierarchy.
OMNamespace	findNamespaceURI(java.lang.String prefix) Checks for a namespace in the context of this element with the given prefix and returns the relevant namespace object, if available.
java.util.Iterator	getAllAttributes() Returns 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) Looks in the local list of attributes and returns if found.
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 attribute 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() Returns the set of attributes of this node and the namespace declarations available.
java.lang.String	getAttributeValue(javax.xml.namespace.QName qname) Returns 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.
OMNamespace	getDefaultNamespace() This will retrieve the default namespace of this element, if available.
org.w3c.dom.NodeList	getElementsByTagName(java.lang.String name)
org.w3c.dom.NodeList	getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
OMElement	getFirstElement() Returns the first Element node.
int	getLineNumber()
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) Returns the namespace uri, given the prefix.
OMNode	getNextOMSibling() Default behavior returns null, overriden in ChildNode.
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() Gets all the text children and concatinates them to a single string.
javax.xml.namespace.QName	getTextAsQName() OMText can contain its information as a QName as well.
java.lang.String	getTrimmedText()
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 attribute is available or not.
boolean	hasAttributes() Returns whether this element contains any attribute or not.
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer) Serializes the node with caching.
protected void	internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache)
void	internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer) Serializes the node without caching.
void	removeAttribute(OMAttribute attr) Removes an attribute from 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) Removes a declared namespace given 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	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 name, boolean isId)
void	setIdAttributeNode(org.w3c.dom.Attr idAttr, boolean isId)
void	setIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean isId)
void	setLineNumber(int lineNumber)
void	setLocalName(java.lang.String localName) Sets the local name.
void	setNamespace(OMNamespace namespace) Sets the namespace.
void	setNamespaceWithNoFindInCurrentScope(OMNamespace namespace) This will not search the namespace in the scope nor will declare in the current element, as in setNamespace(OMNamespace).
protected void	setOwnerDocument(DocumentImpl document) Sets the owner document.
void	setText(javax.xml.namespace.QName text)
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 debugging.
java.lang.String	toStringWithConsume() This is a convenience method only.

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

addChild, buildNext, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, getTextContent, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

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

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

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

appendChild, build, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getOwnerDocument, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setPrefix, 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, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

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

setFirstChild

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

build, close, detach, getOMFactory, getParent, getPreviousOMSibling, 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

Field Detail

namespace

protected OMNamespace namespace

localName

protected java.lang.String localName

Constructor Detail

ElementImpl

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

Parameters:

ownerDocument -

ElementImpl

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

Creates a new element with the namespace.

Parameters:

ownerDocument -

tagName -

ns -

ElementImpl

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

ElementImpl

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

ElementImpl

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

ElementImpl

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

ElementImpl

public ElementImpl(OMFactory factory)

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:

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(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 attribute is available or not.

Specified by:

hasAttributeNS in interface org.w3c.dom.Element

See Also:

Element.hasAttributeNS(String, String)

getAttribute

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

Looks in the local list of attributes and returns if found. If the local list is null, returns "".

Specified by:

getAttribute in interface org.w3c.dom.Element

See Also:

Element.getAttribute(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(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(String, String)

getAttributeNodeNS

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

Retrieves an attribute node by local name and namespace URI.

Specified by:

getAttributeNodeNS in interface org.w3c.dom.Element

See Also:

Element.getAttributeNodeNS(String, 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(String, String, String)

hasAttributes

public boolean hasAttributes()

Returns whether this element contains any attribute 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

Adds 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:

Returns the passed in attribute.

See Also:

(org.apache.axiom.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:

Returns the added attribute.

See Also:

OMElement.addAttribute(String, String, org.apache.axiom.om.OMNamespace)

declareNamespace

public OMNamespace declareNamespace(OMNamespace namespace)

Allows overriding an existing declaration if the same prefix was used.

Specified by:

declareNamespace in interface OMElement

Parameters:

namespace - The namespace to declare.

Returns:

Returns the namespace parameter passed.

See Also:

(org.apache.axiom.om.OMNamespace)

declareNamespace

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

Allows 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. If "" is given, first this will check for an existing namespace with the same uri. If not found, a prefix will be auto-generated.

Returns:

Returns the created namespace information item.

See Also:

OMElement.declareNamespace(String, String)

declareDefaultNamespace

public OMNamespace declareDefaultNamespace(java.lang.String uri)

We use "" to store the default namespace of this element. As one can see user can not give "" as the prefix, when he declare a usual namespace.

Specified by:

declareDefaultNamespace in interface OMElement

Parameters:

uri -

getDefaultNamespace

public OMNamespace getDefaultNamespace()

Description copied from interface: OMElement

This will retrieve the default namespace of this element, if available. null returned if none is found.

Specified by:

getDefaultNamespace in interface OMElement

findNamespace

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

Description copied from interface: OMElement

Finds a namespace with the given uri and prefix, in the scope of the hierarchy.

Searches from the current element and goes up the hiararchy until a match is found. If no match is found, returns 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:

Returns the matching namespace declaration, or null if none was found.

See Also:

OMElement.findNamespace(String, String)

findNamespaceURI

public OMNamespace findNamespaceURI(java.lang.String prefix)

Description copied from interface: OMElement

Checks for a namespace in the context of this element with the given prefix and returns the relevant namespace object, if available. If not available, returns null.

Specified by:

findNamespaceURI in interface OMElement

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:

Returns an OMAttribute with the given name if found, or null

See Also:

(javax.xml.namespace.QName)

getAttributeValue

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

Returns a named attribute's value, if present.

Specified by:

getAttributeValue in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

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:

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

getFirstElement

public OMElement getFirstElement()

Returns the first Element node.

Specified by:

getFirstElement in interface OMElement

Returns:

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:

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:

Returns the QName for the element.

See Also:

OMElement.getQName()

getText

public java.lang.String getText()

Gets all the text children and concatinates them to a single string.

Specified by:

getText in interface OMElement

Returns:

A string representing the concatenation of the child text nodes. If there are no child text nodes, an empty string is returned.

See Also:

OMElement.getText()

getTextAsQName

public javax.xml.namespace.QName getTextAsQName()

Description copied from interface: OMElement

OMText can contain its information as a QName as well. This will return the text as a QName

Specified by:

getTextAsQName in interface OMElement

getTrimmedText

public java.lang.String getTrimmedText()

removeAttribute

public void removeAttribute(OMAttribute attr)

Removes an attribute from the element.

Specified by:

removeAttribute in interface OMElement

See Also:

(org.apache.axiom.om.OMAttribute)

setBuilder

public void setBuilder(OMXMLParserWrapper wrapper)

Sets the OM builder.

Specified by:

setBuilder in interface OMElement

See Also:

(org.apache.axiom.om.OMXMLParserWrapper)

setLocalName

public void setLocalName(java.lang.String localName)

Sets the local name.

Specified by:

setLocalName in interface OMElement

See Also:

OMElement.setLocalName(String)

setNamespace

public void setNamespace(OMNamespace namespace)

Sets the namespace.

Specified by:

setNamespace in interface OMElement

See Also:

(org.apache.axiom.om.OMNamespace)

setNamespaceWithNoFindInCurrentScope

public void setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)

Description copied from interface: OMElement

This will not search the namespace in the scope nor will declare in the current element, as in setNamespace(OMNamespace). This will just assign the given namespace to the element.

Specified by:

setNamespaceWithNoFindInCurrentScope in interface OMElement

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

See Also:

OMElement.setText(String)

setText

public void setText(javax.xml.namespace.QName text)

Specified by:

setText in interface OMElement

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer)
                       throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serializes the node with caching.

Specified by:

internalSerialize in interface OMNodeEx

Throws:

javax.xml.stream.XMLStreamException

internalSerializeAndConsume

public void internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
                                 throws javax.xml.stream.XMLStreamException

Description copied from interface: OMNodeEx

Serializes the node without caching.

Specified by:

internalSerializeAndConsume in interface OMNodeEx

Throws:

javax.xml.stream.XMLStreamException

internalSerialize

protected void internalSerialize(javax.xml.stream.XMLStreamWriter writer,
                                 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:

Returns 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:

Returns 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 basically serializes 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 debugging.

Specified by:

toString in interface OMElement

Overrides:

toString in class java.lang.Object

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:

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:

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

Returns 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 OMElement

Specified by:

getLocalName in interface org.w3c.dom.Node

Overrides:

getLocalName in class NodeImpl

Returns:

Returns the local name of the element.

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

See Also:

(org.apache.axiom.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:

Returns null for any failure to extract a qname.

cloneOMElement

public OMElement cloneOMElement()

Creates a clone which belongs to a new document.

Specified by:

cloneOMElement in interface OMElement

Returns:

Returns OMElement.

See Also:

OMElement.cloneOMElement()

setLineNumber

public void setLineNumber(int lineNumber)

Specified by:

setLineNumber in interface OMElement

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface OMElement

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

Specified by:

cloneNode in interface org.w3c.dom.Node

Overrides:

cloneNode in class ParentNode

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

Returns 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)

Returns the namespace uri, given the prefix. If it is not found at this element, searches the parent.

Parameters:

prefix -

Returns:

Returns namespace.

removeNamespace

public boolean removeNamespace(java.lang.String prefix)

Removes a declared namespace given its prefix.

Parameters:

prefix -

Returns:

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

getNextOMSibling

public OMNode getNextOMSibling()
                        throws OMException

Description copied from class: NodeImpl

Default behavior returns null, overriden in ChildNode.

Specified by:

getNextOMSibling in interface OMNode

Overrides:

getNextOMSibling in class ChildNode

Returns:

Returns the next sibling in document order.

Throws:

OMException

discard

public void discard()
             throws OMException

Description copied from interface: OMNode

Discards a node.

Discard goes to the parser level and if the element is not completely built, then it will be completely skipped at the parser level.

Specified by:

discard in interface OMNode

Overrides:

discard in class ChildNode

Throws:

OMException

setIdAttribute

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

Specified by:

setIdAttribute in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setIdAttributeNS

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

Specified by:

setIdAttributeNS in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

setIdAttributeNode

public void setIdAttributeNode(org.w3c.dom.Attr idAttr,
                               boolean isId)
                        throws org.w3c.dom.DOMException

Specified by:

setIdAttributeNode in interface org.w3c.dom.Element

Throws:

org.w3c.dom.DOMException

getSchemaTypeInfo

public org.w3c.dom.TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface org.w3c.dom.Element

buildWithAttachments

public void buildWithAttachments()

Description copied from class: NodeImpl

Parses this node and builds the object structure in memory. AXIOM supports two levels of deffered building. First is deffered building of AXIOM using StAX. Second level is the deffered building of attachments. AXIOM reads in the attachements from the stream only when user asks by calling getDataHandler(). build() method builds the OM without the attachments. buildAll() builds the OM together with attachement data. This becomes handy when user wants to free the input stream.

Specified by:

buildWithAttachments in interface OMNode

Overrides:

buildWithAttachments in class NodeImpl