/*
* 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.factory;
import org.apache.axiom.ext.stax.datahandler.DataHandlerProvider;
import org.apache.axiom.om.OMAttribute;
import org.apache.axiom.om.OMComment;
import org.apache.axiom.om.OMContainer;
import org.apache.axiom.om.OMDataSource;
import org.apache.axiom.om.OMDocType;
import org.apache.axiom.om.OMDocument;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMEntityReference;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMHierarchyException;
import org.apache.axiom.om.OMMetaFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.axiom.om.OMNode;
import org.apache.axiom.om.OMProcessingInstruction;
import org.apache.axiom.om.OMSourcedElement;
import org.apache.axiom.om.OMText;
import org.apache.axiom.om.OMXMLParserWrapper;
import org.apache.axiom.om.impl.OMContainerEx;
import org.apache.axiom.om.impl.builder.OMFactoryEx;
import org.apache.axiom.om.impl.builder.StAXOMBuilder;
import org.apache.axiom.om.impl.common.OMNamespaceImpl;
import org.apache.axiom.om.impl.dom.AttrImpl;
import org.apache.axiom.om.impl.dom.CDATASectionImpl;
import org.apache.axiom.om.impl.dom.CommentImpl;
import org.apache.axiom.om.impl.dom.DocumentImpl;
import org.apache.axiom.om.impl.dom.DocumentTypeImpl;
import org.apache.axiom.om.impl.dom.ElementImpl;
import org.apache.axiom.om.impl.dom.EntityReferenceImpl;
import org.apache.axiom.om.impl.dom.OMDOMException;
import org.apache.axiom.om.impl.dom.ParentNode;
import org.apache.axiom.om.impl.dom.ProcessingInstructionImpl;
import org.apache.axiom.om.impl.dom.TextImpl;
import org.apache.axiom.om.impl.dom.TextNodeImpl;
import org.apache.axiom.om.impl.util.OMSerializerUtil;
import javax.xml.namespace.QName;
/**
* OM factory implementation for DOOM. It creates nodes that implement
* DOM as defined by the interfaces in {@link org.w3c.dom}.
*/
public class OMDOMFactory implements OMFactoryEx {
private final OMDOMMetaFactory metaFactory;
public OMDOMFactory(OMDOMMetaFactory metaFactory) {
this.metaFactory = metaFactory;
}
public OMDOMFactory() {
this(new OMDOMMetaFactory());
}
public OMMetaFactory getMetaFactory() {
return metaFactory;
}
public OMDocument createOMDocument() {
return new DocumentImpl(this);
}
public OMElement createOMElement(String localName, OMNamespace ns) {
return new ElementImpl(null, localName, ns, null, this, true);
}
public OMElement createOMElement(String localName, OMNamespace ns,
OMContainer parent) throws OMDOMException {
if (parent == null) {
return createOMElement(localName, ns);
} else {
return new ElementImpl((ParentNode) parent, localName, ns, null, this, true);
}
}
/** Creates an OMElement with the builder. */
public OMElement createOMElement(String localName, OMContainer parent,
OMXMLParserWrapper builder) {
return new ElementImpl((ParentNode) parent, localName, null, builder, this, false);
}
public OMSourcedElement createOMElement(OMDataSource source) {
throw new UnsupportedOperationException("Not supported for DOM");
}
/* (non-Javadoc)
* @see org.apache.axiom.om.OMFactory#createOMElement(org.apache.axiom.om.OMDataSource, java.lang.String, org.apache.axiom.om.OMNamespace, org.apache.axiom.om.OMContainer)
*/
public OMElement createOMElement(OMDataSource source, String localName, OMNamespace ns,
OMContainer parent) {
throw new UnsupportedOperationException("Not supported for DOM");
}
/* (non-Javadoc)
* @see org.apache.axiom.om.OMFactory#createOMElement(org.apache.axiom.om.OMDataSource, java.lang.String, org.apache.axiom.om.OMNamespace)
*/
public OMSourcedElement createOMElement(OMDataSource source, String localName, OMNamespace ns) {
throw new UnsupportedOperationException("Not supported for DOM");
}
/**
* Unsupported.
*/
public OMSourcedElement createOMElement(OMDataSource source, QName qname) {
throw new UnsupportedOperationException("Not supported for DOM");
}
public OMElement createOMElement(String localName, String namespaceURI, String prefix) {
if (namespaceURI == null) {
throw new IllegalArgumentException("namespaceURI must not be null");
} else if (namespaceURI.length() == 0) {
if (prefix != null && prefix.length() > 0) {
throw new IllegalArgumentException("Cannot create a prefixed element with an empty namespace name");
}
return createOMElement(localName, null);
} else {
return createOMElement(localName, createOMNamespace(namespaceURI, prefix));
}
}
/**
* Creates a new OMDOM Element node and adds it to the given parent.
*
* @see #createOMElement(String, OMNamespace, OMContainer)
* @see org.apache.axiom.om.OMFactory#createOMElement( javax.xml.namespace.QName,
* org.apache.axiom.om.OMContainer)
*/
public OMElement createOMElement(QName qname, OMContainer parent)
throws OMException {
OMNamespaceImpl ns;
if (qname.getNamespaceURI().length() == 0) {
if (qname.getPrefix().length() > 0) {
throw new IllegalArgumentException("Cannot create a prefixed element with an empty namespace name");
}
ns = null;
} else if (qname.getPrefix() != null) {
ns = new OMNamespaceImpl(qname.getNamespaceURI(), qname.getPrefix());
} else {
ns = new OMNamespaceImpl(qname.getNamespaceURI(), null);
}
return createOMElement(qname.getLocalPart(), ns, parent);
}
/**
* Create an OMElement with the given QName
* <p/>
* If the QName contains a prefix, we will ensure that an OMNamespace is created mapping the
* given namespace to the given prefix. If no prefix is passed, we'll create a generated one.
*
* @param qname
* @return the new OMElement.
*/
public OMElement createOMElement(QName qname) throws OMException {
return createOMElement(qname, null);
}
/**
* Creates a new OMNamespace.
*
* @see org.apache.axiom.om.OMFactory#createOMNamespace(String, String)
*/
public OMNamespace createOMNamespace(String uri, String prefix) {
return new OMNamespaceImpl(uri, prefix);
}
public OMText createOMText(OMContainer parent, String text) {
return createOMText(parent, text, OMNode.TEXT_NODE);
}
public OMText createOMText(OMContainer parent, QName text) {
return createOMText(parent, text, OMNode.TEXT_NODE);
}
public OMText createOMText(OMContainer parent, QName text, int type) {
TextImpl txt = new TextImpl(parent, text, type, this);
parent.addChild(txt);
return txt;
}
public OMText createOMText(OMContainer parent, String text, int type) {
return createOMText(parent, text, type, false);
}
public OMText createOMText(OMContainer parent, String text, int type, boolean fromBuilder) {
if (parent == null) {
return createOMText(text, type);
} else if (parent instanceof DocumentImpl) {
throw new OMHierarchyException(
"DOM doesn't support text nodes as children of a document");
} else {
TextNodeImpl txt;
if (type == OMNode.CDATA_SECTION_NODE) {
txt = new CDATASectionImpl(text, this);
} else {
txt = new TextImpl(text, type, this);
}
((OMContainerEx)parent).addChild(txt, fromBuilder);
return txt;
}
}
public OMText createOMText(OMContainer parent, OMText source) {
TextImpl text = new TextImpl((TextImpl) source, this);
parent.addChild(text);
return text;
}
public OMText createOMText(OMContainer parent, char[] charArary, int type) {
TextImpl txt = new TextImpl(charArary, this);
parent.addChild(txt);
return txt;
}
/**
* Creates a OMDOM Text node carrying the given value.
*
* @see org.apache.axiom.om.OMFactory#createOMText(String)
*/
public OMText createOMText(String s) {
return new TextImpl(s, this);
}
/**
* Creates a Character node of the given type.
*
* @see org.apache.axiom.om.OMFactory#createOMText(String, int)
*/
public OMText createOMText(String text, int type) {
if (type == OMNode.CDATA_SECTION_NODE) {
return new CDATASectionImpl(text, this);
} else {
return new TextImpl(text, this);
}
}
/**
* Creates a new OMDOM Text node with the value of the given text value along with the MTOM
* optimization parameters and returns it.
*
* @see org.apache.axiom.om.OMFactory#createOMText(String, String, boolean)
*/
public OMText createOMText(String text, String mimeType, boolean optimize) {
return new TextImpl(text, mimeType, optimize, this);
}
/**
* Creates a new OMDOM Text node with the given datahandler and the given MTOM optimization
* configuration and returns it.
*
* @see org.apache.axiom.om.OMFactory#createOMText(Object, boolean)
*/
public OMText createOMText(Object dataHandler, boolean optimize) {
return createOMText(null, dataHandler, optimize, false);
}
public OMText createOMText(OMContainer parent, Object dataHandler, boolean optimize,
boolean fromBuilder) {
TextImpl text = new TextImpl(dataHandler, optimize, this);
if (parent != null) {
((OMContainerEx)parent).addChild(text, fromBuilder);
}
return text;
}
public OMText createOMText(String contentID, DataHandlerProvider dataHandlerProvider,
boolean optimize) {
return new TextImpl(contentID, dataHandlerProvider, optimize, this);
}
/**
* Creates an OMDOM Text node, adds it to the give parent element and returns it.
*
* @see org.apache.axiom.om.OMFactory#createOMText(OMContainer, String,
* String, boolean)
*/
public OMText createOMText(OMContainer parent, String s, String mimeType,
boolean optimize) {
TextImpl text = new TextImpl(s, mimeType, optimize, this);
parent.addChild(text);
return text;
}
public OMAttribute createOMAttribute(String localName, OMNamespace ns,
String value) {
if (ns != null && ns.getPrefix() == null) {
String namespaceURI = ns.getNamespaceURI();
if (namespaceURI.length() == 0) {
ns = null;
} else {
ns = new OMNamespaceImpl(namespaceURI, OMSerializerUtil.getNextNSPrefix());
}
}
return new AttrImpl(null, localName, ns, value, this);
}
public OMDocType createOMDocType(OMContainer parent, String rootName, String publicId,
String systemId, String internalSubset) {
return createOMDocType(parent, rootName, publicId, systemId, internalSubset, false);
}
public OMDocType createOMDocType(OMContainer parent, String rootName, String publicId,
String systemId, String internalSubset, boolean fromBuilder) {
DocumentTypeImpl docType = new DocumentTypeImpl(rootName, publicId, systemId, internalSubset, this);
if (parent != null) {
((OMContainerEx)parent).addChild(docType, fromBuilder);
}
return docType;
}
public OMProcessingInstruction createOMProcessingInstruction(
OMContainer parent, String piTarget, String piData) {
return createOMProcessingInstruction(parent, piTarget, piData, false);
}
public OMProcessingInstruction createOMProcessingInstruction(
OMContainer parent, String piTarget, String piData, boolean fromBuilder) {
ProcessingInstructionImpl pi =
new ProcessingInstructionImpl(piTarget, piData, this);
if (parent != null) {
((OMContainerEx)parent).addChild(pi, fromBuilder);
}
return pi;
}
public OMComment createOMComment(OMContainer parent, String content) {
return createOMComment(parent, content, false);
}
public OMComment createOMComment(OMContainer parent, String content, boolean fromBuilder) {
CommentImpl comment = new CommentImpl(content, this);
if (parent != null) {
((OMContainerEx)parent).addChild(comment, fromBuilder);
}
return comment;
}
public OMDocument createOMDocument(OMXMLParserWrapper builder) {
return new DocumentImpl(builder, this);
}
public OMEntityReference createOMEntityReference(OMContainer parent, String name) {
return createOMEntityReference(parent, name, null, false);
}
public OMEntityReference createOMEntityReference(OMContainer parent, String name, String replacementText, boolean fromBuilder) {
EntityReferenceImpl node = new EntityReferenceImpl(name, replacementText, this);
if (parent != null) {
((OMContainerEx)parent).addChild(node, fromBuilder);
}
return node;
}
/**
* This method is intended only to be used by Axiom intenals when merging Objects from different
* Axiom implementations to the DOOM implementation.
*
* @param child
*/
public OMNode importNode(OMNode child) {
int type = child.getType();
switch (type) {
case (OMNode.ELEMENT_NODE): {
OMElement childElement = (OMElement) child;
OMElement newElement = (new StAXOMBuilder(this,
childElement.getXMLStreamReader()))
.getDocumentElement();
newElement.build();
return newElement;
}
case (OMNode.TEXT_NODE): {
OMText importedText = (OMText) child;
OMText newText;
if (importedText.isBinary()) {
boolean isOptimize = importedText.isOptimized();
newText = createOMText(importedText
.getDataHandler(), isOptimize);
} else if (importedText.isCharacters()) {
newText = new TextImpl(importedText.getTextCharacters(), this);
} else {
newText = new TextImpl(importedText.getText(), this);
}
return newText;
}
case (OMNode.PI_NODE): {
OMProcessingInstruction importedPI = (OMProcessingInstruction) child;
OMProcessingInstruction newPI =
createOMProcessingInstruction(null, importedPI.getTarget(),
importedPI.getValue());
return newPI;
}
case (OMNode.COMMENT_NODE): {
OMComment importedComment = (OMComment) child;
OMComment newComment = createOMComment(null, importedComment.getValue());
newComment = new CommentImpl(importedComment.getValue(), this);
return newComment;
}
case (OMNode.DTD_NODE): {
OMDocType importedDocType = (OMDocType) child;
return createOMDocType(null, importedDocType.getRootName(),
importedDocType.getPublicId(), importedDocType.getSystemId(),
importedDocType.getInternalSubset());
}
default: {
throw new UnsupportedOperationException(
"Not Implemented Yet for the given node type");
}
}
}
}