Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.message
Class SOAPElementImpl

java.lang.Object
  extended byorg.jboss.axis.message.NodeImpl (src) 
      extended byorg.jboss.axis.message.SOAPElementImpl
All Implemented Interfaces:
org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPElement (src)
Direct Known Subclasses:
SOAPElementAxisImpl (src)
public class SOAPElementImpl
extends NodeImpl (src)
implements SOAPElement (src)

An implemenation of the abstract SOAPElement.

This class should not expose functionality that is not part of SOAPElement (src) . Client code should use SOAPElement whenever possible.

Field Summary
 
Fields inherited from class org.jboss.axis.message.NodeImpl (src)
domNode, soapParent
 
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
SOAPElementImpl(Name (src)  name)
          Constructor used by the SOAPElementFactory
SOAPElementImpl(java.lang.String localPart)
          Constructor used by the SOAPElementFactory
SOAPElementImpl(java.lang.String localPart, java.lang.String prefix, java.lang.String namespace)
          Constructor used by the SOAPElementFactory
 
Method Summary
 SOAPElement (src) addAttribute(Name (src)  name, java.lang.String value)
          Adds an attribute with the specified name and value to this SOAPElement object.
 SOAPElement (src) addChildElement(Name (src)  name)
          Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.
 SOAPElement (src) addChildElement(SOAPElement (src)  child)
          Add a SOAPElement as a child of this SOAPElement instance.
 SOAPElement (src) addChildElement(java.lang.String name)
          Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.
 SOAPElement (src) 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 (src) 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.
 SOAPElement (src) addNamespaceDeclaration(java.lang.String prefix, java.lang.String uri)
          Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.
 SOAPElement (src) addTextNode(java.lang.String value)
          Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
 java.util.Iterator getAllAttributes()
          Returns an Iterator over all of the attribute Name objects in this SOAPElement object.
 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)
           
 java.lang.String getAttributeValue(Name (src)  name)
          Returns the value of the attribute with the specified name.
 java.util.Iterator getChildElements()
          Returns an Iterator over all the immediate child Nodes of this element.
 java.util.Iterator getChildElements(Name (src)  name)
          Returns an Iterator over all the immediate child Nodes of this element with the specified name.
 Name (src) 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()
          Returns the encoding style for this SOAPElement object.
 java.util.Iterator getNamespacePrefixes()
          Returns an Iterator over the namespace prefix Strings declared by this element.
 java.lang.String getNamespaceURI(java.lang.String prefix)
          Returns the URI of the namespace that has the given prefix.
 TypeInfo (src) getSchemaTypeInfo()
           
 java.lang.String getTagName()
           
 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 removeAttribute(Name (src)  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 removeContents()
          Detaches all children of this SOAPElement.
 boolean removeNamespaceDeclaration(java.lang.String prefix)
          Removes the namespace declaration corresponding to the given prefix.
 void setAttribute(java.lang.String name, java.lang.String value)
           
 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 setEncodingStyle(java.lang.String encodingStyle)
          Sets the encoding style for this SOAPElement object to one specified.
 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)
           
 
Methods inherited from class org.jboss.axis.message.NodeImpl (src)
appendChild, cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, getValue, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, replaceChild, setNodeValue, setParentElement, setPrefix, setTextContent, setUserData, setValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.soap.Node (src)
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Constructor Detail

SOAPElementImpl

public SOAPElementImpl(java.lang.String localPart)
Constructor used by the SOAPElementFactory

SOAPElementImpl

public SOAPElementImpl(java.lang.String localPart,
                       java.lang.String prefix,
                       java.lang.String namespace)
Constructor used by the SOAPElementFactory

SOAPElementImpl

public SOAPElementImpl(Name (src)  name)
Constructor used by the SOAPElementFactory

Method Detail

addAttribute

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

Specified by:
addAttribute in interface SOAPElement (src)
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 (src) - if there is an error in creating the Attribute

addChildElement

public SOAPElement (src)  addChildElement(java.lang.String name)
                            throws SOAPException (src)
Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.

Specified by:
addChildElement in interface SOAPElement (src)
Parameters:
name - a String giving the local name for the element
Returns:
the new SOAPElement object that was created
Throws:
SOAPException (src) - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement (src)  addChildElement(java.lang.String localName,
                                   java.lang.String prefix)
                            throws SOAPException (src)
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 (src)
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 (src) - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement (src)  addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.String uri)
                            throws SOAPException (src)
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 (src)
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 (src) - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement (src)  addChildElement(Name (src)  name)
                            throws SOAPException (src)
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 (src)
Parameters:
name - a Name object with the XML name for the new element
Returns:
the new SOAPElement object that was created
Throws:
SOAPException (src) - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement (src)  addChildElement(SOAPElement (src)  child)
                            throws SOAPException (src)
Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPElementFactory.

Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of the SOAPElement passed into an instance of a different SOAPElement implementation. For instance if addChildElement() is called on a SOAPHeader, element will be copied into an instance of a SOAPHeaderElement.

The fragment rooted in element is either added as a whole or not at all, if there was an error.

The fragment rooted in element cannot contain elements named "Envelope", "Header" or "Body" and in the SOAP namespace. Any namespace prefixes present in the fragment should be fully resolved using appropriate namespace declarations within the fragment itself.

Specified by:
addChildElement in interface SOAPElement (src)
Parameters:
child - 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 (src) - if there was an error in adding this element as a child

addNamespaceDeclaration

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

Specified by:
addNamespaceDeclaration in interface SOAPElement (src)
Parameters:
prefix - a String giving the prefix of the namespace
uri - a String giving the uri of the namespace
Returns:
the SOAPElement object into which this namespace declaration was inserted.
Throws:
SOAPException (src) - if there is an error in creating the namespace

addTextNode

public SOAPElement (src)  addTextNode(java.lang.String value)
                        throws SOAPException (src)
Creates a new Text object initialized with the given String and adds it to this SOAPElement object.

Specified by:
addTextNode in interface SOAPElement (src)
Parameters:
value - a String object with the textual content to be added
Returns:
the SOAPElement object into which the new Text object was inserted
Throws:
SOAPException (src) - if there is an error in creating the new Text object

getAllAttributes

public java.util.Iterator getAllAttributes()
Returns an Iterator over all of the attribute Name objects 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 (src)
Returns:
an iterator over the names of the attributes

getAttributeValue

public java.lang.String getAttributeValue(Name (src)  name)
Returns the value of the attribute with the specified name.

Specified by:
getAttributeValue in interface SOAPElement (src)
Parameters:
name - a Name object with the name of the attribute
Returns:
a String giving the value of the specified attribute

getChildElements

public java.util.Iterator getChildElements()
Returns an Iterator over all the immediate child Nodes of this element.

This includes javax.xml.soap.Text objects as well as SOAPElement objects. Calling this method may cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details.

Specified by:
getChildElements in interface SOAPElement (src)
Returns:
an iterator with the content of this SOAPElement object

getChildElements

public java.util.Iterator getChildElements(Name (src)  name)
Returns an Iterator over all the immediate child Nodes of this element with the specified name.

All of these children will be SOAPElement nodes. Calling this method may cause child Element, SOAPElement and org.w3c.dom.Text nodes to be replaced by SOAPElement, SOAPHeaderElement, SOAPBodyElement or javax.xml.soap.Text nodes as appropriate for the type of this parent node. As a result the calling application must treat any existing references to these child nodes that have been obtained through DOM APIs as invalid and either discard them or refresh them with the values returned by this Iterator. This behavior can be avoided by calling the equivalent DOM APIs. See javax.xml.soap for more details.

Specified by:
getChildElements in interface SOAPElement (src)
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

getElementName

public Name (src)  getElementName()
Returns the name of this SOAPElement object.

Specified by:
getElementName in interface SOAPElement (src)
Returns:
a Name object with the name of this SOAPElement object

getEncodingStyle

public java.lang.String getEncodingStyle()
Returns the encoding style for this SOAPElement object.

Specified by:
getEncodingStyle in interface SOAPElement (src)
Returns:
a String giving the encoding style

getNamespacePrefixes

public java.util.Iterator getNamespacePrefixes()
Returns an Iterator over the namespace prefix Strings declared by this element.

The prefixes returned by this iterator can be passed to the method getNamespaceURI to retrieve the URI of each namespace.

Specified by:
getNamespacePrefixes in interface SOAPElement (src)
Returns:
an iterator over the namespace prefixes in this SOAPElement object

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)
Returns the URI of the namespace that has the given prefix.

Specified by:
getNamespaceURI in interface SOAPElement (src)
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

getVisibleNamespacePrefixes

public java.util.Iterator getVisibleNamespacePrefixes()
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 (src)
Returns:
an iterator over the namespace prefixes are within scope of this SOAPElement object

removeAttribute

public boolean removeAttribute(Name (src)  name)
Removes the attribute with the specified name.

Specified by:
removeAttribute in interface SOAPElement (src)
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

removeContents

public void removeContents()
Detaches all children of this SOAPElement.

This method is useful for rolling back the construction of partially completed SOAPHeaders and SOAPBodys in preparation 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 (src)

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(java.lang.String prefix)
Removes the namespace declaration corresponding to the given prefix.

Specified by:
removeNamespaceDeclaration in interface SOAPElement (src)
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

setEncodingStyle

public void setEncodingStyle(java.lang.String encodingStyle)
                      throws SOAPException (src)
Sets the encoding style for this SOAPElement object to one specified.

Specified by:
setEncodingStyle in interface SOAPElement (src)
Parameters:
encodingStyle - a String giving the encoding style
Throws:
SOAPException (src) - if there was a problem in the encoding style being set.

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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
Throws:
org.w3c.dom.DOMException

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

getSchemaTypeInfo

public TypeInfo (src)  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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD