org.apache.axis.message
Class MessageElement

java.lang.Object
  |
  +--org.apache.axis.message.MessageElement
All Implemented Interfaces:
org.w3c.dom.Element, org.w3c.dom.Node, Node, java.io.Serializable, SOAPElement
Direct Known Subclasses:
DetailEntry, SOAPBody, SOAPBodyElement, SOAPEnvelope, SOAPFaultElement, SOAPHeader, SOAPHeaderElement, Text

public class MessageElement
extends java.lang.Object
implements SOAPElement, java.io.Serializable

See Also:
Serialized Form

Inner Class Summary
protected static class MessageElement.QNameAttr
           
 
Field Summary
protected  boolean _isDirty
           
protected  boolean _isRoot
           
protected  org.xml.sax.Attributes attributes
           
protected  DeserializationContext context
           
protected  org.w3c.dom.Element elementRep
           
protected  java.lang.String encodingStyle
          Our encoding style, if any
protected  int endEventIndex
           
protected  java.lang.String href
           
protected  java.lang.String id
           
protected static org.apache.commons.logging.Log log
           
protected  SOAPEnvelope message
           
protected  java.lang.String name
           
 java.util.ArrayList namespaces
           
protected  java.lang.String namespaceURI
           
protected  MessageElement parent
           
protected  java.lang.String prefix
           
protected  java.util.Vector qNameAttrs
           
protected  SAX2EventRecorder recorder
           
protected  int startContentsIndex
           
protected  int startEventIndex
           
protected  org.w3c.dom.Text textRep
           
protected  QName typeQName
           
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
MessageElement()
          No-arg constructor for building messages?
MessageElement(org.w3c.dom.Element elem)
           
MessageElement(Name eltName)
           
MessageElement(QName name, java.lang.Object value)
           
MessageElement(java.lang.String namespace, java.lang.String localPart)
           
MessageElement(java.lang.String namespace, java.lang.String localPart, java.lang.Object value)
           
MessageElement(java.lang.String localPart, java.lang.String prefix, java.lang.String namespace)
           
MessageElement(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context)
           
MessageElement(org.w3c.dom.Text text)
           
 
Method Summary
 SOAPElement addAttribute(Name name, java.lang.String value)
          Adds an attribute with the specified name and value to this SOAPElement object.
 void addAttribute(java.lang.String namespace, java.lang.String localName, QName value)
           
 void addAttribute(java.lang.String namespace, java.lang.String localName, java.lang.String value)
           
 void addAttribute(java.lang.String prefix, java.lang.String namespace, java.lang.String localName, java.lang.String value)
           
 void addChild(MessageElement el)
          Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.
 SOAPElement addChildElement(Name name)
          Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.
 SOAPElement addChildElement(SOAPElement element)
          The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.
 SOAPElement addChildElement(java.lang.String localName)
          Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
 SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix)
          Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.
 SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
          Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.
 void addMapping(Mapping map)
           
 SOAPElement addNamespaceDeclaration(java.lang.String prefix, java.lang.String uri)
          Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.
 SOAPElement addTextNode(java.lang.String s)
          Text nodes are not supported.
 org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
           
 org.w3c.dom.Node cloneNode(boolean deep)
           
 void detachNode()
          Break the relationship between this element and its parent, if any.
 java.util.Iterator getAllAttributes()
          Returns an iterator over all of the attribute names in this SOAPElement object.
 org.w3c.dom.Document getAsDocument()
           
 org.w3c.dom.Element getAsDOM()
           
 java.lang.String getAsString()
           
 java.lang.String getAttribute(java.lang.String name)
           
 org.w3c.dom.Attr getAttributeNode(java.lang.String name)
           
 org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
           
 java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
           
 org.w3c.dom.NamedNodeMap getAttributes()
           
 org.xml.sax.Attributes getAttributesEx()
           
 java.lang.String getAttributeValue(Name name)
          Returns the value of the attribute with the specified name.
 java.lang.String getAttributeValue(java.lang.String localName)
           
 java.util.Iterator getChildElements()
          Returns an iterator over all the immediate content of this element.
 java.util.Iterator getChildElements(Name name)
          Returns an iterator over all the child elements with the specified name.
 org.w3c.dom.NodeList getChildNodes()
           
 java.util.ArrayList getChildren()
           
 org.xml.sax.Attributes getCompleteAttributes()
          Obtain an Attributes collection consisting of all attributes for this MessageElement, including namespace declarations.
 Name getElementName()
          Returns the name of this SOAPElement object.
 org.w3c.dom.NodeList getElementsByTagName(java.lang.String name)
           
 org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
           
 java.lang.String getEncodingStyle()
          Get the encoding style.
 SOAPEnvelope getEnvelope()
           
 org.w3c.dom.Node getFirstChild()
           
 Deserializer getFixupDeserializer()
           
 java.lang.String getHref()
           
 java.lang.String getID()
           
 org.w3c.dom.Node getLastChild()
           
 java.lang.String getLocalName()
           
 java.lang.String getName()
           
 java.util.Iterator getNamespacePrefixes()
          Returns an iterator of namespace prefixes.
 java.lang.String getNamespaceURI()
           
 java.lang.String getNamespaceURI(java.lang.String prefix)
          Returns the URI of the namespace that has the given prefix.
 org.w3c.dom.Node getNextSibling()
           
 java.lang.String getNodeName()
           
 short getNodeType()
           
 java.lang.String getNodeValue()
           
 java.lang.Object getObjectValue()
          Returns value of the node as an object of registered type.
 java.lang.Object getObjectValue(java.lang.Class cls)
          Returns value of the node as an object of registered type.
 org.w3c.dom.Document getOwnerDocument()
           
 SOAPElement getParentElement()
          Returns the parent element of this Node object.
 org.w3c.dom.Node getParentNode()
           
 java.lang.String getPrefix()
           
 java.lang.String getPrefix(java.lang.String namespaceURI)
           
 org.w3c.dom.Node getPreviousSibling()
           
 QName getQName()
           
 MessageElement getRealElement()
           
 SAX2EventRecorder getRecorder()
           
 java.lang.String getTagName()
           
 QName getType()
           
 java.lang.String getValue()
          Returns the the value of the immediate child of this Node object if a child exists and its value is text.
 java.lang.Object getValueAsType(QName type)
           
 java.lang.Object getValueAsType(QName type, java.lang.Class cls)
           
 java.util.Iterator getVisibleNamespacePrefixes()
          Returns an Iterator over the namespace prefix Strings visible to this element.
 boolean hasAttribute(java.lang.String name)
           
 boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
           
 boolean hasAttributes()
           
 boolean hasChildNodes()
           
 org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
           
 boolean isDirty()
           
 boolean isRoot()
           
 boolean isSupported(java.lang.String feature, java.lang.String version)
           
protected  org.xml.sax.helpers.AttributesImpl makeAttributesEditable()
           
 void normalize()
           
 void output(SerializationContext context)
          This is the public output() method, which will always simply use the recorded SAX stream for this element if it is available.
protected  void outputImpl(SerializationContext context)
          Subclasses can override
 void publishContents(org.xml.sax.ContentHandler handler)
           
 void publishToHandler(org.xml.sax.ContentHandler handler)
           
 void recycleNode()
          No-opped - Axis does not recycle nodes.
 boolean removeAttribute(Name name)
          Removes the attribute with the specified name.
 void removeAttribute(java.lang.String name)
           
 org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr)
           
 void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
           
 void removeChild(MessageElement child)
          Remove a child element.
 org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
           
 void removeContents()
          Detaches all children of this SOAPElement.
 boolean removeNamespaceDeclaration(java.lang.String prefix)
          Removes the namespace declaration corresponding to the given prefix.
 org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
           
 void setAttribute(java.lang.String name, java.lang.String value)
           
 void setAttribute(java.lang.String namespace, java.lang.String localName, java.lang.String value)
          Set an attribute, adding the attribute if it isn't already present in this element, and changing the value if it is.
 org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr)
           
 org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr)
           
 void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)
           
 void setContentsIndex(int index)
           
 void setDirty(boolean dirty)
           
 void setEncodingStyle(java.lang.String encodingStyle)
          Sets the encoding style for this SOAPElement object to one specified.
 void setEndIndex(int endIndex)
           
 void setEnvelope(SOAPEnvelope env)
           
 void setFixupDeserializer(Deserializer dser)
           
 void setName(java.lang.String name)
           
 void setNamespaceURI(java.lang.String nsURI)
           
 void setNodeValue(java.lang.String nodeValue)
           
 void setNSMappings(java.util.ArrayList namespaces)
           
 void setObjectValue(java.lang.Object newValue)
          Sets value of this node to an Object.
 void setParentElement(SOAPElement parent)
          Sets the parent of this Node object to the given SOAPElement object.
 void setPrefix(java.lang.String prefix)
           
 void setQName(QName qName)
           
 void setRecorder(SAX2EventRecorder rec)
           
 void setType(QName qname)
           
 void setValue(java.lang.String s)
          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.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static org.apache.commons.logging.Log log

name

protected java.lang.String name

prefix

protected java.lang.String prefix

namespaceURI

protected java.lang.String namespaceURI

attributes

protected transient org.xml.sax.Attributes attributes

id

protected java.lang.String id

href

protected java.lang.String href

_isRoot

protected boolean _isRoot

message

protected SOAPEnvelope message

_isDirty

protected boolean _isDirty

context

protected transient DeserializationContext context

typeQName

protected transient QName typeQName

qNameAttrs

protected java.util.Vector qNameAttrs

recorder

protected transient SAX2EventRecorder recorder

startEventIndex

protected int startEventIndex

startContentsIndex

protected int startContentsIndex

endEventIndex

protected int endEventIndex

elementRep

protected org.w3c.dom.Element elementRep

textRep

protected org.w3c.dom.Text textRep

parent

protected MessageElement parent

namespaces

public java.util.ArrayList namespaces

encodingStyle

protected java.lang.String encodingStyle
Our encoding style, if any
Constructor Detail

MessageElement

public MessageElement()
No-arg constructor for building messages?

MessageElement

public MessageElement(java.lang.String namespace,
                      java.lang.String localPart)

MessageElement

public MessageElement(java.lang.String localPart,
                      java.lang.String prefix,
                      java.lang.String namespace)

MessageElement

public MessageElement(Name eltName)

MessageElement

public MessageElement(java.lang.String namespace,
                      java.lang.String localPart,
                      java.lang.Object value)

MessageElement

public MessageElement(QName name,
                      java.lang.Object value)

MessageElement

public MessageElement(org.w3c.dom.Element elem)

MessageElement

public MessageElement(org.w3c.dom.Text text)

MessageElement

public MessageElement(java.lang.String namespace,
                      java.lang.String localPart,
                      java.lang.String prefix,
                      org.xml.sax.Attributes attributes,
                      DeserializationContext context)
               throws AxisFault
Method Detail

setFixupDeserializer

public void setFixupDeserializer(Deserializer dser)

getFixupDeserializer

public Deserializer getFixupDeserializer()

setEndIndex

public void setEndIndex(int endIndex)

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean dirty)

isRoot

public boolean isRoot()

getID

public java.lang.String getID()

getHref

public java.lang.String getHref()

getAttributesEx

public org.xml.sax.Attributes getAttributesEx()

getFirstChild

public org.w3c.dom.Node getFirstChild()
Specified by:
getFirstChild in interface org.w3c.dom.Node

getLastChild

public org.w3c.dom.Node getLastChild()
Specified by:
getLastChild in interface org.w3c.dom.Node

getNextSibling

public org.w3c.dom.Node getNextSibling()
Specified by:
getNextSibling in interface org.w3c.dom.Node

getParentNode

public org.w3c.dom.Node getParentNode()
Specified by:
getParentNode in interface org.w3c.dom.Node

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()
Specified by:
getPreviousSibling in interface org.w3c.dom.Node

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)
Specified by:
cloneNode in interface org.w3c.dom.Node

getChildNodes

public org.w3c.dom.NodeList getChildNodes()
Specified by:
getChildNodes in interface org.w3c.dom.Node

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)
Specified by:
isSupported in interface org.w3c.dom.Node

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException
Specified by:
appendChild in interface org.w3c.dom.Node

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException
Specified by:
removeChild in interface org.w3c.dom.Node

insertBefore

public 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

replaceChild

public 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

getCompleteAttributes

public org.xml.sax.Attributes getCompleteAttributes()
Obtain an Attributes collection consisting of all attributes for this MessageElement, including namespace declarations.
Returns:
Attributes collection

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getQName

public QName getQName()

setQName

public void setQName(QName qName)

getPrefix

public java.lang.String getPrefix()
Specified by:
getPrefix in interface org.w3c.dom.Node

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws org.w3c.dom.DOMException
Specified by:
setNodeValue in interface org.w3c.dom.Node

setPrefix

public void setPrefix(java.lang.String prefix)
Specified by:
setPrefix in interface org.w3c.dom.Node

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()
Specified by:
getOwnerDocument in interface org.w3c.dom.Node

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Specified by:
getAttributes in interface org.w3c.dom.Node

getNodeType

public short getNodeType()
Specified by:
getNodeType in interface org.w3c.dom.Node

normalize

public void normalize()
Specified by:
normalize in interface org.w3c.dom.Node

hasAttributes

public boolean hasAttributes()
Specified by:
hasAttributes in interface org.w3c.dom.Node

hasChildNodes

public boolean hasChildNodes()
Specified by:
hasChildNodes in interface org.w3c.dom.Node

getLocalName

public java.lang.String getLocalName()
Specified by:
getLocalName in interface org.w3c.dom.Node

getNamespaceURI

public java.lang.String getNamespaceURI()
Specified by:
getNamespaceURI in interface org.w3c.dom.Node

getNodeName

public java.lang.String getNodeName()
Specified by:
getNodeName in interface org.w3c.dom.Node

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException
Specified by:
getNodeValue in interface org.w3c.dom.Node

setNamespaceURI

public void setNamespaceURI(java.lang.String nsURI)

getType

public QName getType()

setType

public void setType(QName qname)

getRecorder

public SAX2EventRecorder getRecorder()

setRecorder

public void setRecorder(SAX2EventRecorder rec)

getEncodingStyle

public java.lang.String getEncodingStyle()
Get the encoding style. If ours is null, walk up the hierarchy and use our parent's. Default if we're the root is "".
Specified by:
getEncodingStyle in interface SOAPElement
Returns:
the currently in-scope encoding style

removeContents

public void removeContents()
Description copied from interface: SOAPElement
Detaches all children of this SOAPElement.

This method is useful for rolling back the construction of partially completed SOAPHeaders and SOAPBodys in reparation for sending a fault when an error condition is detected. It is also useful for recycling portions of a document within a SOAP message.

Specified by:
removeContents in interface SOAPElement

getVisibleNamespacePrefixes

public java.util.Iterator getVisibleNamespacePrefixes()
Description copied from interface: SOAPElement
Returns an Iterator over the namespace prefix Strings visible to this element. The prefixes returned by this iterator can be passed to the method getNamespaceURI() to retrieve the URI of each namespace.
Specified by:
getVisibleNamespacePrefixes in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
an iterator over the namespace prefixes are within scope of this SOAPElement object

setEncodingStyle

public void setEncodingStyle(java.lang.String encodingStyle)
                      throws SOAPException
Sets the encoding style for this SOAPElement object to one specified. The semantics of a null value, as above in getEncodingStyle() are to just use the parent's value, but null here means set to "".
Specified by:
setEncodingStyle in interface SOAPElement
Parameters:
encodingStyle - a String giving the encoding style
Throws:
java.lang.IllegalArgumentException - if there was a problem in the encoding style being set.
See Also:
getEncodingStyle()

addChild

public void addChild(MessageElement el)
              throws SOAPException
Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.

removeChild

public void removeChild(MessageElement child)
Remove a child element.

getChildren

public java.util.ArrayList getChildren()

setContentsIndex

public void setContentsIndex(int index)

setNSMappings

public void setNSMappings(java.util.ArrayList namespaces)

getPrefix

public java.lang.String getPrefix(java.lang.String namespaceURI)

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)
Description copied from interface: SOAPElement
Returns the URI of the namespace that has the given prefix.
Specified by:
getNamespaceURI in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
prefix - a String giving the prefix of the namespace for which to search
Returns:
a String with the uri of the namespace that has the given prefix

getObjectValue

public java.lang.Object getObjectValue()
Returns value of the node as an object of registered type.
Returns:
Object of proper type, or null if no mapping could be found.

getObjectValue

public java.lang.Object getObjectValue(java.lang.Class cls)
                                throws java.lang.Exception
Returns value of the node as an object of registered type.
Parameters:
cls - Class that contains top level deserializer metadata
Returns:
Object of proper type, or null if no mapping could be found.

setObjectValue

public void setObjectValue(java.lang.Object newValue)
                    throws SOAPException
Sets value of this node to an Object. A serializer needs to be registered for this object class for proper operation.

Note that this method will log an error and no-op if there are any children in the MessageElement or if the MessageElement was constructed from XML.

Parameters:
newValue - node's value or null.

getValueAsType

public java.lang.Object getValueAsType(QName type)
                                throws java.lang.Exception

getValueAsType

public java.lang.Object getValueAsType(QName type,
                                       java.lang.Class cls)
                                throws java.lang.Exception

addAttribute

public void addAttribute(java.lang.String namespace,
                         java.lang.String localName,
                         QName value)

makeAttributesEditable

protected org.xml.sax.helpers.AttributesImpl makeAttributesEditable()

addAttribute

public void addAttribute(java.lang.String namespace,
                         java.lang.String localName,
                         java.lang.String value)

addAttribute

public void addAttribute(java.lang.String prefix,
                         java.lang.String namespace,
                         java.lang.String localName,
                         java.lang.String value)

setAttribute

public void setAttribute(java.lang.String namespace,
                         java.lang.String localName,
                         java.lang.String value)
Set an attribute, adding the attribute if it isn't already present in this element, and changing the value if it is. Passing null as the value will cause any pre-existing attribute by this name to go away.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String localName)

setEnvelope

public void setEnvelope(SOAPEnvelope env)

getEnvelope

public SOAPEnvelope getEnvelope()

getRealElement

public MessageElement getRealElement()

getAsDocument

public org.w3c.dom.Document getAsDocument()
                                   throws java.lang.Exception

getAsString

public java.lang.String getAsString()
                             throws java.lang.Exception

getAsDOM

public org.w3c.dom.Element getAsDOM()
                             throws java.lang.Exception

publishToHandler

public void publishToHandler(org.xml.sax.ContentHandler handler)
                      throws org.xml.sax.SAXException

publishContents

public void publishContents(org.xml.sax.ContentHandler handler)
                     throws org.xml.sax.SAXException

output

public final void output(SerializationContext context)
                  throws java.lang.Exception
This is the public output() method, which will always simply use the recorded SAX stream for this element if it is available. If not, this method calls outputImpl() to allow subclasses and programmatically created messages to serialize themselves.
Parameters:
context - the SerializationContext we will write to.

outputImpl

protected void outputImpl(SerializationContext context)
                   throws java.lang.Exception
Subclasses can override

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

addMapping

public void addMapping(Mapping map)

getValue

public java.lang.String getValue()
Returns the the value of the immediate child of this Node object if a child exists and its value is text.
Specified by:
getValue in interface Node
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

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
Following copied from interface: javax.xml.soap.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:
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
Following copied from interface: javax.xml.soap.Node
Returns:
the SOAPElement object that is the parent of this Node object or null if this Node object is root
Throws:
java.lang.UnsupportedOperationException - if the whole tree is not kept in memory
See Also:
setParentElement(javax.xml.soap.SOAPElement)

detachNode

public void detachNode()
Break the relationship between this element and its parent, if any.
Specified by:
detachNode in interface Node

recycleNode

public void recycleNode()
No-opped - Axis does not recycle nodes.
Specified by:
recycleNode in interface Node

setValue

public void setValue(java.lang.String s)
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
Following copied from interface: javax.xml.soap.Node
Parameters:
value - the text to set
Throws:
java.lang.IllegalStateException - if the node is not a Text node and either has more than one child node or has a child node that is not a Text node

addChildElement

public SOAPElement addChildElement(Name name)
                            throws SOAPException
Description copied from interface: SOAPElement
Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.
Specified by:
addChildElement in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - a Name object with the XML name for the new element
Returns:
the new SOAPElement object that was created
Throws:
SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(java.lang.String localName)
                            throws SOAPException
Description copied from interface: SOAPElement
Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
Specified by:
addChildElement in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
localName - a String giving the local name for the element
Returns:
the new SOAPElement object that was created
Throws:
SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix)
                            throws SOAPException
Description copied from interface: SOAPElement
Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.
Specified by:
addChildElement in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
localName - a String giving the local name for the new element
prefix - a String giving the namespace prefix for the new element
Returns:
the new SOAPElement object that was created
Throws:
SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.String uri)
                            throws SOAPException
Description copied from interface: SOAPElement
Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.
Specified by:
addChildElement in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
localName - a String giving the local name for the new element
prefix - a String giving the namespace prefix for the new element
uri - a String giving the URI of the namespace to which the new element belongs
Returns:
the new SOAPElement object that was created
Throws:
SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(SOAPElement element)
                            throws SOAPException
The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.
Specified by:
addChildElement in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
element - the SOAPElement to be added as a new child
Returns:
an instance representing the new SOAP element that was actually added to the tree.
Throws:
SOAPException - if there was an error in adding this element as a child

addTextNode

public SOAPElement addTextNode(java.lang.String s)
                        throws SOAPException
Text nodes are not supported.
Specified by:
addTextNode in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
text - a String object with the textual content to be added
Returns:
the SOAPElement object into which the new Text object was inserted
Throws:
SOAPException - if there is an error in creating the new Text object

addAttribute

public SOAPElement addAttribute(Name name,
                                java.lang.String value)
                         throws SOAPException
Description copied from interface: SOAPElement
Adds an attribute with the specified name and value to this SOAPElement object.

Specified by:
addAttribute in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - a Name object with the name of the attribute
value - a String giving the value of the attribute
Returns:
the SOAPElement object into which the attribute was inserted
Throws:
SOAPException - if there is an error in creating the Attribute

addNamespaceDeclaration

public SOAPElement addNamespaceDeclaration(java.lang.String prefix,
                                           java.lang.String uri)
                                    throws SOAPException
Description copied from interface: SOAPElement
Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.

Specified by:
addNamespaceDeclaration in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
prefix - a String giving the prefix of the namespace
uri - a String giving the prefix of the namespace
Returns:
the SOAPElement object into which this namespace declaration was inserted.
Throws:
SOAPException - if there is an error in creating the namespace

getAttributeValue

public java.lang.String getAttributeValue(Name name)
Description copied from interface: SOAPElement
Returns the value of the attribute with the specified name.
Specified by:
getAttributeValue in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - a Name object with the name of the attribute
Returns:
a String giving the value of the specified attribute

getAllAttributes

public java.util.Iterator getAllAttributes()
Description copied from interface: SOAPElement
Returns an iterator over all of the attribute names in this SOAPElement object. The iterator can be used to get the attribute names, which can then be passed to the method getAttributeValue to retrieve the value of each attribute.
Specified by:
getAllAttributes in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
an iterator over the names of the attributes

getNamespacePrefixes

public java.util.Iterator getNamespacePrefixes()
Description copied from interface: SOAPElement
Returns an iterator of namespace prefixes. The iterator can be used to get the namespace prefixes, which can then be passed to the method getNamespaceURI to retrieve the URI of each namespace.
Specified by:
getNamespacePrefixes in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
an iterator over the namespace prefixes in this SOAPElement object

getElementName

public Name getElementName()
Description copied from interface: SOAPElement
Returns the name of this SOAPElement object.
Specified by:
getElementName in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
a Name object with the name of this SOAPElement object

removeAttribute

public boolean removeAttribute(Name name)
Description copied from interface: SOAPElement
Removes the attribute with the specified name.
Specified by:
removeAttribute in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - the Name object with the name of the attribute to be removed
Returns:
true if the attribute was removed successfully; false if it was not

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(java.lang.String prefix)
Description copied from interface: SOAPElement
Removes the namespace declaration corresponding to the given prefix.
Specified by:
removeNamespaceDeclaration in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
prefix - a String giving the prefix for which to search
Returns:
true if the namespace declaration was removed successfully; false if it was not

getChildElements

public java.util.Iterator getChildElements()
Description copied from interface: SOAPElement
Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects.
Specified by:
getChildElements in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
an iterator with the content of this SOAPElement object

getChildElements

public java.util.Iterator getChildElements(Name name)
Description copied from interface: SOAPElement
Returns an iterator over all the child elements with the specified name.
Specified by:
getChildElements in interface SOAPElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - a Name object with the name of the child elements to be returned
Returns:
an Iterator object over all the elements in this SOAPElement object with the specified name

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
Specified by:
removeAttribute in interface org.w3c.dom.Element

hasAttribute

public boolean hasAttribute(java.lang.String name)
Specified by:
hasAttribute in interface org.w3c.dom.Element

getAttribute

public java.lang.String getAttribute(java.lang.String name)
Specified by:
getAttribute in interface org.w3c.dom.Element

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

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

hasAttributeNS

public boolean hasAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)
Specified by:
hasAttributeNS in interface org.w3c.dom.Element

getAttributeNode

public org.w3c.dom.Attr getAttributeNode(java.lang.String name)
Specified by:
getAttributeNode in interface org.w3c.dom.Element

removeAttributeNode

public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr)
                                     throws org.w3c.dom.DOMException
Specified by:
removeAttributeNode in interface org.w3c.dom.Element

setAttributeNode

public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr)
                                  throws org.w3c.dom.DOMException
Specified by:
setAttributeNode in interface org.w3c.dom.Element

setAttributeNodeNS

public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr)
                                    throws org.w3c.dom.DOMException
Specified by:
setAttributeNodeNS 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

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String localName)
Specified by:
getAttributeNS in interface org.w3c.dom.Element

setAttributeNS

public void setAttributeNS(java.lang.String namespaceURI,
                           java.lang.String qualifiedName,
                           java.lang.String value)
                    throws org.w3c.dom.DOMException
Specified by:
setAttributeNS in interface org.w3c.dom.Element

getAttributeNodeNS

public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI,
                                           java.lang.String localName)
Specified by:
getAttributeNodeNS in interface org.w3c.dom.Element

getElementsByTagNameNS

public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
                                                   java.lang.String localName)
Specified by:
getElementsByTagNameNS in interface org.w3c.dom.Element


Copyright © 2003 Apache Web Services Project. All Rights Reserved.