Package com.sun.xml.messaging.saaj.soap

Class SOAPDocumentImpl

java.lang.Object

com.sun.xml.messaging.saaj.soap.SOAPDocumentImpl

All Implemented Interfaces:

SOAPDocument, Node, Document, Node

public class SOAPDocumentImpl
extends Object
implements SOAPDocument, Node, Document

Author:

SAAJ RI Development Team

Field Summary

Fields

Modifier and Type	Field	Description
static String	SAAJ_NODE

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	Description
SOAPDocumentImpl(SOAPPartImpl enclosingDocument)

Method Summary

Modifier and Type	Method	Description
Node	adoptNode(Node source)
Node	appendChild(Node newChild)
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
Attr	createAttribute(String name)
Attr	createAttributeNS(String namespaceURI, String qualifiedName)
CDATASection	createCDATASection(String data)
Comment	createComment(String data)
DocumentFragment	createDocumentFragment()
Element	createElement(String tagName)
Element	createElementNS(String namespaceURI, String qualifiedName)
EntityReference	createEntityReference(String name)
ProcessingInstruction	createProcessingInstruction(String target, String data)
Text	createTextNode(String data)
void	detachNode()	Removes this Node object from the tree.
protected Element	doGetDocumentElement()
Node	find(Node node)	Find a soap wrapper for w3c dom node.
Node	findIfPresent(Node node)	If corresponding soap wrapper exists for w3c dom node it is returned, if not passed dom element is returned.
NamedNodeMap	getAttributes()
String	getBaseURI()
NodeList	getChildNodes()
DocumentType	getDoctype()
SOAPDocumentImpl	getDocument()
Element	getDocumentElement()
String	getDocumentURI()
DOMConfiguration	getDomConfig()
Document	getDomDocument()
Document	getDomElement()
Node	getDomNode(Node node)	Extracts w3c dom node from corresponding soap wrapper.
Element	getElementById(String elementId)
NodeList	getElementsByTagName(String tagname)
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
Object	getFeature(String feature, String version)
Node	getFirstChild()
DOMImplementation	getImplementation()
String	getInputEncoding()
Node	getLastChild()
String	getLocalName()
String	getNamespaceURI()
Node	getNextSibling()
String	getNodeName()
short	getNodeType()
String	getNodeValue()
Document	getOwnerDocument()
SOAPElement	getParentElement()	Returns the parent element of this Node object.
Node	getParentNode()
String	getPrefix()
Node	getPreviousSibling()
SOAPPartImpl	getSOAPPart()
boolean	getStrictErrorChecking()
String	getTextContent()
Object	getUserData(String key)
String	getValue()	Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise.
String	getXmlEncoding()
boolean	getXmlStandalone()
String	getXmlVersion()
boolean	hasAttributes()
boolean	hasChildNodes()
Node	importNode(Node importedNode, boolean deep)
Node	insertBefore(Node newChild, Node refChild)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	normalize()
void	normalizeDocument()
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	register(Node node)	Insert a mapping information for Node - Node.
void	registerChildNodes(Node parentNode, boolean deep)	If the parentNode is not registered to domToSoap, create soap wapper for parentNode and register it to domToSoap If deep = true, also register all children transitively of parentNode to domToSoap map.
Node	removeChild(Node oldChild)
Node	renameNode(Node n, String namespaceURI, String qualifiedName)
Node	replaceChild(Node newChild, Node oldChild)
void	setDocumentURI(String documentURI)
void	setNodeValue(String nodeValue)
void	setParentElement(SOAPElement parent)	Sets the parent of this Node object to the given SOAPElement object.
void	setPrefix(String prefix)
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
void	setValue(String value)	If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node.
void	setXmlStandalone(boolean xmlStandalone)
void	setXmlVersion(String xmlVersion)

Methods inherited from class java.lang.Object

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

Field Detail

SAAJ_NODE

public static final String SAAJ_NODE

See Also:

Constant Field Values

Constructor Detail

SOAPDocumentImpl

public SOAPDocumentImpl(SOAPPartImpl enclosingDocument)

Method Detail

getSOAPPart

public SOAPPartImpl getSOAPPart()

Specified by:

getSOAPPart in interface SOAPDocument

getDocument

public SOAPDocumentImpl getDocument()

Specified by:

getDocument in interface SOAPDocument

getDoctype

public DocumentType getDoctype()

Specified by:

getDoctype in interface Document

getImplementation

public DOMImplementation getImplementation()

Specified by:

getImplementation in interface Document

getDocumentElement

public Element getDocumentElement()

Specified by:

getDocumentElement in interface Document

doGetDocumentElement

protected Element doGetDocumentElement()

createElement

public Element createElement(String tagName)
                      throws DOMException

Specified by:

createElement in interface Document

Throws:

DOMException

createDocumentFragment

public DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface Document

createTextNode

public Text createTextNode(String data)

Specified by:

createTextNode in interface Document

createComment

public Comment createComment(String data)

Specified by:

createComment in interface Document

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)
                                                  throws DOMException

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Specified by:

createAttribute in interface Document

Throws:

DOMException

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Specified by:

createEntityReference in interface Document

Throws:

DOMException

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

Specified by:

getElementsByTagName in interface Document

importNode

public Node importNode(Node importedNode,
                       boolean deep)
                throws DOMException

Specified by:

importNode in interface Document

Throws:

DOMException

registerChildNodes

public void registerChildNodes(Node parentNode,
                               boolean deep)

If the parentNode is not registered to domToSoap, create soap wapper for parentNode and register it to domToSoap If deep = true, also register all children transitively of parentNode to domToSoap map.

Parameters:

parentNode - node to wrap

deep - wrap child nodes transitively

createElementNS

public Element createElementNS(String namespaceURI,
                               String qualifiedName)
                        throws DOMException

Specified by:

createElementNS in interface Document

Throws:

DOMException

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)
                       throws DOMException

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Specified by:

getElementsByTagNameNS in interface Document

getElementById

public Element getElementById(String elementId)

Specified by:

getElementById in interface Document

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Document

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

Specified by:

setXmlVersion in interface Document

Throws:

DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface Document

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

setDocumentURI

public void setDocumentURI(String documentURI)

Specified by:

setDocumentURI in interface Document

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Specified by:

adoptNode in interface Document

Throws:

DOMException

getDomConfig

public DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface Document

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface Document

renameNode

public Node renameNode(Node n,
                       String namespaceURI,
                       String qualifiedName)
                throws DOMException

Specified by:

renameNode in interface Document

Throws:

DOMException

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFirstChild

public Node getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public Node getLastChild()

Specified by:

getLastChild in interface Node

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

normalize

public void normalize()

Specified by:

normalize in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

getDomDocument

public Document getDomDocument()

register

public void register(Node node)

Insert a mapping information for Node - Node. In SAAJ, elements in DOM are expected to be interfaces of SAAJ, on the other hand in JDKs Xerces, they are casted to internal impl classes. After removal of SAAJ dependency to JDKs internal classes elements in DOM can never be both of them.

Parameters:

node - SAAJ wrapper node for w3c DOM node

find

public Node find(Node node)

Find a soap wrapper for w3c dom node.

Parameters:

node - w3c dom node nullable

Returns:

soap wrapper for w3c dom node

findIfPresent

public Node findIfPresent(Node node)

If corresponding soap wrapper exists for w3c dom node it is returned, if not passed dom element is returned.

Parameters:

node - w3c dom node

Returns:

soap wrapper or passed w3c dom node if not found

getDomNode

public Node getDomNode(Node node)

Extracts w3c dom node from corresponding soap wrapper.

Parameters:

node - soap or dom nullable

Returns:

dom node

getDomElement

public Document getDomElement()

getValue

public String getValue()

Description copied from interface: Node

Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise. If there is an immediate child of this Node that it is a Text node then it's value will be returned. If there is more than one Text node then the value of the first Text Node will be returned. Otherwise null is returned.

Specified by:

getValue in interface Node

Returns:

a String with the text of this node if this is a Text node or the text contained by the first immediate child of this Node object that is a Text object if such a child exists; null otherwise.

setValue

public void setValue(String value)

Description copied from interface: Node

If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.

Specified by:

setValue in interface Node

Parameters:

value - value to set on the Text node

setParentElement

public void setParentElement(SOAPElement parent)
                      throws SOAPException

Description copied from interface: Node

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

Specified by:

setParentElement in interface Node

Parameters:

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

Throws:

SOAPException - if there is a problem in setting the parent to the given element

See Also:

Node.getParentElement()

getParentElement

public SOAPElement getParentElement()

Description copied from interface: Node

Returns the parent element of this Node object. This method can throw an UnsupportedOperationException if the tree is not kept in memory.

Specified by:

getParentElement in interface Node

Returns:

the SOAPElement object that is the parent of this Node object or null if this Node object is root

See Also:

Node.setParentElement(jakarta.xml.soap.SOAPElement)

detachNode

public void detachNode()

Description copied from interface: Node

Removes this Node object from the tree.

Specified by:

detachNode in interface Node

recycleNode

public void recycleNode()

Description copied from interface: Node

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.

Specified by:

recycleNode in interface Node