org.apache.axis2.saaj
Class NodeImplEx

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axis2.saaj.NodeImplEx

All Implemented Interfaces:

java.lang.Cloneable, org.w3c.dom.Node, org.w3c.dom.NodeList

Direct Known Subclasses:

SOAPElementImpl, TextImplEx

public abstract class NodeImplEx
extends org.apache.axiom.om.impl.dom.NodeImpl
implements javax.xml.soap.Node

A representation of a node (element) in a DOM representation of an XML document that provides some tree manipulation methods. This interface provides methods for getting the value of a node, for getting and setting the parent of a node, and for removing a node.

Field Summary

protected javax.xml.soap.SOAPElement

parentElement

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

builder, done, factory, FIRSTCHILD, flags, HAS_PARENT, 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

Constructor Summary

protected

NodeImplEx(org.apache.axiom.om.OMFactory factory)

Method Summary

org.apache.axiom.om.OMNode	detach()
void	detachNode() Removes this Node object from the tree.
org.apache.axiom.om.OMContainer	getParent()
javax.xml.soap.SOAPElement	getParentElement() Removes this Node object from the tree.
org.w3c.dom.Node	getParentNode()
org.w3c.dom.TypeInfo	getSchemaTypeInfo()
int	getType()
java.lang.String	getValue() Returns the the value of the immediate child of this Node object if a child exists and its valu e is text.
void	recycleNode() Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.
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	setParentElement(javax.xml.soap.SOAPElement parent) Sets the parent of this Node object to the given SOAPElement object.
void	setType(int nodeType)

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

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOMFactory, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.soap.Node

setValue

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

parentElement

protected javax.xml.soap.SOAPElement parentElement

Constructor Detail

NodeImplEx

protected NodeImplEx(org.apache.axiom.om.OMFactory factory)

Parameters:

factory -

Method Detail

detachNode

public void detachNode()

Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.

detach

public org.apache.axiom.om.OMNode detach()

getParentElement

public javax.xml.soap.SOAPElement getParentElement()

Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.

getParent

public org.apache.axiom.om.OMContainer getParent()

getValue

public java.lang.String getValue()

Returns the the value of the immediate child of this Node object if a child exists and its valu e is text.

Returns:

a String with the text of the immediate child of this Node object if (1) there is a child and (2) the child is a Text object; null otherwise

recycleNode

public void recycleNode()

Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.

Calling the method recycleNode implies that the method detachNode has been called previously.

setParentElement

public void setParentElement(javax.xml.soap.SOAPElement parent)
                      throws javax.xml.soap.SOAPException

Sets the parent of this Node object to the given SOAPElement object.

Parameters:

parent - the SOAPElement object to be set as the parent of this Node object

Throws:

javax.xml.soap.SOAPException - if there is a problem in setting the parent to the given element

See Also:

getParentElement()

setType

public void setType(int nodeType)
             throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

getType

public int getType()

getSchemaTypeInfo

public org.w3c.dom.TypeInfo getSchemaTypeInfo()

setIdAttribute

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

Throws:

org.w3c.dom.DOMException

setIdAttributeNS

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

Throws:

org.w3c.dom.DOMException

setIdAttributeNode

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

Throws:

org.w3c.dom.DOMException

getParentNode

public org.w3c.dom.Node getParentNode()

Specified by:

getParentNode in interface org.w3c.dom.Node