All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.siemens.ct.exi.main.api.xmlpull.EXISerializer Maven / Gradle / Ivy

Go to download

EXIficient is an open source implementation of the W3C Efficient XML Interchange (EXI) format specification written in the Java programming language. The EXI format is a very compact representation for the Extensible Markup Language (XML) Information Set that is intended to simultaneously optimize performance and the utilization of computational resources.

There is a newer version: 1.0.7
Show newest version
/*
 * Copyright (c) 2007-2018 Siemens AG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * 
 */

package com.siemens.ct.exi.main.api.xmlpull;

/**
 * 
 * @author [email protected]
 * @author [email protected]
 * 

 */

import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.util.ArrayList;
import java.util.List;

import org.xmlpull.v1.XmlSerializer;

import com.siemens.ct.exi.core.EXIBodyEncoder;
import com.siemens.ct.exi.core.EXIFactory;
import com.siemens.ct.exi.core.EXIStreamEncoder;
import com.siemens.ct.exi.core.attributes.AttributeFactory;
import com.siemens.ct.exi.core.attributes.AttributeList;
import com.siemens.ct.exi.core.container.NamespaceDeclaration;
import com.siemens.ct.exi.core.exceptions.EXIException;
import com.siemens.ct.exi.core.values.StringValue;

public class EXISerializer implements XmlSerializer {

	final protected EXIFactory factory;
	final protected EXIStreamEncoder exiStream;

	protected EXIBodyEncoder exiBody;

	protected OutputStream outputStream;

	protected List nsDecls;

	String currentNamespace;
	String currentName;

	// AT or NS Events pending
	protected boolean pendingATs;

	// attributes
	protected AttributeList exiAttributes;

	public EXISerializer(EXIFactory factory) throws EXIException {
		this.factory = factory;

		this.exiStream = factory.createEXIStreamEncoder();

		AttributeFactory attFactory = AttributeFactory.newInstance();
		exiAttributes = attFactory.createAttributeListInstance(factory);

		nsDecls = new ArrayList();
	}

	public void setFeature(String name, boolean state)
			throws IllegalArgumentException, IllegalStateException {
		// TODO check if any feature could be of interest
		throw new IllegalStateException("EXI does not support setting feature "
				+ name + " to " + state);

	}

	public boolean getFeature(String name) {
		return false; // unknown
	}

	public void setProperty(String name, Object value)
			throws IllegalArgumentException, IllegalStateException {
		// TODO check if any property could be of interest
		throw new IllegalStateException(
				"EXI does not support setting property " + name + " to "
						+ value);
	}

	public Object getProperty(String name) {
		return null; // unknown
	}

	public void setOutput(OutputStream os, String encoding) throws IOException,
			IllegalArgumentException, IllegalStateException {
		try {
			this.outputStream = os;
			exiBody = exiStream.encodeHeader(os);
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	public void setOutput(Writer writer) throws IOException,
			IllegalArgumentException, IllegalStateException {
		throw new IllegalArgumentException(
				"EXI requires byte-based stream. Consider using OutputStream");
	}

	protected void init() {
		pendingATs = false;
		exiAttributes.clear();
	}

	public void startDocument(String encoding, Boolean standalone)
			throws IOException, IllegalArgumentException, IllegalStateException {
		try {
			init();
			exiBody.encodeStartDocument();
		} catch (EXIException e) {
			throw new IOException(e);
		}
	}

	public void endDocument() throws IOException, IllegalArgumentException,
			IllegalStateException {
		try {
			checkPendingATEvents();
			exiBody.encodeEndDocument();
			exiBody.flush();
		} catch (EXIException e) {
			throw new IOException(e);
		}
	}

	public void setPrefix(String prefix, String namespace) throws IOException,
			IllegalArgumentException, IllegalStateException {
		// Note: is called before start tag --> store it
		nsDecls.add(new NamespaceDeclaration(namespace, prefix));
	}

	public String getPrefix(String namespace, boolean generatePrefix)
			throws IllegalArgumentException {
		return null;
	}

	public int getDepth() {
		return 0;
	}

	public String getNamespace() {
		return currentNamespace;
	}

	public String getName() {
		return currentName;
	}

	public XmlSerializer startTag(String namespace, String name)
			throws IOException, IllegalArgumentException, IllegalStateException {
		try {
			checkPendingATEvents();

			this.currentNamespace = namespace;
			this.currentName = name;
			exiBody.encodeStartElement(namespace, name, null);
			for (int i = 0; i < nsDecls.size(); i++) {
				NamespaceDeclaration ns = nsDecls.get(i);
				exiBody.encodeNamespaceDeclaration(ns.namespaceURI, ns.prefix);
			}
			nsDecls.clear();
			return this;
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	protected void checkPendingATEvents() throws IOException {
		try {
			// NS first & ATs
			if (pendingATs) {
				// encode NS decls and attributes

				exiBody.encodeAttributeList(exiAttributes);

				exiAttributes.clear();

				pendingATs = false;
			}
		} catch (EXIException e) {
			throw new IOException(e);
		}
	}

	public XmlSerializer attribute(String namespace, String name, String value)
			throws IOException, IllegalArgumentException, IllegalStateException {
		this.exiAttributes.addAttribute(namespace, name, null, value);
		return this;
	}

	public XmlSerializer endTag(String namespace, String name)
			throws IOException, IllegalArgumentException, IllegalStateException {
		try {
			checkPendingATEvents();
			exiBody.encodeEndElement();
			return this;
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	public XmlSerializer text(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		try {
			checkPendingATEvents();
			exiBody.encodeCharacters(new StringValue(text));
			return this;
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	public XmlSerializer text(char[] buf, int start, int len)
			throws IOException, IllegalArgumentException, IllegalStateException {
		return text(new String(buf, start, len));
	}

	public void cdsect(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		this.checkPendingATEvents();
		text("");
	}

	public void entityRef(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		try {
			checkPendingATEvents();
			exiBody.encodeEntityReference(text);
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	public void processingInstruction(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		checkPendingATEvents();
		text("");
	}

	public void comment(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		try {
			checkPendingATEvents();
			char[] ch = text.toCharArray();
			exiBody.encodeComment(ch, 0, ch.length);
		} catch (EXIException e) {
			throw new IllegalArgumentException(e);
		}
	}

	public void docdecl(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		checkPendingATEvents();
		text("");
	}

	public void ignorableWhitespace(String text) throws IOException,
			IllegalArgumentException, IllegalStateException {
		text(text);
	}

	public void flush() throws IOException {
		exiBody.flush();
	}

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy