axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ruchi...@apache.org
Subject svn commit: r227346 - in /webservices/axis/trunk/java/modules/xml: src/org/apache/axis2/om/ src/org/apache/axis2/om/impl/llom/ test/org/apache/axis2/om/impl/llom/
Date Thu, 04 Aug 2005 11:19:17 GMT
Author: ruchithf
Date: Thu Aug  4 04:18:59 2005
New Revision: 227346

URL: http://svn.apache.org/viewcvs?rev=227346&view=rev
Log:
Adding OMDOcument, OMDocumentImpl, OMDocumentSerilizationTest

Added:
    webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java
    webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
    webservices/axis/trunk/java/modules/xml/test/org/apache/axis2/om/impl/llom/OMDocumentSerilizationTest.java
Removed:
    webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocument.java

Added: webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java?rev=227346&view=auto
==============================================================================
--- webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java (added)
+++ webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java Thu Aug
 4 04:18:59 2005
@@ -0,0 +1,103 @@
+/*
+ * Copyright 2004,2005 The Apache Software Foundation.
+ *
+ * Licensed 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.axis2.om;
+
+import javax.xml.stream.XMLStreamException;
+
+import org.apache.axis2.om.impl.OMOutputImpl;
+
+
+public interface OMDocument extends OMContainer {
+
+	/**
+	 * Field XML_10 XML Version 1.0
+	 */
+	public final static String XML_10 = "1.0";
+	
+	/**
+	 * Field XML_11 XML Version 1.1
+	 */
+	public final static String XML_11 = "1.1";
+	
+	/**
+	 * Returns the document element
+	 * @return
+	 */
+	public OMElement getDocumentElement();
+	
+	/**
+	 * Sets the document element of the XML document
+	 * @param rootElement
+	 */
+	public void setDocumentElement(OMElement rootElement);
+	
+	/**
+	 * Returns the XML version
+	 * @return
+	 */
+	public String getXMLVersion();
+	
+	/**
+	 * Sets the XML version
+	 * @see OMDocumentImpl#XML_10 XML 1.0
+	 * @see OMDocumentImpl#XML_11 XML 1.1
+	 * @param version
+	 */
+	public void setXMLVersion(String version);
+	
+	/**
+	 * Returns the caracter set encoding scheme
+	 * @return
+	 */
+	public String getCharsetEncoding();
+	
+	/**
+	 * Sets the character set encoding scheme to be used
+	 * @param charsetEncoding
+	 */
+	public void setCharsetEncoding(String charsetEncoding);
+
+	/**
+	 * Serialize the OMDocument
+	 * @param omOutput
+	 * @throws XMLStreamException
+	 */
+	public void serialize(OMOutputImpl omOutput) throws XMLStreamException;
+	
+	/**
+	 * Serilize the OMDocument with the option of excluding/including the 
+	 * XML declaration
+	 * @param omOutput
+	 * @param includeXMLDeclaration Whether to include the XML declaration or not 
+	 * @throws XMLStreamException
+	 */
+	public void serialize(OMOutputImpl omOutput, boolean includeXMLDeclaration) throws XMLStreamException;
+	
+	/**
+	 * Serializa the document with cache on
+	 * @param omOutput
+	 * @throws XMLStreamException
+	 */
+	public void serializeWithCache(OMOutputImpl omOutput) throws XMLStreamException;
+	
+	/**
+	 * Seralize the document with cache on with the option on excluding the XML declaration
+	 * @param omOutput
+	 * @param includeXMLDeclaration
+	 * @throws XMLStreamException
+	 */
+	public void serializeWithCache(OMOutputImpl omOutput, boolean includeXMLDeclaration) throws
XMLStreamException;
+}

Added: webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java?rev=227346&view=auto
==============================================================================
--- webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
(added)
+++ webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
Thu Aug  4 04:18:59 2005
@@ -0,0 +1,324 @@
+/*
+ * Copyright 2004,2005 The Apache Software Foundation.
+ *
+ * Licensed 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.axis2.om.impl.llom;
+
+import java.util.Iterator;
+
+import javax.xml.namespace.QName;
+import javax.xml.stream.XMLStreamException;
+
+import org.apache.axis2.om.OMDocument;
+import org.apache.axis2.om.OMElement;
+import org.apache.axis2.om.OMException;
+import org.apache.axis2.om.OMNode;
+import org.apache.axis2.om.OMXMLParserWrapper;
+import org.apache.axis2.om.impl.OMOutputImpl;
+import org.apache.axis2.om.impl.llom.traverse.OMChildrenIterator;
+import org.apache.axis2.om.impl.llom.traverse.OMChildrenQNameIterator;
+
+/**
+ * Class OMDocumentImpl
+ */
+public class OMDocumentImpl implements OMDocument {
+    /**
+     * Field rootElement
+     */
+    private OMElement rootElement;
+
+    /**
+     * Field firstChild
+     */
+    protected OMNode firstChild;
+
+    /**
+     * Field lastChild
+     */
+    private OMNode lastChild;
+
+    /**
+     * Field done
+     */
+    protected boolean done = false;
+
+    /**
+     * Field parserWrapper
+     */
+    private OMXMLParserWrapper parserWrapper;
+
+    /**
+     * Field charSetEncoding
+     * Dafult : UTF-8
+     */
+    private String charSetEncoding = "UTF-8";
+    
+    /**
+     * Field xmlVersion
+     */
+    private String xmlVersion = "1.0";
+    
+
+    
+    /**
+     * Default constructor
+     */
+    public OMDocumentImpl() {
+    	
+    }
+    
+    /**
+     * @param rootElement
+     * @param parserWrapper
+     */
+    public OMDocumentImpl(OMElement rootElement, OMXMLParserWrapper parserWrapper) {
+        this.rootElement = rootElement;
+        this.parserWrapper = parserWrapper;
+    }
+
+    /**
+     * @param parserWrapper
+     */
+    public OMDocumentImpl(OMXMLParserWrapper parserWrapper) {
+        this.parserWrapper = parserWrapper;
+    }
+
+    /**
+     * Method getRootElement
+     *
+     * @return
+     */
+    public OMElement getDocumentElement() {
+        while (rootElement == null) {
+            parserWrapper.next();
+        }
+        return rootElement;
+    }
+
+    /**
+     * Method setRootElement
+     *
+     * @param rootElement
+     */
+    public void setDocumentElement(OMElement rootElement) {
+        this.rootElement = rootElement;
+    }
+
+    /**
+     * this will indicate whether parser has parsed this information item completely or not.
+     * If somethings info are not available in the item, one has to check this attribute
to make sure that, this
+     * item has been parsed completely or not.
+     *
+     * @return
+     */
+    public boolean isComplete() {
+        return done;
+    }
+
+    /**
+     * Method setComplete
+     *
+     * @param state
+     */
+    public void setComplete(boolean state) {
+        this.done = state;
+    }
+
+    /**
+     * This will force the parser to proceed, if parser has not yet finished with the XML
input
+     */
+    public void buildNext() {
+        if (!parserWrapper.isCompleted())
+            parserWrapper.next();
+    }
+
+    /**
+     * This will add child to the element. One can decide whether he append the child or
he adds to the
+     * front of the children list
+     *
+     * @param child
+     */
+    public void addChild(OMNode child) {
+        addChild((OMNodeImpl) child);
+    }
+
+    /**
+     * Method addChild
+     *
+     * @param child
+     */
+    private void addChild(OMNodeImpl child) {
+        if (firstChild == null) {
+            firstChild = child;
+            child.setPreviousSibling(null);
+        } else {
+            child.setPreviousSibling(lastChild);
+            lastChild.setNextSibling(child);
+        }
+        child.setNextSibling(null);
+        child.setParent(this);
+        lastChild = child;
+
+    }
+
+    /**
+     * This returns a collection of this element.
+     * Children can be of types OMElement, OMText.
+     *
+     * @return
+     */
+    public Iterator getChildren() {
+        return new OMChildrenIterator(getFirstChild());
+    }
+
+    /**
+     * This will search for children with a given QName and will return an iterator to traverse
through
+     * the OMNodes.
+     * This QName can contain any combination of prefix, localname and URI
+     *
+     * @param elementQName
+     * @return
+     * @throws org.apache.axis2.om.OMException
+     *
+     * @throws OMException
+     */
+    public Iterator getChildrenWithName(QName elementQName) throws OMException {
+        return new OMChildrenQNameIterator(getFirstChild(),
+                elementQName);
+    }
+
+    /**
+     * Method getFirstChild
+     *
+     * @return
+     */
+    public OMNode getFirstChild() {
+        while ((firstChild == null) && !done) {
+            buildNext();
+        }
+        return firstChild;
+    }
+
+    /**
+     * Method getFirstChildWithName
+     *
+     * @param elementQName
+     * @return
+     * @throws OMException
+     */
+    public OMElement getFirstChildWithName(QName elementQName) throws OMException {
+        OMChildrenQNameIterator omChildrenQNameIterator =
+                new OMChildrenQNameIterator(getFirstChild(),
+                        elementQName);
+        OMNode omNode = null;
+        if (omChildrenQNameIterator.hasNext()) {
+            omNode = (OMNode) omChildrenQNameIterator.next();
+        }
+
+        return ((omNode != null) && (OMNode.ELEMENT_NODE == omNode.getType())) ?
+                (OMElement) omNode : null;
+
+    }
+
+    /**
+     * Method setFirstChild
+     *
+     * @param firstChild
+     */
+    public void setFirstChild(OMNode firstChild) {
+        this.firstChild = firstChild;
+    }
+    
+    
+    /**
+     * Returns the character set encoding scheme to be used
+     * @return
+     */
+	public String getCharsetEncoding() {
+		return charSetEncoding;
+	}
+	
+	/**
+	 * Set the character set encoding scheme
+	 * @param charSetEncoding
+	 */
+	public void setCharsetEncoding(String charEncoding) {
+		this.charSetEncoding = charEncoding;
+	}
+	
+	public String getXMLVersion() {
+		return xmlVersion;
+	}
+	public void setXMLVersion(String xmlVersion) {
+		this.xmlVersion = xmlVersion;
+	}
+	
+	/**
+	 * Serialize the docuement with/without the XML declaration
+	 */
+	public void serialize(OMOutputImpl omOutput, boolean includeXMLDeclaration) throws XMLStreamException
{
+		serialize(omOutput,false,includeXMLDeclaration);
+	}
+
+	/**
+	 * Serialize the document with the XML declaration
+	 * 
+	 * @see org.apache.axis2.om.OMDocument#serialize(org.apache.axis2.om.impl.OMOutputImpl,
+	 *      boolean)
+	 */
+	public void serialize(OMOutputImpl omOutput)
+			throws XMLStreamException {
+		serialize(omOutput, false, true);
+	}
+	
+
+	/**
+	 * Serialize the document with cache
+	 * @see org.apache.axis2.om.OMDocument#serializeWithCache(org.apache.axis2.om.impl.OMOutputImpl)
+	 */
+	public void serializeWithCache(OMOutputImpl omOutput) throws XMLStreamException {
+		serialize(omOutput, true, true);
+		
+	}
+
+	/**
+	 * Serialize the document with cache
+	 * @see org.apache.axis2.om.OMDocument#serializeWithCache(org.apache.axis2.om.impl.OMOutputImpl,
boolean)
+	 */
+	public void serializeWithCache(OMOutputImpl omOutput, boolean includeXMLDeclaration) throws
XMLStreamException {
+		serialize(omOutput,true,includeXMLDeclaration);
+		
+	}
+	
+	private void serialize(OMOutputImpl omOutput, boolean cache, boolean includeXMLDeclaration)
throws XMLStreamException {
+		if (includeXMLDeclaration) {
+			//Check whether the OMOutput char encoding and OMDocument char
+			//encoding matches, if not use char encoding of OMOutput
+			String outputCharEncoding = omOutput.getCharSetEncoding();
+			if(!outputCharEncoding.equalsIgnoreCase(this.charSetEncoding)) {
+				this.charSetEncoding = outputCharEncoding;
+			}
+			omOutput.getXmlStreamWriter().writeStartDocument(charSetEncoding,
+					xmlVersion);
+		}
+
+		if (cache) {
+			this.rootElement.serializeWithCache(omOutput);
+		} else {
+			this.rootElement.serialize(omOutput);
+		}
+	}
+
+	
+}

Added: webservices/axis/trunk/java/modules/xml/test/org/apache/axis2/om/impl/llom/OMDocumentSerilizationTest.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/xml/test/org/apache/axis2/om/impl/llom/OMDocumentSerilizationTest.java?rev=227346&view=auto
==============================================================================
--- webservices/axis/trunk/java/modules/xml/test/org/apache/axis2/om/impl/llom/OMDocumentSerilizationTest.java
(added)
+++ webservices/axis/trunk/java/modules/xml/test/org/apache/axis2/om/impl/llom/OMDocumentSerilizationTest.java
Thu Aug  4 04:18:59 2005
@@ -0,0 +1,117 @@
+package org.apache.axis2.om.impl.llom;
+
+import java.io.ByteArrayOutputStream;
+
+import javax.xml.stream.XMLStreamException;
+
+import org.apache.axis2.om.OMAbstractFactory;
+import org.apache.axis2.om.OMDocument;
+import org.apache.axis2.om.OMElement;
+import org.apache.axis2.om.OMFactory;
+import org.apache.axis2.om.OMNamespace;
+import org.apache.axis2.om.impl.OMOutputImpl;
+
+import junit.framework.TestCase;
+
+/**
+ * This tests the serialize method 
+ * 
+ * @author Ruchith Fernando (ruchith.fernando@gmail.com)
+ */
+public class OMDocumentSerilizationTest extends TestCase {
+
+	private OMDocument document;
+	private String xmlDeclStart = "<?xml";
+	private String encoding = "encoding='UTF-8'";
+	private String encoding_UTF16 = "encoding='UTF-16'";
+	private String version = "version='1.0'"; 
+	private String version_11 = "version='1.1'";
+	
+	public void setUp() {
+		OMFactory factory = OMAbstractFactory.getOMFactory();
+		
+		OMNamespace namespace = factory.createOMNamespace("http://testuri.org","test");
+		OMElement documentElement = factory.createOMElement("DocumentElement",namespace);
+		
+		OMElement child1 = factory.createOMElement("Child1",namespace);
+		child1.setText("TestText");
+		documentElement.addChild(child1);
+		
+		document = factory.createOMDocument();
+		document.setDocumentElement(documentElement);
+		
+	}
+	
+	public OMDocumentSerilizationTest(String name) {
+		super(name);
+	}
+
+	
+	public void testXMLDecleration() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		document.serialize(output);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		
+		assertTrue("XML Declaration missing",-1<xmlDocuemnt.indexOf(xmlDeclStart));
+	}
+	
+	public void testExcludeXMLDeclaration() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		document.serialize(output,false);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		
+		assertTrue(
+				"XML Declaration is included when serilizing without the declaration",
+				-1 == xmlDocuemnt.indexOf(xmlDeclStart));		
+	}
+	
+	public void testCharsetEncoding() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		document.serialize(output);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		
+		assertTrue("Charset declaration missing",-1<xmlDocuemnt.indexOf(encoding));		
+	}
+	
+	public void testCharsetEncodingUTF_16() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		output.setCharSetEncoding("UTF-16");
+		document.serialize(output);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		assertTrue("Charset declaration missing",-1<xmlDocuemnt.indexOf(encoding_UTF16));		
+	}
+		
+	
+	public void testXMLVersion() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		document.serialize(output);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		assertTrue("Charset declaration missing",-1<xmlDocuemnt.indexOf(version));		
+	}
+
+	public void testXMLVersion_11() throws XMLStreamException {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		OMOutputImpl output = new OMOutputImpl(baos,false);
+		document.setXMLVersion("1.1");
+		document.serialize(output);
+		output.flush();
+		
+		String xmlDocuemnt = new String(baos.toByteArray());
+		assertTrue("Charset declaration missing",-1<xmlDocuemnt.indexOf(version_11));		
+	}
+}



Mime
View raw message