/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.axiom.om.impl.dom;
import org.apache.axiom.om.OMCloneOptions;
import org.apache.axiom.om.OMContainer;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNode;
import org.apache.axiom.om.OMSourcedElement;
import org.apache.axiom.om.OMXMLStreamReaderConfiguration;
import org.apache.axiom.om.impl.OMNodeEx;
import org.apache.axiom.om.impl.common.IContainer;
import org.apache.axiom.om.impl.common.IParentNode;
import org.apache.axiom.om.impl.common.OMChildrenLocalNameIterator;
import org.apache.axiom.om.impl.common.OMChildrenNamespaceIterator;
import org.apache.axiom.om.impl.common.OMChildrenQNameIterator;
import org.apache.axiom.om.impl.common.OMContainerHelper;
import org.apache.axiom.om.impl.common.OMDescendantsIterator;
import org.apache.axiom.om.impl.jaxp.OMSource;
import org.apache.axiom.om.impl.traverse.OMChildrenIterator;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.sax.SAXSource;
import java.util.Iterator;
public abstract class ParentNode extends NodeImpl implements NodeList, IParentNode {
protected NodeImpl firstChild;
protected NodeImpl lastChild;
protected ParentNode(OMFactory factory) {
super(factory);
}
// /
// /OMContainer methods
// /
void internalAppendChild(NodeImpl node) {
insertBefore(node, null, false);
}
public void addChild(OMNode omNode) {
addChild(omNode, false);
}
public void addChild(OMNode omNode, boolean fromBuilder) {
OMContainerHelper.addChild((IContainer)this, omNode, fromBuilder);
}
public Iterator getChildren() {
return new OMChildrenIterator(getFirstOMChild());
}
public Iterator getDescendants(boolean includeSelf) {
return new OMDescendantsIterator((OMContainer)this, includeSelf);
}
/**
* Returns an iterator of child nodes having a given qname.
*
* @see org.apache.axiom.om.OMContainer#getChildrenWithName (javax.xml.namespace.QName)
*/
public Iterator getChildrenWithName(QName elementQName) throws OMException {
return new OMChildrenQNameIterator(getFirstOMChild(), elementQName);
}
public Iterator getChildrenWithLocalName(String localName) {
return new OMChildrenLocalNameIterator(getFirstOMChild(),
localName);
}
public Iterator getChildrenWithNamespaceURI(String uri) {
return new OMChildrenNamespaceIterator(getFirstOMChild(),
uri);
}
/**
* Returns the first OMElement child node.
*
* @see org.apache.axiom.om.OMContainer#getFirstChildWithName (javax.xml.namespace.QName)
*/
public OMElement getFirstChildWithName(QName elementQName)
throws OMException {
Iterator children = new OMChildrenQNameIterator(getFirstOMChild(),
elementQName);
while (children.hasNext()) {
OMNode node = (OMNode) children.next();
// Return the first OMElement node that is found
if (node instanceof OMElement) {
return (OMElement) node;
}
}
return null;
}
public OMNode getFirstOMChild() {
return OMContainerHelper.getFirstOMChild(this);
}
public OMNode getFirstOMChildIfAvailable() {
return (OMNode)firstChild;
}
public OMNode getLastKnownOMChild() {
return (OMNode)lastChild;
}
public void setFirstChild(OMNode firstChild) {
if (firstChild != null) {
((OMNodeEx) firstChild).setParent((OMContainer)this);
}
this.firstChild = (NodeImpl) firstChild;
}
/**
* Forcefully set the last child
* @param omNode
*/
public void setLastChild(OMNode omNode) {
this.lastChild = (NodeImpl) omNode;
}
// /
// /DOM Node methods
// /
public final NodeList getChildNodes() {
return this;
}
public final int getLength() {
int count = 0;
Node child = getFirstChild();
while (child != null) {
count++;
child = child.getNextSibling();
}
return count;
}
public final Node item(int index) {
int count = 0;
Node child = getFirstChild();
while (child != null) {
if (count == index) {
return child;
} else {
child = child.getNextSibling();
}
count++;
}
return null;
}
public Node getFirstChild() {
return (Node) this.getFirstOMChild();
}
public Node getLastChild() {
if (!this.isComplete()) {
this.build();
}
return this.lastChild;
}
public boolean hasChildNodes() {
return getFirstChild() != null;
}
public final Node appendChild(Node newChild) throws DOMException {
return insertBefore(newChild, null);
}
/**
* Inserts newChild before the refChild. If the refChild is null then the newChild is made the
* last child.
*/
public Node insertBefore(Node newChild, Node refChild) throws DOMException {
return insertBefore(newChild, refChild, true);
}
private Node insertBefore(Node newChild, Node refChild, boolean useDomSemantics) {
NodeImpl newDomChild = (NodeImpl) newChild;
NodeImpl refDomChild = (NodeImpl) refChild;
if (useDomSemantics) {
checkSameOwnerDocument(newDomChild);
}
if (isAncestorOrSelf(newChild)) {
throw DOMUtil.newDOMException(DOMException.HIERARCHY_REQUEST_ERR);
}
if (newDomChild.parentNode() != null) {
//If the newChild is already in the tree remove it
newDomChild.parentNode().removeChild(newDomChild);
}
if (this instanceof Document) {
if (newDomChild instanceof ElementImpl) {
if (((DocumentImpl) this).getOMDocumentElement(false) != null) {
// Throw exception since there cannot be two document elements
throw DOMUtil.newDOMException(DOMException.HIERARCHY_REQUEST_ERR);
}
if (newDomChild.parentNode() == null) {
newDomChild.setParent(this, useDomSemantics);
}
} else if (!(newDomChild instanceof CommentImpl
|| newDomChild instanceof ProcessingInstructionImpl
|| newDomChild instanceof DocumentFragmentImpl
|| newDomChild instanceof DocumentTypeImpl)) {
throw DOMUtil.newDOMException(DOMException.HIERARCHY_REQUEST_ERR);
}
}
if (refChild == null) { // Append the child to the end of the list
if (!isComplete()) {
build();
}
// if there are no children
if (this.lastChild == null && firstChild == null) {
this.lastChild = newDomChild;
this.firstChild = newDomChild;
this.firstChild.isFirstChild(true);
newDomChild.setParent(this, useDomSemantics);
} else {
this.lastChild.internalSetNextSibling(newDomChild);
newDomChild.internalSetPreviousSibling(this.lastChild);
this.lastChild = newDomChild;
this.lastChild.internalSetNextSibling(null);
}
if (newDomChild.parentNode() == null) {
newDomChild.setParent(this, useDomSemantics);
}
} else {
Iterator children = this.getChildren();
boolean found = false;
while (children.hasNext()) {
NodeImpl tempNode = (NodeImpl) children.next();
if (tempNode.equals(refChild)) {
// RefChild found
if (this.firstChild == tempNode) { // If the refChild is the
// first child
if (newChild instanceof DocumentFragmentImpl) {
// The new child is a DocumentFragment
DocumentFragmentImpl docFrag =
(DocumentFragmentImpl) newChild;
NodeImpl child = docFrag.firstChild;
while (child != null) {
child.setParent(this, useDomSemantics);
child = child.internalGetNextSibling();
}
this.firstChild = docFrag.firstChild;
docFrag.lastChild.internalSetNextSibling(refDomChild);
refDomChild.internalSetPreviousSibling(docFrag.lastChild.internalGetNextSibling());
docFrag.firstChild = null;
docFrag.lastChild = null;
} else {
// Make the newNode the first Child
this.firstChild = newDomChild;
newDomChild.internalSetNextSibling(refDomChild);
refDomChild.internalSetPreviousSibling(newDomChild);
this.firstChild.isFirstChild(true);
refDomChild.isFirstChild(false);
newDomChild.internalSetPreviousSibling(null); // Just to be
// sure :-)
}
} else { // If the refChild is not the fist child
NodeImpl previousNode = refDomChild.internalGetPreviousSibling();
if (newChild instanceof DocumentFragmentImpl) {
// the newChild is a document fragment
DocumentFragmentImpl docFrag =
(DocumentFragmentImpl) newChild;
NodeImpl child = docFrag.firstChild;
while (child != null) {
child.setParent(this, useDomSemantics);
child = child.internalGetNextSibling();
}
previousNode.internalSetNextSibling(docFrag.firstChild);
docFrag.firstChild.internalSetPreviousSibling(previousNode);
docFrag.lastChild.internalSetNextSibling(refDomChild);
refDomChild.internalSetPreviousSibling(docFrag.lastChild);
docFrag.firstChild = null;
docFrag.lastChild = null;
} else {
previousNode.internalSetNextSibling(newDomChild);
newDomChild.internalSetPreviousSibling(previousNode);
newDomChild.internalSetNextSibling(refDomChild);
refDomChild.internalSetPreviousSibling(newDomChild);
}
}
found = true;
break;
}
}
if (!found) {
throw DOMUtil.newDOMException(DOMException.NOT_FOUND_ERR);
}
if (newDomChild.parentNode() == null) {
newDomChild.setParent(this, useDomSemantics);
}
}
if (!newDomChild.isComplete() && !(newDomChild instanceof OMSourcedElement)) {
setComplete(false);
}
return newChild;
}
/** Replaces the oldChild with the newChild. */
public final Node replaceChild(Node newChild, Node oldChild) throws DOMException {
NodeImpl newDomChild = (NodeImpl) newChild;
NodeImpl oldDomChild = (NodeImpl) oldChild;
if (newChild == null) {
throw new IllegalArgumentException("newChild can't be null");
}
if (isAncestorOrSelf(newChild)) {
throw DOMUtil.newDOMException(DOMException.HIERARCHY_REQUEST_ERR);
}
checkSameOwnerDocument(newDomChild);
Iterator children = this.getChildren();
boolean found = false;
while (!found && children.hasNext()) {
NodeImpl tempNode = (NodeImpl) children.next();
if (tempNode == oldChild) {
NodeImpl head; // The first child to insert
NodeImpl tail; // The last child to insert
if (newChild instanceof DocumentFragmentImpl) {
DocumentFragmentImpl docFrag =
(DocumentFragmentImpl) newDomChild;
head = (NodeImpl)docFrag.getFirstChild();
tail = (NodeImpl)docFrag.getLastChild();
NodeImpl child = (NodeImpl) docFrag.getFirstChild();
//set the parent of all kids to me
while(child != null) {
child.setParent(this, true);
child = child.internalGetNextSibling();
}
docFrag.setFirstChild(null);
docFrag.setLastChild(null);
} else {
head = newDomChild;
tail = newDomChild;
newDomChild.setParent(this, true);
}
// We use getNextSibling here to force bulding the node if necessary
NodeImpl nextSibling = (NodeImpl)oldDomChild.getNextSibling();
NodeImpl previousSibling = oldDomChild.internalGetPreviousSibling();
tail.internalSetNextSibling(nextSibling);
head.internalSetPreviousSibling(previousSibling);
if (previousSibling != null) {
previousSibling.internalSetNextSibling(head);
} else {
this.firstChild = head;
}
if (nextSibling != null) {
nextSibling.internalSetPreviousSibling(tail);
} else {
this.lastChild = tail;
}
found = true;
// remove the old child's references to this tree
oldDomChild.internalSetNextSibling(null);
oldDomChild.internalSetPreviousSibling(null);
oldDomChild.setParent(null, true);
}
}
if (!found)
throw DOMUtil.newDOMException(DOMException.NOT_FOUND_ERR);
return oldChild;
}
/** Removes the given child from the DOM Tree. */
public final Node removeChild(Node oldChild) throws DOMException {
if (oldChild.getParentNode() == this) {
((NodeImpl)oldChild).detach(true);
return oldChild;
} else {
throw DOMUtil.newDOMException(DOMException.NOT_FOUND_ERR);
}
}
/**
* Checks if the given node is an ancestor (or identical) to this node.
*
* @param node
* the node to check
* @return <code>true</code> if the node is an ancestor or indentical to this node
*/
private boolean isAncestorOrSelf(Node node) {
Node currentNode = this;
do {
if (currentNode == node) {
return true;
}
currentNode = currentNode.getParentNode();
} while (currentNode != null);
return false;
}
final NodeImpl clone(OMCloneOptions options, ParentNode targetParent, boolean deep, boolean namespaceRepairing) {
ParentNode clone = shallowClone(options, targetParent, namespaceRepairing);
if (deep) {
for (Node child = getFirstChild(); child != null; child = child.getNextSibling()) {
((NodeImpl)child).clone(options, clone, true, namespaceRepairing);
}
}
return clone;
}
abstract ParentNode shallowClone(OMCloneOptions options, ParentNode targetParent, boolean namespaceRepairing);
public String getTextContent() throws DOMException {
Node child = getFirstChild();
if (child != null) {
Node next = child.getNextSibling();
if (next == null) {
return hasTextContent(child) ? ((NodeImpl)child).getTextContent() : "";
}
StringBuffer buf = new StringBuffer();
getTextContent(buf);
return buf.toString();
} else {
return "";
}
}
void getTextContent(StringBuffer buf) throws DOMException {
Node child = getFirstChild();
while (child != null) {
if (hasTextContent(child)) {
((NodeImpl)child).getTextContent(buf);
}
child = child.getNextSibling();
}
}
// internal method returning whether to take the given node's text content
private static boolean hasTextContent(Node child) {
return child.getNodeType() != Node.COMMENT_NODE &&
child.getNodeType() != Node.PROCESSING_INSTRUCTION_NODE /* &&
(child.getNodeType() != Node.TEXT_NODE ||
((TextImpl) child).isIgnorableWhitespace() == false)*/;
}
public void setTextContent(String textContent) throws DOMException {
// get rid of any existing children
// TODO: there is probably a better way to remove all children
Node child;
while ((child = getFirstChild()) != null) {
removeChild(child);
}
// create a Text node to hold the given content
if (textContent != null && textContent.length() != 0) {
addChild(factory.createOMText(textContent));
}
}
public XMLStreamReader getXMLStreamReaderWithoutCaching() {
return getXMLStreamReader(false);
}
public XMLStreamReader getXMLStreamReader() {
return getXMLStreamReader(true);
}
public XMLStreamReader getXMLStreamReader(boolean cache) {
return OMContainerHelper.getXMLStreamReader((IContainer)this, cache);
}
public XMLStreamReader getXMLStreamReader(boolean cache, OMXMLStreamReaderConfiguration configuration) {
return OMContainerHelper.getXMLStreamReader((IContainer)this, cache, configuration);
}
public SAXSource getSAXSource(boolean cache) {
return new OMSource((OMContainer)this);
}
void notifyChildComplete() {
if (!this.isComplete() && getBuilder() == null) {
Iterator iterator = getChildren();
while (iterator.hasNext()) {
OMNode node = (OMNode) iterator.next();
if (!node.isComplete()) {
return;
}
}
this.setComplete(true);
}
}
void normalize(DOMConfigurationImpl config) {
OMNode child = getFirstOMChild();
while (child != null) {
((NodeImpl)child).normalize(config);
child = child.getNextOMSibling();
}
}
}