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

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axiom.om.impl.dom.ChildNode
          extended by org.apache.axiom.om.impl.dom.ParentNode
              extended by org.apache.axiom.om.impl.dom.ElementImpl
All Implemented Interfaces:
java.lang.Cloneable, 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, 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, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMConstants

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


Field Summary
private  AttributeMap attributes
           
private static org.apache.axiom.om.impl.util.EmptyIterator EMPTY_ITERATOR
           
private  int lineNumber
           
protected  java.lang.String localName
           
protected  org.apache.axiom.om.OMNamespace namespace
           
private  java.util.HashMap namespaces
           
 
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, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName, NamespaceImpl ns, org.apache.axiom.om.OMFactory factory)
          Creates a new element with the namespace.
ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName, NamespaceImpl ns, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.om.OMFactory factory)
           
ElementImpl(DocumentImpl ownerDocument, java.lang.String tagName, org.apache.axiom.om.OMFactory factory)
           
ElementImpl(org.apache.axiom.om.OMFactory factory)
           
ElementImpl(ParentNode parentNode, java.lang.String tagName, NamespaceImpl ns, org.apache.axiom.om.OMFactory factory)
           
ElementImpl(ParentNode parentNode, java.lang.String tagName, NamespaceImpl ns, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.om.OMFactory factory)
           
ElementImpl(java.lang.String tagName, NamespaceImpl ns, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.om.OMFactory factory)
           
 
Method Summary
 org.apache.axiom.om.OMAttribute addAttribute(org.apache.axiom.om.OMAttribute attr)
           
 org.apache.axiom.om.OMAttribute addAttribute(java.lang.String attributeName, java.lang.String value, org.apache.axiom.om.OMNamespace ns)
          The behaviour of this is the same as org.w3c.dom.Element#setAttributeNS
private  org.apache.axiom.om.OMAttribute addAttribute(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)
           
 void buildWithAttachments()
          Parses this node and builds the object structure in memory.
 org.w3c.dom.Node cloneNode(boolean deep)
           
 org.apache.axiom.om.OMElement cloneOMElement()
          Creates a clone which belongs to a new document.
 org.apache.axiom.om.OMNamespace declareDefaultNamespace(java.lang.String uri)
          We use "" to store the default namespace of this element.
 org.apache.axiom.om.OMNamespace declareNamespace(org.apache.axiom.om.OMNamespace namespace)
          Allows overriding an existing declaration if the same prefix was used.
 org.apache.axiom.om.OMNamespace declareNamespace(java.lang.String uri, java.lang.String prefix)
          Allows overriding an existing declaration if the same prefix was used.
 void discard()
           
private  org.apache.axiom.om.OMNamespace findDeclaredNamespace(java.lang.String uri, java.lang.String prefix)
          Checks for the namespace only in the current Element.
 org.apache.axiom.om.OMNamespace findNamespace(java.lang.String uri, java.lang.String prefix)
           
 org.apache.axiom.om.OMNamespace findNamespaceURI(java.lang.String prefix)
           
 java.util.Iterator getAllAttributes()
           
 java.util.Iterator getAllDeclaredNamespaces()
           
 org.apache.axiom.om.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.
 org.apache.axiom.om.OMXMLParserWrapper getBuilder()
           
 java.util.Iterator getChildElements()
           
 org.apache.axiom.om.OMNamespace getDefaultNamespace()
           
 org.w3c.dom.NodeList getElementsByTagName(java.lang.String name)
           
 org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
           
 org.apache.axiom.om.OMElement getFirstElement()
          Returns the first Element node.
 int getLineNumber()
           
 java.lang.String getLocalName()
          Returns the local name of this element node
 org.apache.axiom.om.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.
 org.apache.axiom.om.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()
           
 java.lang.String getTrimmedText()
           
 int getType()
           
 javax.xml.stream.XMLStreamReader getXMLStreamReader()
           
private  javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache)
          getXMLStreamReader
 javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()
           
 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)
           
protected  void internalSerialize(javax.xml.stream.XMLStreamWriter writer, boolean cache)
           
 void internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
           
 void removeAttribute(org.apache.axiom.om.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(org.apache.axiom.om.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(org.apache.axiom.om.OMNamespace namespace)
          Sets the namespace.
 void setNamespaceWithNoFindInCurrentScope(org.apache.axiom.om.OMNamespace namespace)
           
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()
           
private  void updateIsId(boolean isId, AttrImpl tempAttr)
          Updates the id state of the attr and notifies the document
 
Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode
addChild, buildNext, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild
 
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, getTextContent, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isFirstChild, isFirstChild, isNormalized, isNormalized, isOwned, isOwned, isReadonly, isReadonly, isSameNode, isSpecified, isSpecified, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, parentNode, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, 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, 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

lineNumber

private int lineNumber

namespace

protected org.apache.axiom.om.OMNamespace namespace

localName

protected java.lang.String localName

attributes

private AttributeMap attributes

namespaces

private java.util.HashMap namespaces

EMPTY_ITERATOR

private static final org.apache.axiom.om.impl.util.EmptyIterator EMPTY_ITERATOR
Constructor Detail

ElementImpl

public ElementImpl(DocumentImpl ownerDocument,
                   java.lang.String tagName,
                   org.apache.axiom.om.OMFactory factory)
Parameters:
ownerDocument -

ElementImpl

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

Parameters:
ownerDocument -
tagName -
ns -

ElementImpl

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

ElementImpl

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

ElementImpl

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

ElementImpl

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

ElementImpl

public ElementImpl(org.apache.axiom.om.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 org.apache.axiom.om.OMException
Specified by:
getType in interface org.apache.axiom.om.OMNode
Throws:
org.apache.axiom.om.OMException

setType

public void setType(int nodeType)
             throws org.apache.axiom.om.OMException
Specified by:
setType in interface org.apache.axiom.om.impl.OMNodeEx
Throws:
org.apache.axiom.om.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)

addAttribute

private org.apache.axiom.om.OMAttribute addAttribute(java.lang.String namespaceURI,
                                                     java.lang.String qualifiedName,
                                                     java.lang.String value)
                                              throws org.w3c.dom.DOMException
Throws:
org.w3c.dom.DOMException

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 org.apache.axiom.om.OMAttribute addAttribute(org.apache.axiom.om.OMAttribute attr)
Specified by:
addAttribute in interface org.apache.axiom.om.OMElement
See Also:
(org.apache.axiom.om.OMAttribute)

addAttribute

public org.apache.axiom.om.OMAttribute addAttribute(java.lang.String attributeName,
                                                    java.lang.String value,
                                                    org.apache.axiom.om.OMNamespace ns)
The behaviour of this is the same as org.w3c.dom.Element#setAttributeNS

Specified by:
addAttribute in interface org.apache.axiom.om.OMElement
See Also:
OMElement.addAttribute(String, String, org.apache.axiom.om.OMNamespace)

declareNamespace

public org.apache.axiom.om.OMNamespace declareNamespace(org.apache.axiom.om.OMNamespace namespace)
Allows overriding an existing declaration if the same prefix was used.

Specified by:
declareNamespace in interface org.apache.axiom.om.OMElement
See Also:
(org.apache.axiom.om.OMNamespace)

declareNamespace

public org.apache.axiom.om.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 org.apache.axiom.om.OMElement
See Also:
OMElement.declareNamespace(String, String)

declareDefaultNamespace

public org.apache.axiom.om.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 org.apache.axiom.om.OMElement
Parameters:
uri -

getDefaultNamespace

public org.apache.axiom.om.OMNamespace getDefaultNamespace()
Specified by:
getDefaultNamespace in interface org.apache.axiom.om.OMElement

findNamespace

public org.apache.axiom.om.OMNamespace findNamespace(java.lang.String uri,
                                                     java.lang.String prefix)
Specified by:
findNamespace in interface org.apache.axiom.om.OMElement
See Also:
OMElement.findNamespace(String, String)

findNamespaceURI

public org.apache.axiom.om.OMNamespace findNamespaceURI(java.lang.String prefix)
Specified by:
findNamespaceURI in interface org.apache.axiom.om.OMElement

findDeclaredNamespace

private org.apache.axiom.om.OMNamespace findDeclaredNamespace(java.lang.String uri,
                                                              java.lang.String prefix)
Checks for the namespace only in the current Element. This can also be used to retrieve the prefix of a known namespace URI.


getAttribute

public org.apache.axiom.om.OMAttribute getAttribute(javax.xml.namespace.QName qname)
Returns a named attribute if present.

Specified by:
getAttribute in interface org.apache.axiom.om.OMElement
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 org.apache.axiom.om.OMElement
Parameters:
qname - the qualified name to search for
Returns:
Returns a String containing the attribute value, or null.

getBuilder

public org.apache.axiom.om.OMXMLParserWrapper getBuilder()
Specified by:
getBuilder in interface org.apache.axiom.om.OMElement

getFirstElement

public org.apache.axiom.om.OMElement getFirstElement()
Returns the first Element node.

Specified by:
getFirstElement in interface org.apache.axiom.om.OMElement
See Also:
OMElement.getFirstElement()

getNamespace

public org.apache.axiom.om.OMNamespace getNamespace()
                                             throws org.apache.axiom.om.OMException
Returns the namespace of this element.

Specified by:
getNamespace in interface org.apache.axiom.om.OMElement
Throws:
org.apache.axiom.om.OMException
See Also:
OMElement.getNamespace()

getQName

public javax.xml.namespace.QName getQName()
Returns the QName of this element.

Specified by:
getQName in interface org.apache.axiom.om.OMElement
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 org.apache.axiom.om.OMElement
See Also:
OMElement.getText()

getTextAsQName

public javax.xml.namespace.QName getTextAsQName()
Specified by:
getTextAsQName in interface org.apache.axiom.om.OMElement

getTrimmedText

public java.lang.String getTrimmedText()

removeAttribute

public void removeAttribute(org.apache.axiom.om.OMAttribute attr)
Removes an attribute from the element.

Specified by:
removeAttribute in interface org.apache.axiom.om.OMElement
See Also:
(org.apache.axiom.om.OMAttribute)

setBuilder

public void setBuilder(org.apache.axiom.om.OMXMLParserWrapper wrapper)
Sets the OM builder.

Specified by:
setBuilder in interface org.apache.axiom.om.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 org.apache.axiom.om.OMElement
See Also:
OMElement.setLocalName(String)

setNamespace

public void setNamespace(org.apache.axiom.om.OMNamespace namespace)
Sets the namespace.

Specified by:
setNamespace in interface org.apache.axiom.om.OMElement
See Also:
(org.apache.axiom.om.OMNamespace)

setNamespaceWithNoFindInCurrentScope

public void setNamespaceWithNoFindInCurrentScope(org.apache.axiom.om.OMNamespace namespace)
Specified by:
setNamespaceWithNoFindInCurrentScope in interface org.apache.axiom.om.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 org.apache.axiom.om.OMElement
See Also:
OMElement.setText(String)

setText

public void setText(javax.xml.namespace.QName text)
Specified by:
setText in interface org.apache.axiom.om.OMElement

internalSerialize

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer)
                       throws javax.xml.stream.XMLStreamException
Specified by:
internalSerialize in interface org.apache.axiom.om.impl.OMNodeEx
Throws:
javax.xml.stream.XMLStreamException

internalSerializeAndConsume

public void internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer)
                                 throws javax.xml.stream.XMLStreamException
Specified by:
internalSerializeAndConsume in interface org.apache.axiom.om.impl.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()
Specified by:
getXMLStreamReaderWithoutCaching in interface org.apache.axiom.om.OMElement

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()
Specified by:
getXMLStreamReader in interface org.apache.axiom.om.OMElement

getXMLStreamReader

private javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache)
getXMLStreamReader

Returns:
Returns reader.

toStringWithConsume

public java.lang.String toStringWithConsume()
                                     throws javax.xml.stream.XMLStreamException
Specified by:
toStringWithConsume in interface org.apache.axiom.om.OMElement
Throws:
javax.xml.stream.XMLStreamException

toString

public java.lang.String toString()
Overridden toString() for ease of debugging.

Specified by:
toString in interface org.apache.axiom.om.OMElement
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

getChildElements

public java.util.Iterator getChildElements()
Specified by:
getChildElements in interface org.apache.axiom.om.OMElement

getAllDeclaredNamespaces

public java.util.Iterator getAllDeclaredNamespaces()
                                            throws org.apache.axiom.om.OMException
Specified by:
getAllDeclaredNamespaces in interface org.apache.axiom.om.OMElement
Throws:
org.apache.axiom.om.OMException
See Also:
OMElement.getAllDeclaredNamespaces()

getAllAttributes

public java.util.Iterator getAllAttributes()
Specified by:
getAllAttributes in interface org.apache.axiom.om.OMElement
See Also:
OMElement.getAllAttributes()

getLocalName

public java.lang.String getLocalName()
Returns the local name of this element node

Specified by:
getLocalName in interface org.apache.axiom.om.OMElement
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
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 org.apache.axiom.om.OMElement
Parameters:
qname - prefixed qname string to resolve
Returns:
Returns null for any failure to extract a qname.

cloneOMElement

public org.apache.axiom.om.OMElement cloneOMElement()
Creates a clone which belongs to a new document.

Specified by:
cloneOMElement in interface org.apache.axiom.om.OMElement
See Also:
OMElement.cloneOMElement()

setLineNumber

public void setLineNumber(int lineNumber)
Specified by:
setLineNumber in interface org.apache.axiom.om.OMElement

getLineNumber

public int getLineNumber()
Specified by:
getLineNumber in interface org.apache.axiom.om.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 org.apache.axiom.om.OMNode getNextOMSibling()
                                            throws org.apache.axiom.om.OMException
Description copied from class: NodeImpl
Default behavior returns null, overriden in ChildNode.

Specified by:
getNextOMSibling in interface org.apache.axiom.om.OMNode
Overrides:
getNextOMSibling in class ChildNode
Throws:
org.apache.axiom.om.OMException

discard

public void discard()
             throws org.apache.axiom.om.OMException
Specified by:
discard in interface org.apache.axiom.om.OMNode
Overrides:
discard in class ChildNode
Throws:
org.apache.axiom.om.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

updateIsId

private void updateIsId(boolean isId,
                        AttrImpl tempAttr)
Updates the id state of the attr and notifies the document

Parameters:
isId -
tempAttr -

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 org.apache.axiom.om.OMNode
Overrides:
buildWithAttachments in class NodeImpl