org.apache.axis2.om.impl.llom
Class OMElementImpl

java.lang.Object
  org.apache.axis2.om.impl.llom.OMNodeImpl
      org.apache.axis2.om.impl.llom.OMElementImpl

All Implemented Interfaces:

OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx

Direct Known Subclasses:

RPCRequestElement, RPCResponseElement, SOAPElement, SOAPHeaderBlockImpl

public class OMElementImpl

extends OMNodeImpl

implements OMElement, OMConstants, OMContainerEx

Class OMElementImpl

Field Summary

protected java.util.HashMap	attributes Field attributes
protected OMNode	firstChild Field firstChild
protected java.lang.String	localName Field localName
protected java.util.HashMap	namespaces Field namespaces
protected int	noPrefixNamespaceCounter Field noPrefixNamespaceCounter
protected OMNamespace	ns Field ns

Fields inherited from class org.apache.axis2.om.impl.llom.OMNodeImpl

builder, done, nextSibling, nodeType, parent, previousSibling

Fields inherited from interface org.apache.axis2.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Fields inherited from interface org.apache.axis2.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DEFAULT_CHAR_SET_ENCODING, DEFAULT_XML_VERSION, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

OMElementImpl(javax.xml.namespace.QName qname, OMContainer parent)
Here it is assumed that this QName passed, at least contains the localName for this element

OMElementImpl(java.lang.String localName, OMNamespace ns)
Constructor OMElementImpl

OMElementImpl(java.lang.String localName, OMNamespace ns, OMContainer parent)
This is the basic constructor for OMElement.

OMElementImpl(java.lang.String localName, OMNamespace ns, OMContainer parent, OMXMLParserWrapper builder)
Constructor OMElementImpl

Method Summary

OMAttribute	addAttribute(OMAttribute attr) This will insert attribute to this element.
OMAttribute	addAttribute(java.lang.String attributeName, java.lang.String value, OMNamespace ns) Method addAttribute
void	addChild(OMNode child) This will add child to the element.
void	buildNext() This will force the parser to proceed, if parser has not yet finished with the XML input
OMElement	cloneOMElement() This method will clone this element.
OMNamespace	declareNamespace(OMNamespace namespace) Declare a namespace with the element as its scope.
OMNamespace	declareNamespace(java.lang.String uri, java.lang.String prefix) THis will create a namespace in the current element scope
OMNode	detach() This will remove this information item and its children, from the model completely
void	discard() Discard implementation
OMNamespace	findNamespace(java.lang.String uri, java.lang.String prefix) This will find a namespace with the given uri and prefix, in the scope of the docuemnt.
OMNamespace	findNamespaceURI(java.lang.String prefix) This will check for a namespace in the context of this element with the given prefix and will return the relevant namespace object, if available.
java.util.Iterator	getAllAttributes() This will return a List of OMAttributes
java.util.Iterator	getAllDeclaredNamespaces() Method getAllDeclaredNamespaces
OMAttribute	getAttribute(javax.xml.namespace.QName qname) Return a named attribute if present
java.lang.String	getAttributeValue(javax.xml.namespace.QName qname) Return a named attribute's value, if present.
OMXMLParserWrapper	getBuilder() Method getBuilder
java.util.Iterator	getChildElements() Returns a filtered list of children - just the elements.
java.util.Iterator	getChildren() This returns a collection of this element.
java.util.Iterator	getChildrenWithName(javax.xml.namespace.QName elementQName) This will search for children with a given QName and will return an iterator to traverse through the OMNodes.
OMAttribute	getFirstAttribute(javax.xml.namespace.QName qname) This will help to search for an attribute with a given QName within this Element
OMElement	getFirstChildWithName(javax.xml.namespace.QName elementQName) Method getFirstChildWithName
OMElement	getFirstElement() Get first element
OMNode	getFirstOMChild() Method getFirstOMChild
java.lang.String	getLocalName() Method getLocalName
OMNamespace	getNamespace() Method getNamespace
OMNode	getNextOMSibling() This will give the next sibling.
javax.xml.namespace.QName	getQName() Method getQName
java.lang.String	getText() select all the text children and concat them to a single string
java.lang.String	getTrimmedText() Returns the concatanation of TRIMMED values of all OMText child nodes of this element This is incuded purely to improve usability
int	getType() This is to get the type of node, as this is the super class of all the nodes
javax.xml.stream.XMLStreamReader	getXMLStreamReader() getXMLStreamReader
javax.xml.stream.XMLStreamReader	getXMLStreamReaderWithoutCaching() getXMLStreamReaderWithoutCaching
boolean	isComplete() Method isComplete
void	removeAttribute(OMAttribute attr) Method removeAttribute
javax.xml.namespace.QName	resolveQName(java.lang.String qname) Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context unprefixed qnames resolve to the local namespace
void	serialize(OMOutputImpl omOutput) Method serializeAndConsume
protected void	serialize(OMOutputImpl omOutput, boolean cache)
void	serializeAndConsume(OMOutputImpl omOutput) This was requested during the second Axis2 summit.
void	setBuilder(OMXMLParserWrapper wrapper) Method setBuilder
void	setFirstChild(OMNode firstChild) Method setFirstChild
void	setLocalName(java.lang.String localName) Method setLocalName
void	setNamespace(OMNamespace namespace) Method setNamespace
void	setText(java.lang.String text) Sets the text of the given element.
java.lang.String	toString() This is a convenience method only.
java.lang.String	toStringWithConsume() This is a convenience method only.

Methods inherited from class org.apache.axis2.om.impl.llom.OMNodeImpl

build, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axis2.om.OMNode

build, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axis2.om.impl.OMContainerEx

setComplete

Field Detail

ns

protected OMNamespace ns

Field ns

localName

protected java.lang.String localName

Field localName

firstChild

protected OMNode firstChild

Field firstChild

namespaces

protected java.util.HashMap namespaces

Field namespaces

attributes

protected java.util.HashMap attributes

Field attributes

noPrefixNamespaceCounter

protected int noPrefixNamespaceCounter

Field noPrefixNamespaceCounter

Constructor Detail

OMElementImpl

public OMElementImpl(java.lang.String localName,
                     OMNamespace ns,
                     OMContainer parent,
                     OMXMLParserWrapper builder)

Constructor OMElementImpl

OMElementImpl

public OMElementImpl(java.lang.String localName,
                     OMNamespace ns)

Constructor OMElementImpl

OMElementImpl

public OMElementImpl(java.lang.String localName,
                     OMNamespace ns,
                     OMContainer parent)

This is the basic constructor for OMElement. All the other constructors within this class will depend on this.

Parameters:

localName - - this MUST always be not null

ns - - can be null

parent - - this should be an OMContainer

OMElementImpl

public OMElementImpl(javax.xml.namespace.QName qname,
                     OMContainer parent)
              throws OMException

Here it is assumed that this QName passed, at least contains the localName for this element

Parameters:

qname - - this should be valid qname according to javax.xml.namespace.QName

Throws:

OMException

Method Detail

addChild

public void addChild(OMNode child)

This will add child to the element. One can decide whether he append the child or he adds to the front of the children list

Specified by:

addChild in interface OMContainer

Parameters:

child -

getChildrenWithName

public java.util.Iterator getChildrenWithName(javax.xml.namespace.QName elementQName)

This will search for children with a given QName and will return an iterator to traverse through the OMNodes. This QName can contain any combination of prefix, localname and URI

Specified by:

getChildrenWithName in interface OMContainer

Parameters:

elementQName - The QName specifying namespace and local name to match.

Returns:

An iterator of OMElement items that match the given QName appropriately.

Throws:

OMException

OMException

getFirstChildWithName

public OMElement getFirstChildWithName(javax.xml.namespace.QName elementQName)
                                throws OMException

Method getFirstChildWithName

Specified by:

getFirstChildWithName in interface OMContainer

Parameters:

elementQName - The QName to use for matching.

Returns:

The first element in document order that matches the elementQName criteria.

Throws:

OMException

See Also:

OMContainer.getChildrenWithName(javax.xml.namespace.QName)

getNextOMSibling

public OMNode getNextOMSibling()
                        throws OMException

This will give the next sibling. This can be an OMAttribute for OMAttribute or OMText or OMELement for others.

Specified by:

getNextOMSibling in interface OMNode

Overrides:

getNextOMSibling in class OMNodeImpl

Returns:

Throws:

OMException

OMException

getChildren

public java.util.Iterator getChildren()

This returns a collection of this element. Children can be of types OMElement, OMText.

Specified by:

getChildren in interface OMContainer

Returns:

children

See Also:

OMContainer.getFirstChildWithName(javax.xml.namespace.QName), OMContainer.getChildrenWithName(javax.xml.namespace.QName)

getChildElements

public java.util.Iterator getChildElements()

Returns a filtered list of children - just the elements.

Specified by:

getChildElements in interface OMElement

Returns:

an iterator over the child elements

See Also:

OMContainer.getChildren(), OMContainer.getChildrenWithName(javax.xml.namespace.QName)

declareNamespace

public OMNamespace declareNamespace(java.lang.String uri,
                                    java.lang.String prefix)

THis will create a namespace in the current element scope

Specified by:

declareNamespace in interface OMElement

Parameters:

uri - The namespace to declare in the current scope. The caller is expected to ensure that the URI is a valid namespace name.

prefix - The prefix to associate with the given namespace. The caller is expected to ensure that this is a valid XML prefix.

Returns:

namespace

See Also:

OMElement.declareNamespace(OMNamespace), OMElement.findNamespace(String, String), OMElement.getAllDeclaredNamespaces()

declareNamespace

public OMNamespace declareNamespace(OMNamespace namespace)

Description copied from interface: OMElement

Declare a namespace with the element as its scope.

Specified by:

declareNamespace in interface OMElement

Parameters:

namespace - The namespace to declare

Returns:

namespace

See Also:

OMElement.declareNamespace(String, String), OMElement.findNamespace(String, String), OMElement.getAllDeclaredNamespaces()

findNamespace

public OMNamespace findNamespace(java.lang.String uri,
                                 java.lang.String prefix)

This will find a namespace with the given uri and prefix, in the scope of the docuemnt. This will start to find from the current element and goes up in the hiararchy until this finds one. If none is found, return null

Specified by:

findNamespace in interface OMElement

Parameters:

uri - The namespace to look for. If this is specified, prefix should be null.

prefix - The prefix to look for. If this is specified, uri should be null.

Returns:

The matching namespace declaration, or null if none was found.

See Also:

OMElement.declareNamespace(String, String), OMElement.declareNamespace(OMNamespace), OMElement.getAllDeclaredNamespaces()

findNamespaceURI

public OMNamespace findNamespaceURI(java.lang.String prefix)

Description copied from interface: OMElement

This will check for a namespace in the context of this element with the given prefix and will return the relevant namespace object, if available. If not available, will return null.

Specified by:

findNamespaceURI in interface OMElement

Parameters:

prefix -

getAllDeclaredNamespaces

public java.util.Iterator getAllDeclaredNamespaces()

Method getAllDeclaredNamespaces

Specified by:

getAllDeclaredNamespaces in interface OMElement

Returns:

iterator

See Also:

OMElement.findNamespace(String, String), OMElement.declareNamespace(String, String), OMElement.declareNamespace(OMNamespace)

getFirstAttribute

public OMAttribute getFirstAttribute(javax.xml.namespace.QName qname)

This will help to search for an attribute with a given QName within this Element

Specified by:

getFirstAttribute in interface OMElement

Parameters:

qname - The attribute name to match.

Returns:

The attribute, if found, or null otherwise.

getAllAttributes

public java.util.Iterator getAllAttributes()

This will return a List of OMAttributes

Specified by:

getAllAttributes in interface OMElement

Returns:

iterator

See Also:

OMElement.getAttribute(javax.xml.namespace.QName), OMElement.addAttribute(OMAttribute), OMElement.addAttribute(String, String, OMNamespace)

getAttribute

public OMAttribute getAttribute(javax.xml.namespace.QName qname)

Return a named attribute if present

Specified by:

getAttribute in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

an OMAttribute with the given name if found, or null

getAttributeValue

public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)

Return a named attribute's value, if present.

Specified by:

getAttributeValue in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

a String containing the attribute value, or null

addAttribute

public OMAttribute addAttribute(OMAttribute attr)

This will insert attribute to this element. Implementor can decide as to insert this in the front or at the end of set of attributes

Specified by:

addAttribute in interface OMElement

Parameters:

attr - The attribute to add.

Returns:

attribute

removeAttribute

public void removeAttribute(OMAttribute attr)

Method removeAttribute

Specified by:

removeAttribute in interface OMElement

Parameters:

attr -

addAttribute

public OMAttribute addAttribute(java.lang.String attributeName,
                                java.lang.String value,
                                OMNamespace ns)

Method addAttribute

Specified by:

addAttribute in interface OMElement

Parameters:

attributeName - The "local name" for the attribute.

value - The string value of the attribute.

ns - The namespace has to be one of the in scope namespace. i.e. the passed namespace must be declared in the parent element of this attribute or ancestors of the parent element of the attribute.

Returns:

attribute

setBuilder

public void setBuilder(OMXMLParserWrapper wrapper)

Method setBuilder

Specified by:

setBuilder in interface OMElement

Parameters:

wrapper -

getBuilder

public OMXMLParserWrapper getBuilder()

Method getBuilder

Specified by:

getBuilder in interface OMElement

Returns:

builder

buildNext

public void buildNext()

This will force the parser to proceed, if parser has not yet finished with the XML input

Specified by:

buildNext in interface OMContainer

getFirstOMChild

public OMNode getFirstOMChild()

Method getFirstOMChild

Specified by:

getFirstOMChild in interface OMContainer

Returns:

child

setFirstChild

public void setFirstChild(OMNode firstChild)

Method setFirstChild

Specified by:

setFirstChild in interface OMElement

Parameters:

firstChild -

detach

public OMNode detach()
              throws OMException

This will remove this information item and its children, from the model completely

Specified by:

detach in interface OMNode

Overrides:

detach in class OMNodeImpl

Throws:

OMException

OMException

isComplete

public boolean isComplete()

Method isComplete

Specified by:

isComplete in interface OMNode

Overrides:

isComplete in class OMNodeImpl

Returns:

boolean

getType

public int getType()

This is to get the type of node, as this is the super class of all the nodes

Specified by:

getType in interface OMNode

Overrides:

getType in class OMNodeImpl

Returns:

Returns the type of node as indicated by OMNodeImpl.setType(int)

See Also:

OMNodeImpl.setType(int)

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()

getXMLStreamReader

Specified by:

getXMLStreamReader in interface OMElement

Returns:

Return an XMLStreamReader relative to this element.

See Also:

OMElement.getXMLStreamReader()

getXMLStreamReaderWithoutCaching

public javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()

getXMLStreamReaderWithoutCaching

Specified by:

getXMLStreamReaderWithoutCaching in interface OMElement

Returns:

Return an XMLStreamReader relative to this element, with no caching.

See Also:

OMElement.getXMLStreamReaderWithoutCaching()

setText

public void setText(java.lang.String text)

Sets the text of the given element. caution - This method will wipe out all the text elements (and hence any moxed content) before setting the text

Specified by:

setText in interface OMElement

Parameters:

text -

getText

public java.lang.String getText()

select all the text children and concat them to a single string

Specified by:

getText in interface OMElement

Returns:

text

getTrimmedText

public java.lang.String getTrimmedText()

Returns the concatanation of TRIMMED values of all OMText child nodes of this element This is incuded purely to improve usability

serialize

public void serialize(OMOutputImpl omOutput)
               throws javax.xml.stream.XMLStreamException

Method serializeAndConsume

Specified by:

serialize in interface OMNodeEx

Overrides:

serialize in class OMNodeImpl

Parameters:

omOutput -

Throws:

javax.xml.stream.XMLStreamException

See Also:

OMNodeImpl.serialize(org.apache.axis2.om.impl.OMOutputImpl)

serialize

protected void serialize(OMOutputImpl omOutput,
                         boolean cache)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(OMOutputImpl omOutput)
                         throws javax.xml.stream.XMLStreamException

This was requested during the second Axis2 summit. When one call this method, this will serializeAndConsume without building the object structure in the memory. Misuse of this method will cause loss of data.So its advised to use populateYourSelf() method, before this, if you want to preserve data in the stream.

Specified by:

serializeAndConsume in interface OMNodeEx

Overrides:

serializeAndConsume in class OMNodeImpl

Parameters:

omOutput -

Throws:

javax.xml.stream.XMLStreamException

See Also:

OMNodeImpl.serializeAndConsume(org.apache.axis2.om.impl.OMOutputImpl)

getFirstElement

public OMElement getFirstElement()

Get first element

Specified by:

getFirstElement in interface OMElement

Returns:

element

getLocalName

public java.lang.String getLocalName()

Method getLocalName

Specified by:

getLocalName in interface OMElement

Returns:

local name

setLocalName

public void setLocalName(java.lang.String localName)

Method setLocalName

Specified by:

setLocalName in interface OMElement

Parameters:

localName -

getNamespace

public OMNamespace getNamespace()
                         throws OMException

Method getNamespace

Specified by:

getNamespace in interface OMElement

Returns:

the OMNamespace object associated with this element

Throws:

OMException

setNamespace

public void setNamespace(OMNamespace namespace)

Method setNamespace

Specified by:

setNamespace in interface OMElement

Parameters:

namespace -

getQName

public javax.xml.namespace.QName getQName()

Method getQName

Specified by:

getQName in interface OMElement

Returns:

qname

toStringWithConsume

public java.lang.String toStringWithConsume()
                                     throws javax.xml.stream.XMLStreamException

Description copied from interface: OMElement

This is a convenience method only. This will basically serialize the given OMElement to a String but will NOT build the OMTree in the memory. So you are at your own risk of losing information.

Specified by:

toStringWithConsume in interface OMElement

Throws:

javax.xml.stream.XMLStreamException

toString

public java.lang.String toString()

Description copied from interface: OMElement

This is a convenience method only. This will basically serialize the given OMElement to a String but will build the OMTree in the memory

Specified by:

toString in interface OMElement

discard

public void discard()
             throws OMException

Discard implementation

Specified by:

discard in interface OMNode

Throws:

OMException

resolveQName

public javax.xml.namespace.QName resolveQName(java.lang.String qname)

Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context unprefixed qnames resolve to the local namespace

Specified by:

resolveQName in interface OMElement

Parameters:

qname - prefixed qname string to resolve

Returns:

null for any failure to extract a qname.

cloneOMElement

public OMElement cloneOMElement()

Description copied from interface: OMElement

This method will clone this element. But both elements will be build compleletely. So you will lose the differed building capability.

Specified by:

cloneOMElement in interface OMElement

Returns: