org.apache.axis2.saaj

Class SAAJNode<T extends org.w3c.dom.Node,S extends org.apache.axiom.om.OMNode>

java.lang.Object

org.apache.axis2.saaj.SAAJNode<T,S>

All Implemented Interfaces:

org.w3c.dom.Node

Direct Known Subclasses:

SOAPElementImpl, TextImplEx

public abstract class SAAJNode<T extends org.w3c.dom.Node,S extends org.apache.axiom.om.OMNode>
extends java.lang.Object
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

Fields

Modifier and Type	Field and Description
protected S	omTarget
protected javax.xml.soap.SOAPElement	parentElement
protected T	target

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

Constructors

Constructor and Description
SAAJNode(T target, S omTarget)

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Node	appendChild(org.w3c.dom.Node child)
protected org.w3c.dom.Element	appendElement(org.w3c.dom.Element child)
protected org.w3c.dom.Text	appendText(org.w3c.dom.Text child)
org.w3c.dom.Node	cloneNode(boolean deep)
short	compareDocumentPosition(org.w3c.dom.Node other)
org.apache.axiom.om.OMNode	detach()
void	detachNode() Removes this Node object from the tree.
org.w3c.dom.NamedNodeMap	getAttributes()
java.lang.String	getBaseURI()
org.w3c.dom.NodeList	getChildNodes()
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild()
org.w3c.dom.Node	getLastChild()
java.lang.String	getLocalName()
java.lang.String	getNamespaceURI()
java.lang.String	getNodeName()
short	getNodeType()
java.lang.String	getNodeValue()
S	getOMTarget()
org.w3c.dom.Document	getOwnerDocument()
org.apache.axiom.om.OMContainer	getParent()
javax.xml.soap.SOAPElement	getParentElement() Removes this Node object from the tree.
org.w3c.dom.Node	getParentNode()
java.lang.String	getPrefix()
org.w3c.dom.TypeInfo	getSchemaTypeInfo()
T	getTarget()
java.lang.String	getTextContent()
int	getType()
java.lang.Object	getUserData(java.lang.String key)
boolean	hasAttributes()
boolean	hasChildNodes()
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node arg)
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String feature, java.lang.String version)
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalize()
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.
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild)
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
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	setNodeValue(java.lang.String nodeValue)
void	setParentElement(javax.xml.soap.SOAPElement parent) Sets the parent of this Node object to the given SOAPElement object.
void	setPrefix(java.lang.String prefix)
void	setTextContent(java.lang.String textContent)
void	setType(int nodeType)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
protected org.w3c.dom.NodeList	toSAAJNodeList(org.w3c.dom.NodeList nodes)

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

getValue, setValue

Methods inherited from interface org.w3c.dom.Node

getNextSibling, getPreviousSibling

Field Detail

target

protected final T extends org.w3c.dom.Node target

omTarget

protected final S extends org.apache.axiom.om.OMNode omTarget

parentElement

protected javax.xml.soap.SOAPElement parentElement

Constructor Detail

SAAJNode

public SAAJNode(T target,
        S omTarget)

Method Detail

getTarget

public final T getTarget()

getOMTarget

public final S getOMTarget()

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

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

hasAttributes

public final boolean hasAttributes()

Specified by:

hasAttributes in interface org.w3c.dom.Node

isSupported

public final boolean isSupported(java.lang.String feature,
                  java.lang.String version)

Specified by:

isSupported in interface org.w3c.dom.Node

getBaseURI

public final java.lang.String getBaseURI()

Specified by:

getBaseURI in interface org.w3c.dom.Node

getNodeValue

public final java.lang.String getNodeValue()
                                    throws org.w3c.dom.DOMException

Specified by:

getNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setNodeValue

public final void setNodeValue(java.lang.String nodeValue)
                        throws org.w3c.dom.DOMException

Specified by:

setNodeValue in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

insertBefore

public final org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                            org.w3c.dom.Node refChild)
                                    throws org.w3c.dom.DOMException

Specified by:

insertBefore in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

replaceChild

public final org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                            org.w3c.dom.Node oldChild)
                                    throws org.w3c.dom.DOMException

Specified by:

replaceChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

cloneNode

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

Specified by:

cloneNode in interface org.w3c.dom.Node

normalize

public final void normalize()

Specified by:

normalize in interface org.w3c.dom.Node

setPrefix

public final void setPrefix(java.lang.String prefix)
                     throws org.w3c.dom.DOMException

Specified by:

setPrefix in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

compareDocumentPosition

public final short compareDocumentPosition(org.w3c.dom.Node other)
                                    throws org.w3c.dom.DOMException

Specified by:

compareDocumentPosition in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

setTextContent

public final void setTextContent(java.lang.String textContent)
                          throws org.w3c.dom.DOMException

Specified by:

setTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isSameNode

public final boolean isSameNode(org.w3c.dom.Node other)

Specified by:

isSameNode in interface org.w3c.dom.Node

lookupPrefix

public final java.lang.String lookupPrefix(java.lang.String namespaceURI)

Specified by:

lookupPrefix in interface org.w3c.dom.Node

isDefaultNamespace

public final boolean isDefaultNamespace(java.lang.String namespaceURI)

Specified by:

isDefaultNamespace in interface org.w3c.dom.Node

lookupNamespaceURI

public final java.lang.String lookupNamespaceURI(java.lang.String prefix)

Specified by:

lookupNamespaceURI in interface org.w3c.dom.Node

isEqualNode

public final boolean isEqualNode(org.w3c.dom.Node arg)

Specified by:

isEqualNode in interface org.w3c.dom.Node

getFeature

public final java.lang.Object getFeature(java.lang.String feature,
                          java.lang.String version)

Specified by:

getFeature in interface org.w3c.dom.Node

setUserData

public final java.lang.Object setUserData(java.lang.String key,
                           java.lang.Object data,
                           org.w3c.dom.UserDataHandler handler)

Specified by:

setUserData in interface org.w3c.dom.Node

getUserData

public final java.lang.Object getUserData(java.lang.String key)

Specified by:

getUserData in interface org.w3c.dom.Node

removeChild

public final org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                                   throws org.w3c.dom.DOMException

Specified by:

removeChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getNodeName

public final java.lang.String getNodeName()

Specified by:

getNodeName in interface org.w3c.dom.Node

getNodeType

public final short getNodeType()

Specified by:

getNodeType in interface org.w3c.dom.Node

getOwnerDocument

public final org.w3c.dom.Document getOwnerDocument()

Specified by:

getOwnerDocument in interface org.w3c.dom.Node

getLocalName

public final java.lang.String getLocalName()

Specified by:

getLocalName in interface org.w3c.dom.Node

getNamespaceURI

public final java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface org.w3c.dom.Node

getPrefix

public final java.lang.String getPrefix()

Specified by:

getPrefix in interface org.w3c.dom.Node

getFirstChild

public final org.w3c.dom.Node getFirstChild()

Specified by:

getFirstChild in interface org.w3c.dom.Node

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface org.w3c.dom.Node

getLastChild

public final org.w3c.dom.Node getLastChild()

Specified by:

getLastChild in interface org.w3c.dom.Node

toSAAJNodeList

protected final org.w3c.dom.NodeList toSAAJNodeList(org.w3c.dom.NodeList nodes)

getChildNodes

public final org.w3c.dom.NodeList getChildNodes()

Specified by:

getChildNodes in interface org.w3c.dom.Node

appendChild

public final org.w3c.dom.Node appendChild(org.w3c.dom.Node child)
                                   throws org.w3c.dom.DOMException

Specified by:

appendChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

appendText

protected org.w3c.dom.Text appendText(org.w3c.dom.Text child)
                               throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

appendElement

protected org.w3c.dom.Element appendElement(org.w3c.dom.Element child)
                                     throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

getTextContent

public final java.lang.String getTextContent()
                                      throws org.w3c.dom.DOMException

Specified by:

getTextContent in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

getAttributes

public final org.w3c.dom.NamedNodeMap getAttributes()

Specified by:

getAttributes in interface org.w3c.dom.Node