org.apache.axiom.om.impl.dom

Class ParentNode

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

All Implemented Interfaces:

IParentNode, Node, NodeList

Direct Known Subclasses:

ElementImpl, RootNode

public abstract class ParentNode
extends NodeImpl
implements NodeList, IParentNode

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeImpl	firstChild
protected NodeImpl	lastChild

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParentNode(OMFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addChild(OMNode omNode)
void	addChild(OMNode omNode, boolean fromBuilder)
Node	appendChild(Node newChild)
NodeList	getChildNodes()
Iterator	getChildren()
Iterator	getChildrenWithLocalName(String localName)
Iterator	getChildrenWithName(QName elementQName) Returns an iterator of child nodes having a given qname.
Iterator	getChildrenWithNamespaceURI(String uri)
Iterator	getDescendants(boolean includeSelf)
Node	getFirstChild() Gets the first child of this Node, or null if none.
OMElement	getFirstChildWithName(QName elementQName) Returns the first OMElement child node.
OMNode	getFirstOMChild()
OMNode	getFirstOMChildIfAvailable() Get the first child if it is available.
Node	getLastChild() Gets the last child of this Node, or null if none.
OMNode	getLastKnownOMChild()
int	getLength()
SAXSource	getSAXSource(boolean cache)
String	getTextContent()
XMLStreamReader	getXMLStreamReader()
XMLStreamReader	getXMLStreamReader(boolean cache)
XMLStreamReader	getXMLStreamReader(boolean cache, OMXMLStreamReaderConfiguration configuration)
XMLStreamReader	getXMLStreamReaderWithoutCaching()
boolean	hasChildNodes()
Node	insertBefore(Node newChild, Node refChild) Inserts newChild before the refChild.
Node	item(int index)
Node	removeChild(Node oldChild) Removes the given child from the DOM Tree.
Node	replaceChild(Node newChild, Node oldChild) Replaces the oldChild with the newChild.
void	setFirstChild(OMNode firstChild)
void	setLastChild(OMNode omNode) Forcefully set the last child
void	setTextContent(String textContent)

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

buildWithAttachments, clone, cloneNode, close, compareDocumentPosition, detach, getAttributes, getBaseURI, getBuilder, getFeature, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getUserData, hasAttributes, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setParent, setParent, setPrefix, setPreviousOMSibling, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axiom.om.impl.common.IParentNode

getBuilder, getState, isComplete

Methods inherited from interface org.w3c.dom.Node

getNextSibling, getNodeName, getNodeType, lookupNamespaceURI

Field Detail

firstChild

protected NodeImpl firstChild

lastChild

protected NodeImpl lastChild

Constructor Detail

ParentNode

protected ParentNode(OMFactory factory)

Method Detail

addChild

public void addChild(OMNode omNode)

addChild

public void addChild(OMNode omNode,
                     boolean fromBuilder)

getChildren

public Iterator getChildren()

getDescendants

public Iterator getDescendants(boolean includeSelf)

getChildrenWithName

public Iterator getChildrenWithName(QName elementQName)
                             throws OMException

Returns an iterator of child nodes having a given qname.

Throws:

OMException

See Also:

(javax.xml.namespace.QName)

getChildrenWithLocalName

public Iterator getChildrenWithLocalName(String localName)

getChildrenWithNamespaceURI

public Iterator getChildrenWithNamespaceURI(String uri)

getFirstChildWithName

public OMElement getFirstChildWithName(QName elementQName)
                                throws OMException

Returns the first OMElement child node.

Throws:

OMException

See Also:

(javax.xml.namespace.QName)

getFirstOMChild

public OMNode getFirstOMChild()

getFirstOMChildIfAvailable

public OMNode getFirstOMChildIfAvailable()

Description copied from interface: IParentNode

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 IParentNode

Returns:

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

getLastKnownOMChild

public OMNode getLastKnownOMChild()

setFirstChild

public void setFirstChild(OMNode firstChild)

setLastChild

public void setLastChild(OMNode omNode)

Forcefully set the last child

Parameters:

omNode -

getChildNodes

public final NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getLength

public final int getLength()

Specified by:

getLength in interface NodeList

item

public final Node item(int index)

Specified by:

item in interface NodeList

getFirstChild

public Node getFirstChild()

Description copied from class: NodeImpl

Gets the first child of this Node, or null if none.

By default we do not have any children, ParentNode overrides this.

Specified by:

getFirstChild in interface Node

Overrides:

getFirstChild in class NodeImpl

See Also:

ParentNode

getLastChild

public Node getLastChild()

Description copied from class: NodeImpl

Gets the last child of this Node, or null if none.

By default we do not have any children, ParentNode overrides this.

Specified by:

getLastChild in interface Node

Overrides:

getLastChild in class NodeImpl

See Also:

ParentNode

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

Overrides:

hasChildNodes in class NodeImpl

appendChild

public final Node appendChild(Node newChild)
                       throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Inserts newChild before the refChild. If the refChild is null then the newChild is made the last child.

Specified by:

insertBefore in interface Node

Throws:

DOMException

replaceChild

public final Node replaceChild(Node newChild,
                               Node oldChild)
                        throws DOMException

Replaces the oldChild with the newChild.

Specified by:

replaceChild in interface Node

Throws:

DOMException

removeChild

public final Node removeChild(Node oldChild)
                       throws DOMException

Removes the given child from the DOM Tree.

Specified by:

removeChild in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Overrides:

getTextContent in class NodeImpl

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Overrides:

setTextContent in class NodeImpl

Throws:

DOMException

getXMLStreamReaderWithoutCaching

public XMLStreamReader getXMLStreamReaderWithoutCaching()

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

getXMLStreamReader

public XMLStreamReader getXMLStreamReader(boolean cache)

getXMLStreamReader

public XMLStreamReader getXMLStreamReader(boolean cache,
                                          OMXMLStreamReaderConfiguration configuration)

getSAXSource

public SAXSource getSAXSource(boolean cache)