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

protected java.util.HashMap	attributes Field attributes
static OMNamespace	DEFAULT_DEFAULT_NS_OBJECT
protected OMNode	firstChild Field firstChild
protected OMNode	lastChild
protected java.lang.String	localName Field localName
protected java.util.HashMap	namespaces Field namespaces
protected int	noPrefixNamespaceCounter Field noPrefixNamespaceCounter
protected OMNamespace	ns Field ns
protected javax.xml.namespace.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

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

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

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

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

Method Summary

OMAttribute	addAttribute(OMAttribute attr) Inserts an attribute to this element.
OMAttribute	addAttribute(java.lang.String attributeName, java.lang.String value, OMNamespace ns) Creates an OMAttributeImpl instance out of the given arguments and inserts that 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()
OMNamespace	declareDefaultNamespace(java.lang.String uri) We use "" to store the default namespace of this element.
OMNamespace	declareNamespace(OMNamespace namespace)
OMNamespace	declareNamespace(java.lang.String uri, java.lang.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(java.lang.String uri, java.lang.String prefix) Finds a namespace with the given uri and prefix, in the scope of the document.
OMNamespace	findNamespaceURI(java.lang.String prefix)
java.util.Iterator	getAllAttributes() Returns a List of OMAttributes.
java.util.Iterator	getAllDeclaredNamespaces() Method getAllDeclaredNamespaces.
OMAttribute	getAttribute(javax.xml.namespace.QName qname) Returns a named attribute if present.
java.lang.String	getAttributeValue(javax.xml.namespace.QName qname) Returns 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() Returns a collection of this element.
java.util.Iterator	getChildrenWithLocalName(java.lang.String localName)
java.util.Iterator	getChildrenWithName(javax.xml.namespace.QName elementQName) Searches for children with a given QName and returns an iterator to traverse through the OMNodes.
java.util.Iterator	getChildrenWithNamespaceURI(java.lang.String uri)
OMNamespace	getDefaultNamespace()
OMElement	getFirstChildWithName(javax.xml.namespace.QName elementQName) Method getFirstChildWithName.
OMElement	getFirstElement() Gets first element.
OMNode	getFirstOMChild() Method getFirstOMChild.
OMNode	getFirstOMChildIfAvailable()
int	getLineNumber()
java.lang.String	getLocalName() Method getLocalName.
OMNamespace	getNamespace()
OMNode	getNextOMSibling() Gets the next sibling.
javax.xml.namespace.QName	getQName() Method getQName.
java.lang.String	getText() Selects all the text children and concatenates them to a single string.
javax.xml.namespace.QName	getTextAsQName()
java.lang.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.
javax.xml.stream.XMLStreamReader	getXMLStreamReader() Method getXMLStreamReader.
javax.xml.stream.XMLStreamReader	getXMLStreamReader(boolean cache) Method getXMLStreamReader.
javax.xml.stream.XMLStreamReader	getXMLStreamReaderWithoutCaching() Method getXMLStreamReaderWithoutCaching.
void	internalSerialize(javax.xml.stream.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.
javax.xml.namespace.QName	resolveQName(java.lang.String qname) Converts a prefix:local qname string into a proper QName, evaluating it in the OMElement context.
void	setBuilder(OMXMLParserWrapper wrapper) Method setBuilder.
void	setFirstChild(OMNode firstChild) Method setFirstChild.
void	setLastChild(OMNode omNode)
void	setLineNumber(int lineNumber)
void	setLocalName(java.lang.String localName) Method setLocalName.
void	setNamespace(OMNamespace namespace) Method setNamespace.
void	setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)
void	setText(javax.xml.namespace.QName text) Sets the text, as a QName, of the given element.
void	setText(java.lang.String text) Sets the text of the given element.
java.lang.String	toString()
java.lang.String	toStringWithConsume()

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.OMSerializable

close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

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

close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

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 java.lang.String localName

Field localName

qName

protected javax.xml.namespace.QName qName

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

lastChild

protected OMNode lastChild

Constructor Detail

OMElementImpl

public OMElementImpl(java.lang.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(java.lang.String localName,
                     OMNamespace ns,
                     OMFactory factory)

Constructor OMElementImpl.

OMElementImpl

public OMElementImpl(java.lang.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(javax.xml.namespace.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 java.util.Iterator getChildrenWithName(javax.xml.namespace.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

Throws:

OMException

getChildrenWithLocalName

public java.util.Iterator getChildrenWithLocalName(java.lang.String localName)

Specified by:

getChildrenWithLocalName in interface OMContainer

getChildrenWithNamespaceURI

public java.util.Iterator getChildrenWithNamespaceURI(java.lang.String uri)

Specified by:

getChildrenWithNamespaceURI in interface OMContainer

getFirstChildWithName

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

Method getFirstChildWithName.

Specified by:

getFirstChildWithName in interface OMContainer

Throws:

OMException

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

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

Specified by:

getChildren in interface OMContainer

Returns:

Returns children.

getChildElements

public java.util.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.

declareNamespace

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

Creates a namespace in the current element scope.

Specified by:

declareNamespace in interface OMElement

Returns:

Returns namespace.

declareDefaultNamespace

public OMNamespace declareDefaultNamespace(java.lang.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()

Specified by:

getDefaultNamespace in interface OMElement

declareNamespace

public OMNamespace declareNamespace(OMNamespace namespace)

Specified by:

declareNamespace in interface OMElement

Returns:

Returns namespace.

findNamespace

public OMNamespace findNamespace(java.lang.String uri,
                                 java.lang.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

findNamespaceURI

public OMNamespace findNamespaceURI(java.lang.String prefix)

Specified by:

findNamespaceURI in interface OMElement

getAllDeclaredNamespaces

public java.util.Iterator getAllDeclaredNamespaces()

Method getAllDeclaredNamespaces.

Specified by:

getAllDeclaredNamespaces in interface OMElement

Returns:

Returns Iterator.

getAllAttributes

public java.util.Iterator getAllAttributes()

Returns a List of OMAttributes.

Specified by:

getAllAttributes in interface OMElement

Returns:

Returns iterator.

getAttribute

public OMAttribute getAttribute(javax.xml.namespace.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 java.lang.String getAttributeValue(javax.xml.namespace.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

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(java.lang.String attributeName,
                                java.lang.String value,
                                OMNamespace ns)

Creates an OMAttributeImpl instance out of the given arguments and inserts that 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:

attributeName - The name of the attribute

value - The value of the attribute

ns - The namespace of the attribute

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)

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 OMElement

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

Specified by:

getFirstOMChildIfAvailable in interface OMContainerEx

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)

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

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 javax.xml.stream.XMLStreamReader getXMLStreamReader()

Method getXMLStreamReader.

Specified by:

getXMLStreamReader in interface OMElement

See Also:

OMElement.getXMLStreamReader()

getXMLStreamReaderWithoutCaching

public javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()

Method getXMLStreamReaderWithoutCaching.

Specified by:

getXMLStreamReaderWithoutCaching in interface OMElement

See Also:

OMElement.getXMLStreamReaderWithoutCaching()

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache)

Method getXMLStreamReader.

Specified by:

getXMLStreamReader in interface OMElement

Returns:

Returns reader.

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 mixed content) before setting the text.

Specified by:

setText in interface OMElement

setText

public void setText(javax.xml.namespace.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

getText

public java.lang.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 javax.xml.namespace.QName getTextAsQName()

Specified by:

getTextAsQName in interface OMElement

getTrimmedText

public java.lang.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(javax.xml.stream.XMLStreamWriter writer,
                              boolean cache)
                       throws javax.xml.stream.XMLStreamException

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in interface OMNodeEx

Specified by:

internalSerialize in class OMSerializableImpl

Throws:

javax.xml.stream.XMLStreamException

getFirstElement

public OMElement getFirstElement()

Gets first element.

Specified by:

getFirstElement in interface OMElement

Returns:

Returns element.

getLocalName

public java.lang.String getLocalName()

Method getLocalName.

Specified by:

getLocalName in interface OMElement

Returns:

Returns local name.

setLocalName

public void setLocalName(java.lang.String localName)

Method setLocalName.

Specified by:

setLocalName in interface OMElement

getNamespace

public OMNamespace getNamespace()

Specified by:

getNamespace in interface OMElement

setNamespace

public void setNamespace(OMNamespace namespace)

Method setNamespace.

Specified by:

setNamespace in interface OMElement

setNamespaceWithNoFindInCurrentScope

public void setNamespaceWithNoFindInCurrentScope(OMNamespace namespace)

Specified by:

setNamespaceWithNoFindInCurrentScope in interface OMElement

getQName

public javax.xml.namespace.QName getQName()

Method getQName.

Specified by:

getQName in interface OMElement

Returns:

Returns QName.

toStringWithConsume

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

Specified by:

toStringWithConsume in interface OMElement

Throws:

javax.xml.stream.XMLStreamException

toString

public java.lang.String toString()

Specified by:

toString in interface OMElement

Overrides:

toString in class java.lang.Object

discard

public void discard()
             throws OMException

Method discard.

Specified by:

discard in interface OMNode

Throws:

OMException

resolveQName

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

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

Returns null for any failure to extract a qname.

cloneOMElement

public OMElement cloneOMElement()

Specified by:

cloneOMElement in interface 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.