SOAPDocumentImpl (Apache Axis)

java.lang.Object
- org.apache.axis.message.SOAPDocumentImpl

All Implemented Interfaces:

Serializable, Document, Node
```
public class SOAPDocumentImpl
extends Object
implements Document, Serializable
```
SOAPDcoumentImpl implements the Document API for SOAPPART. At the moment, it again delgate the XERCES DOM Implementation Here is my argument on it: I guess that there is 3 way to implement this. - fully implement the DOM API here myself. => This is too much and duplicated work. - extends XERCES Implementation => this makes we are fixed to one Implementation - choose delgate depends on the user's parser preference => This is the practically best solution I have now

Author:

Heejune Ahn (cityboy@tmax.co.kr)

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Document delegate

protected SOAPPart soapPart
- 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
Modifier and Type	Field and Description
`protected Document`	`delegate`
`protected SOAPPart`	`soapPart`

Constructor Summary

Constructors
Constructor and Description

SOAPDocumentImpl(SOAPPart sp)
Construct the Document

Constructors
Constructor and Description
`SOAPDocumentImpl(SOAPPart sp)` Construct the Document

Method Summary

Methods
Modifier and Type	Method and Description
`Node`	`appendChild(Node newChild)`
`Node`	`cloneNode(boolean deep)`
`Attr`	`createAttribute(String name)`
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)` Attribute is not particularly dealt with in SAAJ.
`CDATASection`	`createCDATASection(String data)` Creates a `CDATASection` node whose value is the specified string.
`Comment`	`createComment(String data)` Creates a `Comment` node given the specified string.
`DocumentFragment`	`createDocumentFragment()` Creates an empty `DocumentFragment` object.
`Element`	`createElement(String tagName)` based on the tagName, we will make different kind SOAP Elements Instance Is really we can determine the Type by the Tagname???
`Element`	`createElementNS(String namespaceURI, String qualifiedName)` Return SOAPElements (what if they want SOAPEnvelope or Header/Body?)
`EntityReference`	`createEntityReference(String name)`
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)` Creates a `ProcessingInstruction` node given the specified name and data strings.
`Text`	`createTextNode(String data)` Creates a `Text` node given the specified string.
`NamedNodeMap`	`getAttributes()`
`NodeList`	`getChildNodes()`
`DocumentType`	`getDoctype()`
`Element`	`getDocumentElement()` should not be called, the method will be handled in SOAPPart
`Element`	`getElementById(String elementId)` Returns the `Element` whose `ID` is given by `elementId`.
`NodeList`	`getElementsByTagName(String localName)` search the SOAPPart in order of SOAPHeader and SOAPBody for the requested Element name
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)` search the SOAPPart in order of SOAPHeader and SOAPBody for the requested Element name
`Node`	`getFirstChild()` Do we have to count the Attributes as node ????
`DOMImplementation`	`getImplementation()`
`Node`	`getLastChild()`
`String`	`getLocalName()`
`String`	`getNamespaceURI()`
`Node`	`getNextSibling()`
`String`	`getNodeName()` Node Implementation
`short`	`getNodeType()` override it in sub-classes
`String`	`getNodeValue()`
`Document`	`getOwnerDocument()` we have to have a link to them...
`Node`	`getParentNode()`
`String`	`getPrefix()`
`Node`	`getPreviousSibling()`
`boolean`	`hasAttributes()`
`boolean`	`hasChildNodes()`
`Node`	`importNode(Node importedNode, boolean deep)`
`Node`	`insertBefore(Node newChild, Node refChild)`
`boolean`	`isSupported(String feature, String version)`
`void`	`normalize()`
`Node`	`removeChild(Node oldChild)`
`Node`	`replaceChild(Node newChild, Node oldChild)`
`void`	`setNamespaceURI(String nsURI)`
`void`	`setNodeValue(String nodeValue)`
`void`	`setPrefix(String prefix)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Document
adoptNode, getDocumentURI, getDomConfig, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion

Methods inherited from interface org.w3c.dom.Node
compareDocumentPosition, getBaseURI, getFeature, getTextContent, getUserData, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData

- Field Detail
  - delegate
```
protected Document delegate
```
  - soapPart
```
protected SOAPPart soapPart
```
- Constructor Detail
  - SOAPDocumentImpl
```
public SOAPDocumentImpl(SOAPPart sp)
```
    Construct the Document
    
    Parameters:
    sp - the soap part
- Method Detail
  - getDoctype
```
public DocumentType getDoctype()
```
    Specified by:
    
    getDoctype in interface Document
    
    Returns:
  - getImplementation
```
public DOMImplementation getImplementation()
```
    Specified by:
    
    getImplementation in interface Document
  - getDocumentElement
```
public Element getDocumentElement()
```
    should not be called, the method will be handled in SOAPPart
    
    Specified by:
    
    getDocumentElement in interface Document
    
    Returns:
  - createElement
```
public Element createElement(String tagName)
                      throws DOMException
```
    based on the tagName, we will make different kind SOAP Elements Instance Is really we can determine the Type by the Tagname???
    
    Specified by:
    
    createElement in interface Document
    
    Parameters:
    tagName -
    
    Returns:
    @throws DOMException
    
    Throws:
    
    DOMException
  - createDocumentFragment
```
public DocumentFragment createDocumentFragment()
```
    Creates an empty DocumentFragment object. @todo not implemented yet
    
    Specified by:
    
    createDocumentFragment in interface Document
    
    Returns:
    A new DocumentFragment.
  - createTextNode
```
public Text createTextNode(String data)
```
    Creates a Text node given the specified string.
    
    Specified by:
    
    createTextNode in interface Document
    
    Parameters:
    data - The data for the node.
    
    Returns:
    The new Text object.
  - createComment
```
public Comment createComment(String data)
```
    Creates a Comment node given the specified string.
    
    Specified by:
    
    createComment in interface Document
    
    Parameters:
    data - The data for the node.
    
    Returns:
    The new Comment object.
  - createCDATASection
```
public CDATASection createCDATASection(String data)
                                throws DOMException
```
    Creates a CDATASection node whose value is the specified string.
    
    Specified by:
    
    createCDATASection in interface Document
    
    Parameters:
    data - The data for the CDATASection contents.
    
    Returns:
    The new CDATASection object.
    
    Throws:
    
    DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
  - createProcessingInstruction
```
public ProcessingInstruction createProcessingInstruction(String target,
                                                String data)
                                                  throws DOMException
```
    Creates a ProcessingInstruction node given the specified name and data strings.
    
    Specified by:
    
    createProcessingInstruction in interface Document
    
    Parameters:
    target - The target part of the processing instruction.
    data - The data for the node.
    
    Returns:
    The new ProcessingInstruction object.
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
    NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
  - 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
    
    Parameters:
    name -
    
    Returns:
    @throws DOMException
    
    Throws:
    
    DOMException
  - importNode
```
public Node importNode(Node importedNode,
              boolean deep)
                throws DOMException
```
    Specified by:
    
    importNode in interface Document
    
    Throws:
    
    DOMException
  - createElementNS
```
public Element createElementNS(String namespaceURI,
                      String qualifiedName)
                        throws DOMException
```
    Return SOAPElements (what if they want SOAPEnvelope or Header/Body?)
    
    Specified by:
    
    createElementNS in interface Document
    
    Parameters:
    namespaceURI -
    qualifiedName -
    
    Returns:
    @throws DOMException
    
    Throws:
    
    DOMException
  - createAttributeNS
```
public Attr createAttributeNS(String namespaceURI,
                     String qualifiedName)
                       throws DOMException
```
    Attribute is not particularly dealt with in SAAJ.
    
    Specified by:
    
    createAttributeNS in interface Document
    
    Throws:
    
    DOMException
  - getElementsByTagNameNS
```
public NodeList getElementsByTagNameNS(String namespaceURI,
                              String localName)
```
    search the SOAPPart in order of SOAPHeader and SOAPBody for the requested Element name
    
    Specified by:
    
    getElementsByTagNameNS in interface Document
  - getElementsByTagName
```
public NodeList getElementsByTagName(String localName)
```
    search the SOAPPart in order of SOAPHeader and SOAPBody for the requested Element name
    
    Specified by:
    
    getElementsByTagName in interface Document
  - getElementById
```
public Element getElementById(String elementId)
```
    Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.
    
    Specified by:
    
    getElementById in interface Document
    
    Parameters:
    elementId - The unique id value for an element.
    
    Returns:
    The matching element.
    Since:
    
    DOM Level 2
  - getNodeName
```
public String getNodeName()
```
    Node Implementation
    
    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()
```
    override it in sub-classes
    
    Specified by:
    
    getNodeType in interface Node
    
    Returns:
  - getParentNode
```
public Node getParentNode()
```
    Specified by:
    
    getParentNode in interface Node
  - getChildNodes
```
public NodeList getChildNodes()
```
    Specified by:
    
    getChildNodes in interface Node
  - getFirstChild
```
public Node getFirstChild()
```
    Do we have to count the Attributes as node ????
    
    Specified by:
    
    getFirstChild in interface Node
    
    Returns:
  - getLastChild
```
public Node getLastChild()
```
    Specified by:
    
    getLastChild in interface Node
    
    Returns:
  - 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()
```
    we have to have a link to them...
    
    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
  - getPrefix
```
public String getPrefix()
```
    Specified by:
    
    getPrefix in interface Node
  - setPrefix
```
public void setPrefix(String prefix)
```
    Specified by:
    
    setPrefix in interface Node
  - getNamespaceURI
```
public String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface Node
  - setNamespaceURI
```
public void setNamespaceURI(String nsURI)
```
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface Node
  - hasAttributes
```
public boolean hasAttributes()
```
    Specified by:
    
    hasAttributes in interface Node

Class SOAPDocumentImpl

Field Summary

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Document

Methods inherited from interface org.w3c.dom.Node

Field Detail

delegate

soapPart

Constructor Detail

SOAPDocumentImpl

Method Detail

getDoctype

getImplementation

getDocumentElement

createElement

createDocumentFragment

createTextNode

createComment

createCDATASection

createProcessingInstruction

createAttribute

createEntityReference

importNode

createElementNS

createAttributeNS

getElementsByTagNameNS

getElementsByTagName

getElementById

getNodeName

getNodeValue

setNodeValue

getNodeType

getParentNode

getChildNodes

getFirstChild

getLastChild

getPreviousSibling

getNextSibling

getAttributes

getOwnerDocument

insertBefore

replaceChild

removeChild

appendChild

hasChildNodes

cloneNode

normalize

isSupported

getPrefix

setPrefix

getNamespaceURI

setNamespaceURI

getLocalName

hasAttributes