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, org.w3c.dom.Node, org.w3c.dom.NodeList

Direct Known Subclasses:

ElementImpl, RootNode

public abstract class ParentNode
extends NodeImpl
implements org.w3c.dom.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)
org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild)
(package private) NodeImpl	clone(OMCloneOptions options, ParentNode targetParent, boolean deep, boolean namespaceRepairing)
org.w3c.dom.NodeList	getChildNodes()
java.util.Iterator	getChildren()
java.util.Iterator	getChildrenWithLocalName(java.lang.String localName)
java.util.Iterator	getChildrenWithName(javax.xml.namespace.QName elementQName) Returns an iterator of child nodes having a given qname.
java.util.Iterator	getChildrenWithNamespaceURI(java.lang.String uri)
java.util.Iterator	getDescendants(boolean includeSelf)
org.w3c.dom.Node	getFirstChild() Gets the first child of this Node, or null if none.
OMElement	getFirstChildWithName(javax.xml.namespace.QName elementQName) Returns the first OMElement child node.
OMNode	getFirstOMChild()
OMNode	getFirstOMChildIfAvailable() Get the first child if it is available.
org.w3c.dom.Node	getLastChild() Gets the last child of this Node, or null if none.
OMNode	getLastKnownOMChild()
int	getLength()
javax.xml.transform.sax.SAXSource	getSAXSource(boolean cache)
java.lang.String	getTextContent()
(package private) void	getTextContent(java.lang.StringBuffer buf)
javax.xml.stream.XMLStreamReader	getXMLStreamReader()
javax.xml.stream.XMLStreamReader	getXMLStreamReader(boolean cache)
javax.xml.stream.XMLStreamReader	getXMLStreamReader(boolean cache, OMXMLStreamReaderConfiguration configuration)
javax.xml.stream.XMLStreamReader	getXMLStreamReaderWithoutCaching()
boolean	hasChildNodes()
private static boolean	hasTextContent(org.w3c.dom.Node child)
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts newChild before the refChild.
private org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild, boolean useDomSemantics)
(package private) void	internalAppendChild(NodeImpl node)
private boolean	isAncestorOrSelf(org.w3c.dom.Node node) Checks if the given node is an ancestor (or identical) to this node.
org.w3c.dom.Node	item(int index)
(package private) void	normalize(DOMConfigurationImpl config)
(package private) void	notifyChildComplete()
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild) Removes the given child from the DOM Tree.
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) Replaces the oldChild with the newChild.
void	setFirstChild(OMNode firstChild)
void	setLastChild(OMNode omNode) Forcefully set the last child
void	setTextContent(java.lang.String textContent)
(package private) abstract ParentNode	shallowClone(OMCloneOptions options, ParentNode targetParent, boolean namespaceRepairing)

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

build, buildWithAttachments, checkSameOwnerDocument, clone, cloneNode, close, compareDocumentPosition, detach, detach, getAttributes, getBaseURI, getBuilder, getFeature, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getUserData, hasAttributes, hasParent, hasParent, insertSiblingAfter, insertSiblingBefore, internalGetNextSibling, internalGetOwnerNode, internalGetPreviousSibling, internalSerialize, internalSerialize, internalSerializeAndConsume, internalSetNextSibling, internalSetOwnerNode, internalSetPreviousSibling, isComplete, isDefaultNamespace, isEqualNode, isFirstChild, isFirstChild, isSameNode, isSpecified, isSpecified, isSupported, lookupPrefix, normalize, ownerDocument, parentNode, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, 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

internalAppendChild

void internalAppendChild(NodeImpl node)

addChild

public void addChild(OMNode omNode)

addChild

public void addChild(OMNode omNode,
                     boolean fromBuilder)

getChildren

public java.util.Iterator getChildren()

getDescendants

public java.util.Iterator getDescendants(boolean includeSelf)

getChildrenWithName

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

Returns an iterator of child nodes having a given qname.

Throws:

OMException

See Also:

(javax.xml.namespace.QName)

getChildrenWithLocalName

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

getChildrenWithNamespaceURI

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

getFirstChildWithName

public OMElement getFirstChildWithName(javax.xml.namespace.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 org.w3c.dom.NodeList getChildNodes()

Specified by:

getChildNodes in interface org.w3c.dom.Node

getLength

public final int getLength()

Specified by:

getLength in interface org.w3c.dom.NodeList

item

public final org.w3c.dom.Node item(int index)

Specified by:

item in interface org.w3c.dom.NodeList

getFirstChild

public org.w3c.dom.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 org.w3c.dom.Node

Overrides:

getFirstChild in class NodeImpl

See Also:

ParentNode

getLastChild

public org.w3c.dom.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 org.w3c.dom.Node

Overrides:

getLastChild in class NodeImpl

See Also:

ParentNode

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface org.w3c.dom.Node

Overrides:

hasChildNodes in class NodeImpl

appendChild

public final org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                                   throws org.w3c.dom.DOMException

Specified by:

appendChild in interface org.w3c.dom.Node

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

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

Specified by:

insertBefore in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

insertBefore

private org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                      org.w3c.dom.Node refChild,
                                      boolean useDomSemantics)

replaceChild

public final org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                           org.w3c.dom.Node oldChild)
                                    throws org.w3c.dom.DOMException

Replaces the oldChild with the newChild.

Specified by:

replaceChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

removeChild

public final org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                                   throws org.w3c.dom.DOMException

Removes the given child from the DOM Tree.

Specified by:

removeChild in interface org.w3c.dom.Node

Throws:

org.w3c.dom.DOMException

isAncestorOrSelf

private boolean isAncestorOrSelf(org.w3c.dom.Node node)

Checks if the given node is an ancestor (or identical) to this node.

Parameters:

node - the node to check

Returns:

true if the node is an ancestor or indentical to this node

clone

final NodeImpl clone(OMCloneOptions options,
                     ParentNode targetParent,
                     boolean deep,
                     boolean namespaceRepairing)

Specified by:

clone in class NodeImpl

shallowClone

abstract ParentNode shallowClone(OMCloneOptions options,
                                 ParentNode targetParent,
                                 boolean namespaceRepairing)

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Specified by:

getTextContent in interface org.w3c.dom.Node

Overrides:

getTextContent in class NodeImpl

Throws:

org.w3c.dom.DOMException

getTextContent

void getTextContent(java.lang.StringBuffer buf)
             throws org.w3c.dom.DOMException

Overrides:

getTextContent in class NodeImpl

Throws:

org.w3c.dom.DOMException

hasTextContent

private static boolean hasTextContent(org.w3c.dom.Node child)

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Specified by:

setTextContent in interface org.w3c.dom.Node

Overrides:

setTextContent in class NodeImpl

Throws:

org.w3c.dom.DOMException

getXMLStreamReaderWithoutCaching

public javax.xml.stream.XMLStreamReader getXMLStreamReaderWithoutCaching()

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader()

getXMLStreamReader

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

getXMLStreamReader

public javax.xml.stream.XMLStreamReader getXMLStreamReader(boolean cache,
                                                           OMXMLStreamReaderConfiguration configuration)

getSAXSource

public javax.xml.transform.sax.SAXSource getSAXSource(boolean cache)

notifyChildComplete

void notifyChildComplete()

normalize

void normalize(DOMConfigurationImpl config)

Overrides:

normalize in class NodeImpl