org.apache.axiom.om.impl.llom

Class OMElementImpl

java.lang.Object

org.apache.axiom.om.impl.llom.OMSerializableImpl

org.apache.axiom.om.impl.llom.OMNodeImpl

org.apache.axiom.om.impl.llom.OMElementImpl

All Implemented Interfaces:

OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, OMSerializable

Direct Known Subclasses:

OMSourcedElementImpl, SOAPElement

public class OMElementImpl
extends OMNodeImpl
implements OMElement, OMConstants, OMContainerEx

Class OMElementImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap	attributes Field attributes
static OMNamespace	DEFAULT_DEFAULT_NS_OBJECT
protected OMNode	firstChild Field firstChild
protected OMNode	lastChild
protected String	localName Field localName
protected HashMap	namespaces Field namespaces
protected int	noPrefixNamespaceCounter Field noPrefixNamespaceCounter
protected OMNamespace	ns Field ns
protected QName	qName

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

nextSibling, nodeType, parent, previousSibling

Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

builder, done, factory

Fields inherited from interface org.apache.axiom.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.axiom.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

Constructors

Constructor and Description
OMElementImpl(QName qname, OMContainer parent, OMFactory factory) It is assumed that the QName passed contains, at least, the localName for this element.
OMElementImpl(String localName, OMNamespace ns, OMContainer parent, OMFactory factory) This is the basic constructor for OMElement.
OMElementImpl(String localName, OMNamespace ns, OMContainer parent, OMXMLParserWrapper builder, OMFactory factory) Constructor OMElementImpl.
OMElementImpl(String localName, OMNamespace ns, OMFactory factory) Constructor OMElementImpl.

Method Summary

Modifier and Type	Method and Description
OMAttribute	addAttribute(OMAttribute attr) Inserts an attribute to this element.
OMAttribute	addAttribute(String attributeName, String value, OMNamespace ns) Adds an attribute to this element.
void	addChild(OMNode child) Adds child to the element.
void	build() Parses this node and builds the object structure in memory.
void	buildNext() Forces the parser to proceed, if parser has not yet finished with the XML input.
void	buildWithAttachments() Parses this node and builds the object structure in memory.
OMElement	cloneOMElement() Clones this element.
OMNamespace	declareDefaultNamespace(String uri) We use "" to store the default namespace of this element.
OMNamespace	declareNamespace(OMNamespace namespace) Declares a namespace with the element as its scope.
OMNamespace	declareNamespace(String uri, String prefix) Creates a namespace in the current element scope.
OMNode	detach() Removes this information item and its children, from the model completely.
void	discard() Method discard.
OMNamespace	findNamespace(String uri, String prefix) Finds a namespace with the given uri and prefix, in the scope of the document.
OMNamespace	findNamespaceURI(String prefix) Checks for a namespace in the context of this element with the given prefix and returns the relevant namespace object, if available.
Iterator	getAllAttributes() Returns a List of OMAttributes.
Iterator	getAllDeclaredNamespaces() Method getAllDeclaredNamespaces.
OMAttribute	getAttribute(QName qname) Returns a named attribute if present.
String	getAttributeValue(QName qname) Returns a named attribute's value, if present.
OMXMLParserWrapper	getBuilder() Method getBuilder.
Iterator	getChildElements() Returns a filtered list of children - just the elements.
Iterator	getChildren() Returns a collection of this element.
Iterator	getChildrenWithLocalName(String localName) Returns an iterator for child nodes matching the local name.
Iterator	getChildrenWithName(QName elementQName) Searches for children with a given QName and returns an iterator to traverse through the OMNodes.
Iterator	getChildrenWithNamespaceURI(String uri) Returns an iterator for child nodes matching the namespace uri.
OMNamespace	getDefaultNamespace() This will retrieve the default namespace of this element, if available. null returned if none is found.
OMElement	getFirstChildWithName(QName elementQName) Method getFirstChildWithName.
OMElement	getFirstElement() Gets first element.
OMNode	getFirstOMChild() Method getFirstOMChild.
OMNode	getFirstOMChildIfAvailable() Get the first child if it is available.
int	getLineNumber()
String	getLocalName() Method getLocalName.
OMNamespace	getNamespace() Get the namespace this element is part of.
String	getNamespaceURI() Get the namespace URI of the element.
OMNode	getNextOMSibling() Gets the next sibling.
QName	getQName() Method getQName.
String	getText() Selects all the text children and concatenates them to a single string.
QName	getTextAsQName() OMText can contain its information as a QName as well.
String	getTrimmedText() Returns the concatination string of TRIMMED values of all OMText child nodes of this element.
int	getType() Gets the type of node, as this is the super class of all the nodes.
XMLStreamReader	getXMLStreamReader() Get a pull parser representation of this element with caching enabled.
XMLStreamReader	getXMLStreamReader(boolean cache) Get a pull parser representation of this element.
XMLStreamReader	getXMLStreamReaderWithoutCaching() Get a pull parser representation of this element with caching disabled.
void	internalSerialize(XMLStreamWriter writer, boolean cache) Serializes the node.
protected void	notifyChildComplete() This method will be called when one of the children becomes complete.
void	removeAttribute(OMAttribute attr) Method removeAttribute.
QName	resolveQName(String qname) Resolves a QName literal in the namespace context defined by this element and produces a corresponding QName object.
void	setBuilder(OMXMLParserWrapper wrapper) Method setBuilder.
void	setFirstChild(OMNode firstChild) Method setFirstChild.
void	setLastChild(OMNode omNode) forcefully set the last element in this parent element
void	setLineNumber(int lineNumber)
void	setLocalName(String localName) Method setLocalName.
void	setNamespace(OMNamespace namespace) Method setNamespace.
void	setNamespaceWithNoFindInCurrentScope(OMNamespace namespace) This will not search the namespace in the scope nor will declare in the current element, as in setNamespace(OMNamespace).
void	setText(QName text) Sets the text, as a QName, of the given element. caution - This method will wipe out all the text elements (and hence any mixed content) before setting the text.
void	setText(String text) Sets the text of the given element. caution - This method will wipe out all the text elements (and hence any mixed content) before setting the text.
String	toString() This is a convenience method only.
String	toStringWithConsume() This is a convenience method only.

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

getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling, setType

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

close, getOMFactory, isComplete, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axiom.om.OMElement

serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore

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

setComplete

Methods inherited from interface org.apache.axiom.om.OMSerializable

close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

Field Detail

DEFAULT_DEFAULT_NS_OBJECT

public static final OMNamespace DEFAULT_DEFAULT_NS_OBJECT

ns

protected OMNamespace ns

Field ns

localName

protected String localName

Field localName

qName

protected QName qName

firstChild

protected OMNode firstChild

Field firstChild

namespaces

protected HashMap namespaces

Field namespaces

attributes

protected HashMap attributes

Field attributes

noPrefixNamespaceCounter

protected int noPrefixNamespaceCounter

Field noPrefixNamespaceCounter

lastChild

protected OMNode lastChild

Constructor Detail

OMElementImpl

public OMElementImpl(String localName,
                     OMNamespace ns,
                     OMContainer parent,
                     OMXMLParserWrapper builder,
                     OMFactory factory)

Constructor OMElementImpl. A null namespace indicates that the default namespace in scope is used

OMElementImpl

public OMElementImpl(String localName,
                     OMNamespace ns,
                     OMFactory factory)

Constructor OMElementImpl.

OMElementImpl

public OMElementImpl(String localName,
                     OMNamespace ns,
                     OMContainer parent,
                     OMFactory factory)

This is the basic constructor for OMElement. All the other constructors depends on this.

Parameters:

localName - - this MUST always be not null

ns - - can be null

parent - - this should be an OMContainer

factory - - factory that created this OMElement

A null namespace indicates that the default namespace in scope is used

OMElementImpl

public OMElementImpl(QName qname,
                     OMContainer parent,
                     OMFactory factory)
              throws OMException

It is assumed that the QName passed contains, at least, 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)

Adds child to the element. One can decide whether to append the child or to add to the front of the children list.

Specified by:

addChild in interface OMContainer

getChildrenWithName

public Iterator getChildrenWithName(QName elementQName)

Searches for children with a given QName and returns 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:

Returns an iterator of OMElement items that match the given QName

Throws:

OMException

getChildrenWithLocalName

public Iterator getChildrenWithLocalName(String localName)

Description copied from interface: OMContainer

Returns an iterator for child nodes matching the local name.

Specified by:

getChildrenWithLocalName in interface OMContainer

Returns:

Returns an iterator of OMElement items that match the given localName

getChildrenWithNamespaceURI

public Iterator getChildrenWithNamespaceURI(String uri)

Description copied from interface: OMContainer

Returns an iterator for child nodes matching the namespace uri.

Specified by:

getChildrenWithNamespaceURI in interface OMContainer

Returns:

Returns an iterator of OMElement items that match the given uri

getFirstChildWithName

public OMElement getFirstChildWithName(QName elementQName)
                                throws OMException

Method getFirstChildWithName.

Specified by:

getFirstChildWithName in interface OMContainer

Parameters:

elementQName - The QName to use for matching.

Returns:

The first child element in document order that matches the qname criteria, or null if none is found.

Throws:

OMException

See Also:

OMContainer.getChildrenWithName(QName)

getNextOMSibling

public OMNode getNextOMSibling()
                        throws OMException

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

Specified by:

getNextOMSibling in interface OMNode

Overrides:

getNextOMSibling in class OMNodeImpl

Returns:

Returns OMNode.

Throws:

OMException

getChildren

public Iterator getChildren()

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

Specified by:

getChildren in interface OMContainer

Returns:

Returns children.

See Also:

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

getChildElements

public Iterator getChildElements()

Returns a filtered list of children - just the elements.

Specified by:

getChildElements in interface OMElement

Returns:

Returns an iterator of the child elements.

See Also:

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

declareNamespace

public OMNamespace declareNamespace(String uri,
                                    String prefix)

Creates 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. If "" is given, first this will check for an existing namespace with the same uri. If not found, a prefix will be auto-generated.

Returns:

Returns namespace.

See Also:

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

declareDefaultNamespace

public OMNamespace declareDefaultNamespace(String uri)

We use "" to store the default namespace of this element. As one can see user can not give "" as the prefix, when he declare a usual namespace.

Specified by:

declareDefaultNamespace in interface OMElement

Parameters:

uri -

getDefaultNamespace

public OMNamespace getDefaultNamespace()

Description copied from interface: OMElement

This will retrieve the default namespace of this element, if available. null returned if none is found.

Specified by:

getDefaultNamespace in interface OMElement

declareNamespace

public OMNamespace declareNamespace(OMNamespace namespace)

Description copied from interface: OMElement

Declares a namespace with the element as its scope.

Specified by:

declareNamespace in interface OMElement

Parameters:

namespace - The namespace to declare.

Returns:

Returns namespace.

See Also:

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

findNamespace

public OMNamespace findNamespace(String uri,
                                 String prefix)

Finds a namespace with the given uri and prefix, in the scope of the document. Starts to find from the current element and goes up in the hiararchy until one is found. If none is found, returns 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:

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(String prefix)

Description copied from interface: OMElement

Checks for a namespace in the context of this element with the given prefix and returns the relevant namespace object, if available. If not available, returns null.

Specified by:

findNamespaceURI in interface OMElement

getAllDeclaredNamespaces

public Iterator getAllDeclaredNamespaces()

Method getAllDeclaredNamespaces.

Specified by:

getAllDeclaredNamespaces in interface OMElement

Returns:

Returns Iterator.

See Also:

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

getAllAttributes

public Iterator getAllAttributes()

Returns a List of OMAttributes.

Specified by:

getAllAttributes in interface OMElement

Returns:

Returns iterator.

See Also:

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

getAttribute

public OMAttribute getAttribute(QName qname)

Returns a named attribute if present.

Specified by:

getAttribute in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

Returns an OMAttribute with the given name if found, or null

getAttributeValue

public String getAttributeValue(QName qname)

Returns a named attribute's value, if present.

Specified by:

getAttributeValue in interface OMElement

Parameters:

qname - the qualified name to search for

Returns:

Returns a String containing the attribute value, or null.

addAttribute

public OMAttribute addAttribute(OMAttribute attr)

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

The owner of the attribute is set to be the particular OMElement. If the attribute already has an owner then the attribute is cloned (i.e. its name, value and namespace are copied to a new attribute) and the new attribute is added to the element. It's owner is then set to be the particular OMElement.

Specified by:

addAttribute in interface OMElement

Parameters:

attr - The attribute to add.

Returns:

The attribute that was added to the element. Note: The added attribute may not be the same instance that was given to add. This can happen if the given attribute already has an owner. In such case the returned attribute and the given attribute are equal but not the same instance.

See Also:

OMAttributeImpl.equals(Object)

removeAttribute

public void removeAttribute(OMAttribute attr)

Method removeAttribute.

Specified by:

removeAttribute in interface OMElement

addAttribute

public OMAttribute addAttribute(String attributeName,
                                String value,
                                OMNamespace ns)

Description copied from interface: OMElement

Adds an attribute to this element.

If the element already has an attribute with the same local name and namespace URI, then this existing attribute will be removed from the element, i.e. this method will always create a new OMAttribute instance and never update an existing one.

Specified by:

addAttribute in interface OMElement

Parameters:

attributeName - The local name for the attribute.

value - The string value of the attribute. This function does not check to make sure that the given attribute value can be serialized directly as an XML value. The caller may, for example, pass a string with the character 0x01.

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:

Returns the added attribute.

setBuilder

public void setBuilder(OMXMLParserWrapper wrapper)

Method setBuilder.

Specified by:

setBuilder in interface OMElement

getBuilder

public OMXMLParserWrapper getBuilder()

Method getBuilder.

Specified by:

getBuilder in interface OMContainer

Returns:

Returns OMXMLParserWrapper.

buildNext

public void buildNext()

Forces 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:

Returns child.

getFirstOMChildIfAvailable

public OMNode getFirstOMChildIfAvailable()

Description copied from interface: OMContainerEx

Get the first child if it is available. The child is available if it is complete or if the builder has started building the node. In the latter case, OMSerializable.isComplete() may return false when called on the child. In contrast to OMContainer.getFirstOMChild(), this method will never modify the state of the underlying parser.

Specified by:

getFirstOMChildIfAvailable in interface OMContainerEx

Returns:

the first child or null if the container has no children or the builder has not yet started to build the first child

setFirstChild

public void setFirstChild(OMNode firstChild)

Method setFirstChild.

Specified by:

setFirstChild in interface OMContainerEx

Specified by:

setFirstChild in interface OMElement

setLastChild

public void setLastChild(OMNode omNode)

Description copied from interface: OMContainerEx

forcefully set the last element in this parent element

Specified by:

setLastChild in interface OMContainerEx

detach

public OMNode detach()
              throws OMException

Removes this information item and its children, from the model completely.

Specified by:

detach in interface OMNode

Overrides:

detach in class OMNodeImpl

Returns:

The detached node. This is always the instance on which this method is invoked.

Throws:

OMException

getType

public int getType()

Gets 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)

build

public void build()
           throws OMException

Description copied from class: OMSerializableImpl

Parses this node and builds the object structure in memory. However a node, created programmatically, will have done set to true by default and this will cause populateyourself not to work properly!

Specified by:

build in interface OMSerializable

Overrides:

build in class OMSerializableImpl

Throws:

OMException

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

Description copied from interface: OMContainer

Get a pull parser representation of this element with caching enabled. This method has the same effect as OMContainer.getXMLStreamReader(boolean) with cache set to true.

Specified by:

getXMLStreamReader in interface OMContainer

Returns:

an XMLStreamReader representation of this element

getXMLStreamReaderWithoutCaching

public XMLStreamReader getXMLStreamReaderWithoutCaching()

Description copied from interface: OMContainer

Get a pull parser representation of this element with caching disabled. This method has the same effect as OMContainer.getXMLStreamReader(boolean) with cache set to false.

Specified by:

getXMLStreamReaderWithoutCaching in interface OMContainer

Returns:

an XMLStreamReader representation of this element

getXMLStreamReader

public XMLStreamReader getXMLStreamReader(boolean cache)

Description copied from interface: OMContainer

Get a pull parser representation of this element. This methods creates an XMLStreamReader instance that produces a sequence of StAX events for this element and its content. The sequence of events is independent of the state of this element and the value of the cache parameter, but the side effects of calling this method and consuming the reader are different:

State	cache	Side effects
The element is fully built (or was created programmatically).	true	No side effects. The reader will synthesize StAX events from the object model.
	false
The element is partially built, i.e. deferred parsing is taking place.	true	When a StAX event is requested from the reader, it will built the information item (if necessary) and synthesize the StAX event. If the caller completely consumes the reader, the element will be completely built. Otherwise it will be partially built.
	false	The reader will delegate to the underlying parser starting from the event corresponding to the last information item that has been built. In other words, after synthesizing a number of events, the reader will switch to delegation mode. An attempt to access the object model afterwards will result in an error.

To free any resources associated with the returned reader, the caller MUST invoke the XMLStreamReader.close() method.

The returned reader MAY implement the extension defined by DataHandlerReader and any binary content will be reported using this extension. More precisely, if the object model contains an OMText instance with OMText.isBinary() returning true (or would contain such an instance after it has been fully built), then its data will always be exposed through this extension.

The caller MUST NOT make any other assumption about the returned reader, in particular about its runtime type.

Note (non normative): For various reasons, existing code based on Axiom versions prior to 1.2.9 makes assumptions on the returned reader that should no longer be considered valid:

• Some code assumes that the returned reader is an instance of OMStAXWrapper. While it is true that Axiom internally uses this class to synthesize StAX events, it may wrap this instance in another reader implementation. E.g. depending on the log level, the reader will be wrapped using OMXMLStreamReaderValidator. This was already the case in Axiom versions prior to 1.2.9. It should also be noted that instances of OMSourcedElement (which extends the present interface) may return a reader that is not implemented using OMStAXWrapper.
• Some code uses the OMXMLStreamReader interface of the returned reader to switch off MTOM inlining using OMXMLStreamReader.setInlineMTOM(boolean). This has now been deprecated and it is recommended to use XOPEncodingStreamReader instead.
• Some existing code uses the OMAttachmentAccessor interface of the returned reader to fetch attachments using OMAttachmentAccessor.getDataHandler(String). There is no reason anymore to do so:
• When OMXMLStreamReader.setInlineMTOM(boolean) is used to disable MTOM inlining, OMAttachmentAccessor.getDataHandler(String) must be used to retrieve the binary content. The fact that this method is deprecated removes the need for this.
• In Axiom versions prior to 1.2.9, the sequence of events was inconsistent if the underlying stream is XOP encoded and caching is disabled (see WSCOMMONS-485). This made it necessary for the caller to (partially) handle the XOP processing and to use OMAttachmentAccessor.getDataHandler(String) to retrieve the binary content. Starting with 1.2.9 this is no longer be the case: as specified above, the sequence of events is independent of the state of the object model and the value of the cache parameter, and all binary content is reported through the DataHandlerReader extension.
• Finally, it should be noted that OMAttachmentAccessor.getDataHandler(String) doesn't give access to the attachments in the SwA case (neither in 1.2.9 nor in previous versions).

Code making any of these assumptions should be fixed, so that only XMLStreamReader and DataHandlerReader are used (and if necessary, XOPEncodingStreamReader).

Specified by:

getXMLStreamReader in interface OMContainer

Parameters:

cache - indicates if caching should be enabled

Returns:

an XMLStreamReader representation of this element

setText

public void setText(String text)

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

Specified by:

setText in interface OMElement

setText

public void setText(QName text)

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

Specified by:

setText in interface OMElement

Parameters:

text - the QName value

getText

public String getText()

Selects all the text children and concatenates them to a single string.

Specified by:

getText in interface OMElement

Returns:

Returns String.

getTextAsQName

public QName getTextAsQName()

Description copied from interface: OMElement

OMText can contain its information as a QName as well. This will return the text as a QName

Specified by:

getTextAsQName in interface OMElement

getTrimmedText

public String getTrimmedText()

Returns the concatination string of TRIMMED values of all OMText child nodes of this element. This is included purely to improve usability.

internalSerialize

public void internalSerialize(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class OMSerializableImpl

cache - indicates if caching should be enabled

Throws:

XMLStreamException

getFirstElement

public OMElement getFirstElement()

Gets first element.

Specified by:

getFirstElement in interface OMElement

Returns:

Returns element.

getLocalName

public String getLocalName()

Method getLocalName.

Specified by:

getLocalName in interface OMElement

Returns:

Returns local name.

setLocalName

public void setLocalName(String localName)

Method setLocalName.

Specified by:

setLocalName in interface OMElement

getNamespace

public OMNamespace getNamespace()

Description copied from interface: OMElement

Get the namespace this element is part of.

Specified by:

getNamespace in interface OMElement

Returns:

the namespace of this element, or null if the element has no namespace

getNamespaceURI

public String getNamespaceURI()

Description copied from interface: OMElement

Get the namespace URI of the element. Note that the contract of this method is identical to DOM's Node.getNamespaceURI() (when called on an Element).

Specified by:

getNamespaceURI in interface OMElement

Returns:

the namespace URI of the element or null if the element has no namespace

setNamespace

public void setNamespace(OMNamespace namespace)

Method setNamespace.

Specified by:

setNamespace in interface OMElement

setNamespaceWithNoFindInCurrentScope

public void setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)

Description copied from interface: OMElement

This will not search the namespace in the scope nor will declare in the current element, as in setNamespace(OMNamespace). This will just assign the given namespace to the element.

Specified by:

setNamespaceWithNoFindInCurrentScope in interface OMElement

getQName

public QName getQName()

Method getQName.

Specified by:

getQName in interface OMElement

Returns:

Returns QName.

toStringWithConsume

public String toStringWithConsume()
                           throws XMLStreamException

Description copied from interface: OMElement

This is a convenience method only. This basically serializes 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:

XMLStreamException

toString

public 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

Overrides:

toString in class Object

discard

public void discard()
             throws OMException

Method discard.

Specified by:

discard in interface OMNode

Throws:

OMException

resolveQName

public QName resolveQName(String qname)

Description copied from interface: OMElement

Resolves a QName literal in the namespace context defined by this element and produces a corresponding QName object. The implementation uses the algorithm defined by the XML Schema specification. In particular, the namespace for an unprefixed QName is the default namespace (not the null namespace), i.e. QNames are resolved in the same way as element names.

Specified by:

resolveQName in interface OMElement

Parameters:

qname - the QName literal to resolve

Returns:

the QName object, or null if the QName can't be resolved, i.e. if the prefix is not bound in the namespace context of this element

cloneOMElement

public OMElement cloneOMElement()

Description copied from interface: OMElement

Clones this element. Since both elements are build compleletely, you will lose the differed building capability.

Specified by:

cloneOMElement in interface OMElement

Returns:

Returns OMElement.

setLineNumber

public void setLineNumber(int lineNumber)

Specified by:

setLineNumber in interface OMElement

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface OMElement

buildWithAttachments

public void buildWithAttachments()

Description copied from class: OMNodeImpl

Parses this node and builds the object structure in memory. AXIOM supports two levels of deffered building. First is deffered building of AXIOM using StAX. Second level is the deffered building of attachments. AXIOM reads in the attachements from the stream only when user asks by calling getDataHandler(). build() method builds the OM without the attachments. buildAll() builds the OM together with attachement data. This becomes handy when user wants to free the input stream.

Specified by:

buildWithAttachments in interface OMNode

Overrides:

buildWithAttachments in class OMNodeImpl

notifyChildComplete

protected void notifyChildComplete()

This method will be called when one of the children becomes complete.