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 SOAPElementAxisImpl

java.lang.Object
  extended byorg.jboss.axis.message.NodeImpl (src) 
      extended byorg.jboss.axis.message.SOAPElementImpl (src) 
          extended byorg.jboss.axis.message.SOAPElementAxisImpl
All Implemented Interfaces:
java.lang.Cloneable, org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPElement (src)
Direct Known Subclasses:
DetailEntryImpl (src) , RPCParamElementImpl (src) , SOAPBodyElementImpl (src) , SOAPBodyImpl (src) , SOAPEnvelopeImpl (src) , SOAPFaultElementImpl (src) , SOAPHeaderElementImpl (src) , SOAPHeaderImpl (src)
public class SOAPElementAxisImpl
extends SOAPElementImpl (src)
implements SOAPElement (src) , java.lang.Cloneable

SOAPElementImpl is the base type of nodes of the SOAP message parse tree.

Nested Class Summary
protected static class SOAPElementAxisImpl.QNameAttr (src)
           
 
Field Summary
protected  boolean _isRoot
           
protected  org.xml.sax.Attributes attributes
           
protected  DeserializationContext (src) 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  SOAPEnvelopeAxisImpl (src) message
           
protected  java.lang.String name
           
 java.util.ArrayList namespaces
           
protected  java.lang.String namespaceURI
           
protected  java.lang.Object objectValue
          Object value, possibly supplied by subclass
protected  java.lang.String prefix
           
protected  java.util.Vector qNameAttrs
           
protected  SAX2EventRecorder (src) recorder
           
protected  MessagePart (src) soapPart
           
protected  int startContentsIndex
           
protected  int startEventIndex
           
protected  QName (src) typeQName
           
 
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
SOAPElementAxisImpl()
          No-arg constructor for building messages?
SOAPElementAxisImpl(org.w3c.dom.Element elem)
           
SOAPElementAxisImpl(Name (src)  eltName)
           
SOAPElementAxisImpl(QName (src)  name, java.lang.Object value)
           
SOAPElementAxisImpl(java.lang.String localPart)
           
SOAPElementAxisImpl(java.lang.String namespace, java.lang.String localPart)
           
SOAPElementAxisImpl(java.lang.String namespace, java.lang.String localPart, java.lang.Object value)
           
SOAPElementAxisImpl(java.lang.String localPart, java.lang.String prefix, java.lang.String namespace)
           
SOAPElementAxisImpl(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext (src)  context)
           
 
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.
 void addAttribute(java.lang.String namespace, java.lang.String localName, QName (src)  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(SOAPElementAxisImpl (src)  el)
          Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.
 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)  element)
          The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.
 SOAPElement (src) addChildElement(java.lang.String localName)
          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.
 void addMapping(Mapping (src)  map)
           
 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)
          Text nodes are not supported.
 org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
           
 org.w3c.dom.Node cloneNode(boolean deep)
           
protected  java.lang.Object clonning()
          protected clone method (not public)

copied status ------------------- protected String name ; Y protected String prefix ; Y protected String namespaceURI ; Y protected transient Attributes attributes Y protected String id; Y? protected String href; Y? protected boolean _isRoot = true; Y? protected SOAPEnvelope message = null; N? protected boolean _isDirty = false; Y? protected transient DeserializationContext context; Y? protected transient QName typeQName = null; Y? protected Vector qNameAttrs = null; Y? protected transient SAX2EventRecorder recorder = null; N? protected int startEventIndex = 0; N? protected int startContentsIndex = 0; N? protected int endEventIndex = -1; N? protected Element elementRep = null; N? protected MessageElement parent = null; N public ArrayList namespaces = null; Y protected String encodingStyle = null; N? private Object objectValue = null; N?
 void detachAllChildren()
           
 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 Name objects in this SOAPElement object.
 org.w3c.dom.Document getAsDocument()
           
 org.w3c.dom.Element getAsDOM()
           
 java.lang.String getAsString()
           
 java.lang.String getAsStringFromInternal()
          Get a string representation from the internal structure.
 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 (src)  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 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.
 org.w3c.dom.NodeList getChildNodes()
           
 java.util.List getChildren()
           
 org.xml.sax.Attributes getCompleteAttributes()
          Obtain an Attributes collection consisting of all attributes for this MessageElement, including namespace declarations.
 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)
           
protected  org.w3c.dom.NodeList getElementsNS(org.w3c.dom.Element parent, java.lang.String namespaceURI, java.lang.String localName)
          helper method for recusively getting the element that has namespace URI and localname
 java.lang.String getEncodingStyle()
          Get the encoding style.
 SOAPEnvelopeAxisImpl (src) getEnvelope()
           
 org.w3c.dom.Node getFirstChild()
           
 Deserializer (src) 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 over the namespace prefix Strings declared by this element.
 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()
           
 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 (src) 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 (src) getQName()
           
 SOAPElementAxisImpl (src) getRealElement()
           
 SAX2EventRecorder (src) getRecorder()
           
 java.lang.String getTagName()
           
 QName (src) getType()
           
 java.lang.Object getValueAsType(QName (src)  type)
           
 java.lang.Object getValueAsType(QName (src)  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 isImmutable()
           
 boolean isRoot()
           
 boolean isSupported(java.lang.String feature, java.lang.String version)
           
protected  org.xml.sax.helpers.AttributesImpl makeAttributesEditable()
           
 void normalize()
           
 void output(SerializationContext (src)  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 (src)  context)
          Subclasses can override
static void printFromInternal(java.io.PrintWriter out, NodeImpl (src)  node)
          Print the given element from the internal representation This should not go on the wire, but is for debugging only.
 void publishContents(org.xml.sax.ContentHandler handler)
           
 void publishToHandler(org.xml.sax.ContentHandler handler)
           
 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)
           
 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 setAllAttributes(org.xml.sax.Attributes attrs)
           
 void setAllImmutable(boolean immutable)
           
 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(SOAPEnvelopeAxisImpl (src)  env)
           
 void setFixupDeserializer(Deserializer (src)  dser)
           
 void setImmutable(boolean immutable)
           
 void setName(java.lang.String name)
           
 void setNamespaceURI(java.lang.String nsURI)
           
 void setNSMappings(java.util.ArrayList namespaces)
           
 void setObjectValue(java.lang.Object newValue)
          Sets value of this node to an Object.
 void setOwnerDocument(MessagePart (src)  sp)
           
 void setParentElement(SOAPElement (src)  parent)
          Sets the parent of this Node object to the given SOAPElement object.
 void setPrefix(java.lang.String prefix)
           
 void setQName(QName (src)  qName)
           
 void setRecorder(SAX2EventRecorder (src)  rec)
           
 void setType(QName (src)  qname)
           
 
Methods inherited from class org.jboss.axis.message.SOAPElementImpl (src)
getSchemaTypeInfo, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from class org.jboss.axis.message.NodeImpl (src)
compareDocumentPosition, getBaseURI, getFeature, getNodeName, getTextContent, getUserData, getValue, hashCode, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, recycleNode, setNodeValue, 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)
getValue, recycleNode, setValue
 
Methods inherited from interface org.w3c.dom.Node
getNodeName, setNodeValue
 

Field Detail

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 SOAPEnvelopeAxisImpl (src)  message

context

protected transient DeserializationContext (src)  context

typeQName

protected transient QName (src)  typeQName

qNameAttrs

protected java.util.Vector qNameAttrs

recorder

protected transient SAX2EventRecorder (src)  recorder

startEventIndex

protected int startEventIndex

startContentsIndex

protected int startContentsIndex

endEventIndex

protected int endEventIndex

elementRep

protected org.w3c.dom.Element elementRep

namespaces

public java.util.ArrayList namespaces

encodingStyle

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

objectValue

protected java.lang.Object objectValue
Object value, possibly supplied by subclass

soapPart

protected MessagePart (src)  soapPart
Constructor Detail

SOAPElementAxisImpl

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

SOAPElementAxisImpl

public SOAPElementAxisImpl(java.lang.String localPart)

SOAPElementAxisImpl

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

SOAPElementAxisImpl

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

SOAPElementAxisImpl

public SOAPElementAxisImpl(Name (src)  eltName)

SOAPElementAxisImpl

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

SOAPElementAxisImpl

public SOAPElementAxisImpl(QName (src)  name,
                           java.lang.Object value)

SOAPElementAxisImpl

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

SOAPElementAxisImpl

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

setFixupDeserializer

public void setFixupDeserializer(Deserializer (src)  dser)

getFixupDeserializer

public Deserializer (src)  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
Overrides:
getFirstChild in class NodeImpl (src)

getLastChild

public org.w3c.dom.Node getLastChild()
Specified by:
getLastChild in interface org.w3c.dom.Node
Overrides:
getLastChild in class NodeImpl (src)

getNextSibling

public org.w3c.dom.Node getNextSibling()
Specified by:
getNextSibling in interface org.w3c.dom.Node
Overrides:
getNextSibling in class NodeImpl (src)

getParentNode

public org.w3c.dom.Node getParentNode()
Specified by:
getParentNode in interface org.w3c.dom.Node
Overrides:
getParentNode in class NodeImpl (src)

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()
Specified by:
getPreviousSibling in interface org.w3c.dom.Node
Overrides:
getPreviousSibling in class NodeImpl (src)

cloneNode

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

clonning

protected java.lang.Object clonning()
                             throws java.lang.CloneNotSupportedException
protected clone method (not public)

copied status ------------------- protected String name ; Y protected String prefix ; Y protected String namespaceURI ; Y protected transient Attributes attributes Y protected String id; Y? protected String href; Y? protected boolean _isRoot = true; Y? protected SOAPEnvelope message = null; N? protected boolean _isDirty = false; Y? protected transient DeserializationContext context; Y? protected transient QName typeQName = null; Y? protected Vector qNameAttrs = null; Y? protected transient SAX2EventRecorder recorder = null; N? protected int startEventIndex = 0; N? protected int startContentsIndex = 0; N? protected int endEventIndex = -1; N? protected Element elementRep = null; N? protected MessageElement parent = null; N public ArrayList namespaces = null; Y protected String encodingStyle = null; N? private Object objectValue = null; N?

Returns:
Throws:
java.lang.CloneNotSupportedException

setAllAttributes

public void setAllAttributes(org.xml.sax.Attributes attrs)

detachAllChildren

public void detachAllChildren()

getChildNodes

public org.w3c.dom.NodeList getChildNodes()
Specified by:
getChildNodes in interface org.w3c.dom.Node
Overrides:
getChildNodes in class NodeImpl (src)

isSupported

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

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
Overrides:
appendChild in class NodeImpl (src)
Throws:
org.w3c.dom.DOMException

addChild

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

Throws:
SOAPException (src)

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
Overrides:
removeChild in class NodeImpl (src)
Throws:
org.w3c.dom.DOMException

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
Overrides:
insertBefore in class NodeImpl (src)
Throws:
org.w3c.dom.DOMException

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
Overrides:
replaceChild in class NodeImpl (src)
Throws:
org.w3c.dom.DOMException

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

setQName

public void setQName(QName (src)  qName)

getPrefix

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

setPrefix

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

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()
Specified by:
getOwnerDocument in interface org.w3c.dom.Node
Overrides:
getOwnerDocument in class NodeImpl (src)

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Specified by:
getAttributes in interface org.w3c.dom.Node
Overrides:
getAttributes in class NodeImpl (src)

getNodeType

public short getNodeType()
Specified by:
getNodeType in interface org.w3c.dom.Node
Overrides:
getNodeType in class NodeImpl (src)

normalize

public void normalize()
Specified by:
normalize in interface org.w3c.dom.Node
Overrides:
normalize in class NodeImpl (src)

hasAttributes

public boolean hasAttributes()
Specified by:
hasAttributes in interface org.w3c.dom.Node
Overrides:
hasAttributes in class NodeImpl (src)

hasChildNodes

public boolean hasChildNodes()
Specified by:
hasChildNodes in interface org.w3c.dom.Node
Overrides:
hasChildNodes in class NodeImpl (src)

getLocalName

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

getNamespaceURI

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

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException
Specified by:
getNodeValue in interface org.w3c.dom.Node
Overrides:
getNodeValue in class NodeImpl (src)
Throws:
org.w3c.dom.DOMException

setNamespaceURI

public void setNamespaceURI(java.lang.String nsURI)

getType

public QName (src)  getType()

setType

public void setType(QName (src)  qname)

getRecorder

public SAX2EventRecorder (src)  getRecorder()

setRecorder

public void setRecorder(SAX2EventRecorder (src)  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 (src)
Overrides:
getEncodingStyle in class SOAPElementImpl (src)
Returns:
the currently in-scope encoding style

removeContents

public void removeContents()
Description copied from interface: SOAPElement (src)
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)
Overrides:
removeContents in class SOAPElementImpl (src)

getVisibleNamespacePrefixes

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

setEncodingStyle

public void setEncodingStyle(java.lang.String encodingStyle)
                      throws SOAPException (src)
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 (src)
Overrides:
setEncodingStyle in class SOAPElementImpl (src)
Parameters:
encodingStyle - a String giving the encoding style
Throws:
java.lang.IllegalArgumentException - if there was a problem in the encoding style being set.
SOAPException (src) - if there was a problem in the encoding style being set.
See Also:
getEncodingStyle()

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 (src)
Returns the URI of the namespace that has the given prefix.

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

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.
Throws:
java.lang.Exception

setObjectValue

public void setObjectValue(java.lang.Object newValue)
                    throws SOAPException (src)
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.
Throws:
SOAPException (src)

getValueAsType

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

getValueAsType

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

addAttribute

public void addAttribute(java.lang.String namespace,
                         java.lang.String localName,
                         QName (src)  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(SOAPEnvelopeAxisImpl (src)  env)

getEnvelope

public SOAPEnvelopeAxisImpl (src)  getEnvelope()

getRealElement

public SOAPElementAxisImpl (src)  getRealElement()

getAsDOM

public org.w3c.dom.Element getAsDOM()

getAsDocument

public org.w3c.dom.Document getAsDocument()

getAsString

public java.lang.String getAsString()

getAsStringFromInternal

public java.lang.String getAsStringFromInternal()
Get a string representation from the internal structure. This should not go on the wire, but is for debugging only.

printFromInternal

public static void printFromInternal(java.io.PrintWriter out,
                                     NodeImpl (src)  node)
                              throws java.lang.Exception
Print the given element from the internal representation This should not go on the wire, but is for debugging only.

Throws:
java.lang.Exception

publishToHandler

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

publishContents

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

output

public final void output(SerializationContext (src)  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.
Throws:
java.lang.Exception

outputImpl

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

Throws:
java.lang.Exception

addMapping

public void addMapping(Mapping (src)  map)

setParentElement

public void setParentElement(SOAPElement (src)  parent)
                      throws SOAPException (src)
Description copied from interface: Node (src)
Sets the parent of this Node object to the given SOAPElement object.

Specified by:
setParentElement in interface Node (src)
Overrides:
setParentElement in class NodeImpl (src)
Parameters:
parent - the SOAPElement object to be set as the parent of this Node object
Throws:
SOAPException (src) - if there is a problem in setting the parent to the given node

getParentElement

public SOAPElement (src)  getParentElement()
Description copied from interface: Node (src)
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 (src)
Overrides:
getParentElement in class NodeImpl (src)
Returns:
the SOAPElement object that is the parent of this Node object or null if this Node object is root

detachNode

public void detachNode()
Break the relationship between this element and its parent, if any.

Specified by:
detachNode in interface Node (src)
Overrides:
detachNode in class NodeImpl (src)

isImmutable

public boolean isImmutable()

setImmutable

public void setImmutable(boolean immutable)

setAllImmutable

public void setAllImmutable(boolean immutable)

addChildElement

public SOAPElement (src)  addChildElement(Name (src)  name)
                            throws SOAPException (src)
Description copied from interface: SOAPElement (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)
Overrides:
addChildElement in class SOAPElementImpl (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(java.lang.String localName)
                            throws SOAPException (src)
Description copied from interface: SOAPElement (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)
Overrides:
addChildElement in class SOAPElementImpl (src)
Parameters:
localName - 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)
Description copied from interface: SOAPElement (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)
Overrides:
addChildElement in class SOAPElementImpl (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)
Description copied from interface: SOAPElement (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)
Overrides:
addChildElement in class SOAPElementImpl (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(SOAPElement (src)  element)
                            throws SOAPException (src)
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 (src)
Overrides:
addChildElement in class SOAPElementImpl (src)
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 (src) - if there was an error in adding this element as a child

addTextNode

public SOAPElement (src)  addTextNode(java.lang.String value)
                        throws SOAPException (src)
Text nodes are not supported.

Specified by:
addTextNode in interface SOAPElement (src)
Overrides:
addTextNode in class SOAPElementImpl (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

addAttribute

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

Specified by:
addAttribute in interface SOAPElement (src)
Overrides:
addAttribute in class SOAPElementImpl (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

addNamespaceDeclaration

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

Specified by:
addNamespaceDeclaration in interface SOAPElement (src)
Overrides:
addNamespaceDeclaration in class SOAPElementImpl (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

getAttributeValue

public java.lang.String getAttributeValue(Name (src)  name)
Description copied from interface: SOAPElement (src)
Returns the value of the attribute with the specified name.

Specified by:
getAttributeValue in interface SOAPElement (src)
Overrides:
getAttributeValue in class SOAPElementImpl (src)
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 (src)
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)
Overrides:
getAllAttributes in class SOAPElementImpl (src)
Returns:
an iterator over the names of the attributes

getNamespacePrefixes

public java.util.Iterator getNamespacePrefixes()
Description copied from interface: SOAPElement (src)
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)
Overrides:
getNamespacePrefixes in class SOAPElementImpl (src)
Returns:
an iterator over the namespace prefixes in this SOAPElement object

getElementName

public Name (src)  getElementName()
Description copied from interface: SOAPElement (src)
Returns the name of this SOAPElement object.

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

removeAttribute

public boolean removeAttribute(Name (src)  name)
Description copied from interface: SOAPElement (src)
Removes the attribute with the specified name.

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

removeNamespaceDeclaration

public boolean removeNamespaceDeclaration(java.lang.String prefix)
Description copied from interface: SOAPElement (src)
Removes the namespace declaration corresponding to the given prefix.

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

getChildElements

public java.util.Iterator getChildElements()
Description copied from interface: SOAPElement (src)
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)
Overrides:
getChildElements in class SOAPElementImpl (src)
Returns:
an iterator with the content of this SOAPElement object

getChildElements

public java.util.Iterator getChildElements(Name (src)  name)
Description copied from interface: SOAPElement (src)
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)
Overrides:
getChildElements in class SOAPElementImpl (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

getTagName

public java.lang.String getTagName()
Specified by:
getTagName in interface org.w3c.dom.Element
Overrides:
getTagName in class SOAPElementImpl (src)

removeAttribute

public void removeAttribute(java.lang.String name)
                     throws org.w3c.dom.DOMException
Specified by:
removeAttribute in interface org.w3c.dom.Element
Overrides:
removeAttribute in class SOAPElementImpl (src)
Throws:
org.w3c.dom.DOMException

hasAttribute

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

getAttribute

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

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
Overrides:
removeAttributeNS in class SOAPElementImpl (src)
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
Overrides:
setAttribute in class SOAPElementImpl (src)
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
Overrides:
hasAttributeNS in class SOAPElementImpl (src)

getAttributeNode

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

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
Overrides:
removeAttributeNode in class SOAPElementImpl (src)
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
Overrides:
setAttributeNode in class SOAPElementImpl (src)
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
Overrides:
setAttributeNodeNS in class SOAPElementImpl (src)
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
Overrides:
getElementsByTagName in class SOAPElementImpl (src)

getAttributeNS

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

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
Overrides:
setAttributeNS in class SOAPElementImpl (src)
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
Overrides:
getAttributeNodeNS in class SOAPElementImpl (src)

getElementsByTagNameNS

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

getElementsNS

protected org.w3c.dom.NodeList getElementsNS(org.w3c.dom.Element parent,
                                             java.lang.String namespaceURI,
                                             java.lang.String localName)
helper method for recusively getting the element that has namespace URI and localname

setOwnerDocument

public void setOwnerDocument(MessagePart (src)  sp)

getChildren

public java.util.List getChildren()
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