Application: gvSIG desktop » gvSIG data provider for GPE

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2009 {gvSIG}  {{Task}}

 */

package org.gvsig.xmlpull.lib.impl;

import org.gvsig.tools.exception.BaseRuntimeException;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader;

/**

 * Exception thrown when there is an error creating a new {@link IXmlStreamReader}.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class CreateXmlStreamReaderException extends

	BaseRuntimeException {

	private static final long serialVersionUID = -8220667598288924597L;

	private final static String MESSAGE_FORMAT = "Exception creating the xml stream reader with " +

			"mimeType '%(mimeType)'.";

	private final static String MESSAGE_KEY = "_CreateXMLStreamReaderException";

	public CreateXmlStreamReaderException(String mimeType, Throwable cause){

		super(MESSAGE_FORMAT, cause, MESSAGE_KEY, serialVersionUID);

		setValue("mimeType", mimeType);

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2009 {Iver T.I.}   {Task}

*/

package org.gvsig.xmlpull.lib.impl;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.xmlpull.lib.api.XmlPullLibrary;

import org.gvsig.xmlpull.lib.api.XmlPullLocator;

import org.gvsig.xmlpull.lib.spi.XmlPullProviderLocator;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class DefaultXmlPullLibrary extends AbstractLibrary {

	public void doRegistration() {

		registerAsImplementationOf(XmlPullLibrary.class);

	}

	protected void doInitialize() throws LibraryException {       

        XmlPullLocator.registerXMLManager(DefaultXmlPullManager.class);

        XmlPullProviderLocator.registerXMLProviderManager(DefaultXmlPullProviderManager.class);

	}

	protected void doPostInitialize() throws LibraryException {

		// Nothing to do

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Iver T.I.}   {Task}

*/

package org.gvsig.xmlpull.lib.impl;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Iterator;

import java.util.List;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReaderFactory;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriterFactory;

import org.gvsig.xmlpull.lib.api.stream.XmlStreamException;

import org.gvsig.xmlpull.lib.spi.XmlPullProviderManager;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class DefaultXmlPullProviderManager implements XmlPullProviderManager{

	private List xmlStreamReaderFactories = Collections.synchronizedList(new ArrayList());

	private List xmlStreamWriterFactories = Collections.synchronizedList(new ArrayList());

	public IXmlStreamReader createStreamReader(String mimeType, InputStream is){

		Iterator it = xmlStreamReaderFactories.iterator();

		while (it.hasNext()){

			IXmlStreamReaderFactory xmlStreamReaderFactory = 

				(IXmlStreamReaderFactory)it.next();

			if (xmlStreamReaderFactory.canParse(mimeType)){

				try {

					return xmlStreamReaderFactory.createParser(mimeType, is);

				} catch (Exception e) {

					throw new CreateXmlStreamReaderException(mimeType, e);

				}

			}

		}		

		throw new IllegalArgumentException("There is not a " +

				"XMLStreamReader for the mimetype " + mimeType);

	}

	public void registerXMLStreamReaderFactory(IXmlStreamReaderFactory xmlStreamReaderFactory)  {

		xmlStreamReaderFactories.add(xmlStreamReaderFactory);		

	}

	public IXmlStreamWriter createStreamWriter(String mimeType, OutputStream os)

			throws XmlStreamException, IllegalArgumentException {

		Iterator it = xmlStreamWriterFactories.iterator();

		while (it.hasNext()){

			IXmlStreamWriterFactory xmlStreamWriterFactory = 

				(IXmlStreamWriterFactory)it.next();

			if (xmlStreamWriterFactory.canWrite(mimeType)){

				try {

					return xmlStreamWriterFactory.createWriter(mimeType, os);

				} catch (Exception e) {

					throw new CreateXmlStreamWriterException(mimeType, e);

				}

			}

		}		

		throw new IllegalArgumentException("There is not a " +

				"XMLStreamWriter for the mimetype " + mimeType);

	}

	public void registerXMLStreamWriterFactory(

			IXmlStreamWriterFactory xmlStreamWriterFactory) {

		xmlStreamWriterFactories.add(xmlStreamWriterFactory);			

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2009 {gvSIG}  {{Task}}

 */

package org.gvsig.xmlpull.lib.impl;

import org.gvsig.tools.exception.BaseRuntimeException;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader;

/**

 * Exception thrown when there is an error creating a new {@link IXmlStreamReader}.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class CreateXmlStreamWriterException extends

	BaseRuntimeException {

	private static final long serialVersionUID = 6894668637124114583L;

	private final static String MESSAGE_FORMAT = "Exception creating the xml stream writer with " +

			"mimeType '%(mimeType)'.";

	private final static String MESSAGE_KEY = "_CreateXMLStreamReaderException";

	public CreateXmlStreamWriterException(String mimeType, Throwable cause){

		super(MESSAGE_FORMAT, cause, MESSAGE_KEY, serialVersionUID);

		setValue("mimeType", mimeType);

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Iver T.I.}   {Task}

*/

package org.gvsig.xmlpull.lib.impl;

import java.io.InputStream;

import java.io.OutputStream;

import org.gvsig.xmlpull.lib.api.XmlPullManager;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter;

import org.gvsig.xmlpull.lib.api.stream.XmlStreamException;

import org.gvsig.xmlpull.lib.spi.XmlPullProviderLocator;

import org.gvsig.xmlpull.lib.spi.XmlPullProviderManager;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class DefaultXmlPullManager implements XmlPullManager{

	private XmlPullProviderManager xmlPullProviderManager = null;

	private XmlPullProviderManager getXmlPullProviderManager() {

		if (xmlPullProviderManager == null){

			xmlPullProviderManager = XmlPullProviderLocator.getXMLProviderManager();

		}

		return xmlPullProviderManager;

	}

	public IXmlStreamReader createStreamReader(String mimeType, InputStream is)

			throws XmlStreamException, IllegalArgumentException {

		return getXmlPullProviderManager().createStreamReader(mimeType, is);

	}

	public IXmlStreamWriter createStreamWriter(String mimeType, OutputStream os)

			throws XmlStreamException, IllegalArgumentException {

		return getXmlPullProviderManager().createStreamWriter(mimeType, os);

	}

}

org.gvsig.xmlpull.lib.impl.DefaultXmlPullLibrary

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.xmlpull.lib.impl</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.xmlpull.lib.impl</name>

	<description>Default XML Pull library Implementation</description>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.xmlpull.lib</artifactId>	

		<version>2.0.23</version>			

	</parent>

	<dependencies>

		<dependency>

      		<groupId>org.gvsig</groupId>

      		<artifactId>org.gvsig.tools.lib</artifactId>

    	</dependency>

    	<dependency>

      		<groupId>org.gvsig</groupId>

      		<artifactId>org.gvsig.tools.lib</artifactId>

      		<type>test-jar</type>

    	</dependency>  

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.xmlpull.lib.api</artifactId>	

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.xmlpull.lib.spi</artifactId>			

		</dependency>

	</dependencies>

	<build>

		<plugins>

			<plugin>

				<groupId>org.apache.maven.plugins</groupId>

				<artifactId>maven-compiler-plugin</artifactId>

				<configuration>

					<source>1.4</source>

					<target>1.5</target>

				</configuration>

			</plugin>

		</plugins>

	</build>

	<profiles>

		<profile>

			<id>cdc</id>

			<build>

				<plugins>

					<plugin>

						<groupId>org.apache.maven.plugins</groupId>

						<artifactId>maven-compiler-plugin</artifactId>

						<configuration>

							<source>1.4</source>

							<target>1.4</target>

						</configuration>

					</plugin>

				</plugins>

			</build>

		</profile>

	</profiles>

</project>

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.xmlpull.lib</artifactId>

	<packaging>pom</packaging>	

	<name>org.gvsig.xmlpull.lib</name>

	<description>XML Pull library</description>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.xmlpull</artifactId>	

		<version>2.0.23</version>	

	</parent>

	<modules>

		<module>org.gvsig.xmlpull.lib.api</module>

		<module>org.gvsig.xmlpull.lib.spi</module>

		<module>org.gvsig.xmlpull.lib.impl</module>

	</modules>

</project>

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Iver T.I.}   {Task}

*/

package org.gvsig.xmlpull.lib.api;

import java.io.InputStream;

import java.io.OutputStream;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamReader;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter;

import org.gvsig.xmlpull.lib.api.stream.XmlStreamException;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public interface XmlPullManager {

	public IXmlStreamReader createStreamReader(String mimeType, InputStream is) throws XmlStreamException, IllegalArgumentException;

	public IXmlStreamWriter createStreamWriter(String mimeType, OutputStream os) throws XmlStreamException, IllegalArgumentException;

}

package org.gvsig.xmlpull.lib.api.stream;

import java.io.InputStream;

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/**

 * 

 */

public interface IXmlStreamReaderFactory {

    boolean canParse(String mimeType);

    IXmlStreamReader createParser(String mimeType, InputStream in) throws XmlStreamException,

            IllegalArgumentException;

}

/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 9638 62 495

 *      gvsig@gva.es

 *      www.gvsig.gva.es

 */

package org.gvsig.xmlpull.lib.api.stream;

import java.io.IOException;

/**

 * IXmlStreamWriter defines an "XML push" like streaming API for writing XML documents encoded as

 * per the OGC Binary XML Best Practices document.

 * <p>

 * This interface does not defines setter methods to control encoding behavior such as byte order to

 * use or character encoding. A IXmlStreamWriter instance is meant to be already configured with the

 * desired encoding options when returned from the {@link BxmlOutputFactory}.

 * </p>

 * <p>

 * Sample usage:

 * 

 * <pre>

 * <code>

 * BxmlOutputFactory factory = BxmlFactoryFinder.newOutputFactory();

 * IXmlStreamWriter writer = factory.createSerializer(inputStream);

 * 

 * writer.setSchemaLocation("http://www.example.com", "http://www.example.com/schema.xsd");

 * 

 * writer.writeStartDocument();

 * 

 * writer.setPrefix("ex", "http://www.example.com")

 * writer.setDefaultNamespace("http://www.anotherexample.com");

 * 

 * writer.writeStartElement("", "root");

 * 

 * writer.writeStartElement("http://www.example.com", "child");

 * 

 * //child attributes list...

 * writer.writeStartAttribute("http://www.example.com", "att");

 * writer.writeValue("attValue");

 * writer.writeStartAttribute("http://www.example.com", "emptyAtt");

 * writer.writeEndAttributes();

 * 

 * //child value as a purely streamed int array

 * writer.startArray(EventType.VALUE_INT, 10);

 * for(int i = 0; i < 10; i++){

 *   writer.writeValue(i);

 * }

 * writer.endArray();

 * 

 * writer.writeComment("interleaved value type follow");

 * 

 * writer.writeValue("10 11 12 13");

 * 

 * writer.writeEndElement(); // child

 * writer.writeEndElement(); // root

 * writer.writeEndDocument();

 * </code>

 * </pre>

 * 

 * </p>

 * 

 * @author Gabriel Roldan (TOPP)

 * @version $Id: IXmlStreamWriter.java 21945 2008-06-30 14:04:53Z jpiera $

 * @since 1.0

 */

public interface IXmlStreamWriter {

    /**

     * Returns a safe copy of the encoding options this writer is settled up with.

     * <p>

     * Modifications to the returned object state does not affect this writer behaviour.

     * </p>

     * 

     * @return an object representing the set of encoding options this writer operates with

     */

    //public EncodingOptions getEncodingOptions();

    /**

     * Returns the event corresponding to the last write call.

     * <p>

     * For example, if the last write call was

     * {@link #writeStartElement(String, String) writeStartElement} it shall return

     * {@link EventType#START_ELEMENT START_ELEMENT}, if it was

     * {@link #writeStartAttribute(String, String) writeStartAttribute},

     * {@link EventType#ATTRIBUTE ATTRIBUTE}, etc.

     * </p>

     * 

     * @post {$return != null}

     * @return {@link EventType#NONE} if writing has not yet started (ie, writeStartDocument has not

     *         been called), the event for the last write operation otherwise.

     */

    public EventType getLastEvent();

    /**

     * @return {@code null} if no tag event has been written yet, START_ELEMENT or END_ELEMENT

     *         otherwise, depending on which of them was lately called

     */

    public EventType getLastTagEvent();

    /**

     * @post {$return >= 0}

     * @return how deep is the current element tree

     */

    public int getTagDeep();

    /**

     * Closes this stream writer and releases any system resources associated with it, including the

     * underlying output stream or any other output source it may be operating upon.

     * <p>

     * A call to this method implies a flush of any possible buffered wtrite before closing the

     * stream.

     * </p>

     * <p>

     * The first call to this method closes and releases resources. Subsequent calls shall take no

     * effect and return quitely. After the first call to this method any non query method (defined

     * as metadata retrieval methods in the class' javadoc) shall fail with an io exception.

     * </p>

     * 

     * @throws IOException if an I/O error occurs.

     */

    public void close() throws IOException;

    /**

     * Returns whether this stream writer and its underlying output source are open and able to

     * receive more write calls.

     * <p>

     * A {@code IXmlStreamWriter} should be open since its creation until {@link #close()} is

     * explicitly called by client code.

     * </p>

     * 

     * @return {@code true} if this stream is still open, {@code false} otherwise

     */

    public boolean isOpen();

    /**

     * Write any cached data to the underlying output mechanism.

     * 

     * @throws IOException

     */

    public void flush() throws IOException;

    /**

     * @pre {getLastEvent() == NONE}

     * @pre {namespaceUri != null AND schemaLocationUri != null}

     * @pre {namespaceUri != ""}

     * @param namespaceUri

     * @param schemaLocationUri

     */

    public void setSchemaLocation(String namespaceUri, String schemaLocationUri);

    /**

     * Initiates the encoding of an XML formatted document in the BXML encoding.

     * <p>

     * This should be the first non query method to call after a stream writer is created. The

     * implementation will use the call to this method to write down the document header and xml

     * declaration.

     * </p>

     * 

     * @pre {getLastEvent() == NONE}

     * @post {getLastEvent() == START_DOCUMENT}

     * @throws IOException

     */

    public void writeStartDocument() throws IOException;

    /**

     * Finishes up encoding a BXML document.

     * <p>

     * Implementations shall use this method to write down the document's trailer token.

     * </p>

     * 

     * @pre {getTagDeep() == 0}

     * @post {getLastEvent() == END_DOCUMENT}

     * @throws IOException

     */

    public void writeEndDocument() throws IOException;

    /**

     * @pre {namespaceUri != null}

     * @pre {localName != null}

     * @post {getLastEvent() == START_ELEMENT}

     * @param namespaceUri the namespace uri for the element

     * @param localName the elements non qualified (local) name

     * @throws IOException

     */

    public void writeStartElement(final String namespaceUri, final String localName)

            throws IOException;

    /**

     * @pre {qname != null}

     * @post {getLastEvent() == START_ELEMENT}

     * @param qname qualified element name. Only namespace and localName are relevant. Prefix, if

     *            present, is ignored. The currently mapped prefix for the namespace will be used in

     *            any case.

     * @throws IOException

     * @see #setPrefix(String, String)

     */

    public void writeStartElement(final IQName qname) throws IOException;

    /**

     * @pre {getTagDeep() > 0}

     * @pre { ( getLastEvent().isValue() AND getWrittenValueCount() == getValueLength() ) ||

     *      getLastEvent() IN ( START_ELEMENT, END_ELEMENT, ATTRIBUTES_END, COMMENT}

     * @post {getLastEvent() == END_ELEMENT}

     * @throws IOException

     */

    public void writeEndElement() throws IOException;

    /**

     * Starts writting an xml attribute.

     * <p>

     * Writting an attribute and its value is split in two parts. This method only stand for the

     * attribute declaration. Writting an attribute value is made after calling this method and is

     * optional. The attribute value can be done with any of the {@code writeValue} methods, even

     * using various {@code writeValue} calls for the same attribute.

     * </p>

     * <p>

     * After the last element attribute has been written, {@link #writeEndAttributes()} shall be

     * called to indicate the end of the attribute list.

     * </p>

     * Sample usage:

     * 

     * <pre>

     * <code>

     * <b>writer.startAttribute("", "att1");</b>

     * writer.writeValue("value1");

     * writer.writeValue(1);

     * writer.writeValue(2);

     * writer.writeValue(3);

     * <b>writer.startAttribute("", "att2");</b>

     * writer.writeValue(1.0L);

     * ...

     * writer.writeEndAttributes();

     * </code>

     * </pre>

     * 

     * @pre {getLastEvent() IN (START_ELEMENT, ATTRIBUTE) }

     * @pre {namespaceUri != null}

     * @pre {localName != null}

     * @post {getLastEvent() == ATTRIBUTE}

     * @param namespaceUri not null

     * @param localName not null

     * @throws IOException

     * @see #writeEndAttributes()

     */

    public void writeStartAttribute(final String namespaceUri, final String localName)

            throws IOException;

    /**

     * Starts writing an xml attribute for the given qualified name.

     * 

     * @pre {qname != null}

     * @param qname a QName where to get the namespace uri and local name for the attribute

     * @throws IOException

     * @see #writeStartAttribute(String, String)

     */

    public void writeStartAttribute(final IQName qname) throws IOException;

    /**

     * Indicates there are no more element attributes to encode for the current element.

     * <p>

     * This method is useful for the encoder to recognize (and write down the appropriate tokens)

     * the following potential call to some writeValue method corresponds to the element's contents

     * and not to the current attribute value.

     * </p>

     * Sample usage:

     * 

     * <pre>

     * <code>

     * writer.startElement("", "element");

     * writer.startAttribute("", "att1");

     * writer.writeValue("value1");

     * writer.startAttribute("", "att2");

     * writer.writeValue(1.0L);

     * ...

     * <b>writer.writeEndAttributes();</b>

     * writer.value("element value");

     * ...

     * </code>

     * </pre>

     * 

     * @pre {getLastTagEvent() == START_ELEMENT}

     * @post {getLastEvent() == ATTRIBUTES_END}

     * @throws IOException

     */

    public void writeEndAttributes() throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_STRING}

     * @post {getValueLength() == 1}

     * @post {getWrittenValueCount() == 1}

     * @param value

     * @throws IOException

     */

    public void writeValue(final String value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_STRING}

     * @param chars

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final char[] chars, final int offset, final int length)

            throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_INT}

     * @param value

     * @throws IOException

     */

    public void writeValue(final int value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_LONG}

     * @param value

     * @throws IOException

     */

    public void writeValue(final long value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_FLOAT}

     * @param value

     * @throws IOException

     */

    public void writeValue(final float value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_DOUBLE}

     * @param value

     * @throws IOException

     */

    public void writeValue(final double value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_BOOL}

     * @param value

     * @throws IOException

     */

    public void writeValue(final boolean value) throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_BOOL}

     * @param value

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final boolean[] value, final int offset, final int length)

            throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_INT}

     * @param value

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final int[] value, final int offset, final int length)

            throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_LONG}

     * @param value

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final long[] value, final int offset, final int length)

            throws IOException;

    /**

     * @pre {getLastEvent().isValue() == true || getLastEvent() IN (START_ELEMENT, ATTRIBUTE,

     *      COMMENT )}

     * @post {getLastEvent() == VALUE_FLOAT}

     * @param value

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final float[] value, final int offset, final int length)

            throws IOException;

    /**

     * Writes a value section defined by the

     * 

     * @pre {getLastEvent() IN ( START_ELEMENT START_ELEMENT, ATTRIBUTE ATTRIBUTE )}

     * @post {getLastEvent() == VALUE_DOUBLE}

     * @param value

     * @param offset

     * @param length

     * @throws IOException

     */

    public void writeValue(final double[] value, int offset, int length) throws IOException;

    /**

     * Writes a comments block

     * <p>

     * The provided {@code commentContent} is the coalesced value of the equivalent XML comment

     * block (enclosed between {@code <!--} and {@code -->} tags.

     * </p>

     * 

     * @post {getLastEvent() == COMMENT}

     * @param commentContent the coallesced value of the comment section

     * @throws IOException

     */

    public void writeComment(String commentContent) throws IOException;

    /**

     * @pre {valueType != null}

     * @pre {valueType.isValue() == true}

     * @pre {valueType != VALUE_STRING}

     * @pre {arrayLength >= 0}

     * @post {getLastEvent() == valueType}

     * @post {getWrittenValueCount() == 0}

     * @post {getValueLength() == arrayLength}

     * @param valueType

     * @param arrayLength

     * @throws IOException

     */

    public void startArray(EventType valueType, int arrayLength) throws IOException;

    /**

     * Needs to be called when done with startArray

     * 

     * @pre {getWrittenValueCount() == getValueLength()}

     * @throws IOException

     */

    public void endArray() throws IOException;

    /**

     * Binds a URI to the default namespace for the current context.

     * <p>

     * This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this

     * method is called before a START_ELEMENT has been written the uri is bound in the root scope.

     * </p>

     * 

     * @pre {getLastEvent() == NONE || getLastEvent() == START_ELEMENT}

     * @param defaultNamespaceUri the uri to bind to the default namespace, may be {@code null}

     * @throws XmlStreamException 

     */

    public void setDefaultNamespace(String defaultNamespaceUri) throws XmlStreamException;

    /**

     * Sets the prefix the uri is bound to, for the current context.

     * <p>

     * This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair (current

     * context). If this method is called before a START_ELEMENT has been written the prefix is

     * bound in the root scope.

     * </p>

     * 

     * @pre {getLastEvent() == NONE || getLastEvent() == START_ELEMENT}

     * @param prefix

     * @param namespaceUri

     * @throws XmlStreamException 

     */

    public void setPrefix(final String prefix, final String namespaceUri) throws XmlStreamException;

    /**

     * @pre {getLastEvent().isValue() == true}

     * @post {$return >= 0}

     * @return the length of the current value being written.

     */

    public long getValueLength();

    /**

     * @pre {getLastEvent().isValue() == true}

     * @post {$return >= 0}

     * @post {$return <= getValueLength()}

     * @return how many elements has already being written for the current value

     */

    public long getWrittenValueCount();

}

/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 9638 62 495

 *      gvsig@gva.es

 *      www.gvsig.gva.es

 */

package org.gvsig.xmlpull.lib.api.stream;

/**

 * The EventType enum defines the possible parse events a {@link IXmlStreamReader} may return during

 * each call to {@code next()}.

 * <p>

 * These are high level events and may not map one to one to the low level Binary XML format tokens.

 * This is so to better reflect the problem domain for this high level API, letting the low level

 * treatment of specific bxml tokens to the implementation criteria.

 * </p>

 * <p>

 * In general lines, it could be said that the following EventType to TokenType mappings are

 * defined: <table>

 * <tr>

 * <th>EventType</th>

 * <th>TokenType</th>

 * </tr>

 * <tr>

 * <td>NONE</td>

 * <td>Header</td>

 * </tr>

 * <tr>

 * <td>START_DOCUMENT</td>

 * <td>XmlDeclaration, if present, forced otherwise in order to always return a START_DOCUMENT

 * event</td>

 * </tr>

 * <tr>

 * <td>END_DOCUMENT</td>

 * <td>Trailer</td>

 * </tr>

 * <tr>

 * <td>START_ELEMENT</td>

 * <td>EmptyElement, EmptyAttrElement, ContentElement, ContentAttrElement</td>

 * </tr>

 * <tr>

 * <td>END_ELEMENT</td>

 * <td>ElementEnd, or forced when EmptyElement or EmptyAttrElement</td>

 * </tr>

 * <tr>

 * <td>ATTRIBUTE</td>

 * <td>AttributeStart, only used for writing</td>

 * </tr>

 * <tr>

 * <td>ATTRIBUTES_END</td>

 * <td>AttributeListEnd, only used for writing</td>

 * </tr>

 * <tr>

 * <td>COMMENT</td>

 * <td>Comment</td>

 * </tr>

 * <tr>

 * <td>SPACE</td>

 * <td>WhiteSpace</td>

 * </tr>

 * <tr>

 * <td>VALUE_STRING, VALUE_BOOL, VALUE_BYTE, VALUE_INT, VALUE_LONG, VALUE_FLOAT, VALUE_DOUBLE</td>

 * <td>CharContent token, followed by the specific value type</td>

 * </tr>

 * </table>

 * </p>

 * 

 * @author Gabriel Roldan (TOPP)

 * @version $Id: EventType.java 21945 2008-06-30 14:04:53Z jpiera $

 * @since 1.0

 */

public final class EventType {

    private boolean isValueEvent;

    private int code;

    /**

     * Private default constructor inforces the use of this class by its public static members only

     */

    private EventType(final int code) {

        this(code, false);

    }

    private EventType(final int code, boolean isValue) {

        this.code = code;

        this.isValueEvent = isValue;

    }

    public static final int NONE_CODE = 0;

    /**

     * Null object to indicate either a document has not started being parsed yet, or a document has

     * not started being written yet.

     */

    public static final EventType NONE = new EventType(NONE_CODE);

    public static final int START_DOCUMENT_CODE = 1;

    /**

     * Indicates the parser is positioned at the start of the document. The next call to

     * {@link IXmlStreamReader#next()} shall return either {@link #START_ELEMENT}, {@link #COMMENT}

     * or {@link #END_DOCUMENT} if the document is empty.

     */

    public static final EventType START_DOCUMENT = new EventType(START_DOCUMENT_CODE);

    public static final int END_DOCUMENT_CODE = 2;

    /**

     * Indicates the parser has reached the end of the bxml document

     */

    public static final EventType END_DOCUMENT = new EventType(END_DOCUMENT_CODE);

    public static final int START_ELEMENT_CODE = 3;

    /**

     * Signals the opening of an element tag.

     */

    public static final EventType START_ELEMENT = new EventType(START_ELEMENT_CODE);

    public static final int END_ELEMENT_CODE = 4;

    /**

     * Signals the end of the current element. No content elements such as {@code <element/>} and

     * {@code <element att="attval"/>} will be notified by an START_ELEMENT and END_ELEMENT event

     * with no value event in between, to preserve semantic equivalence with the

     * {@code <element></element>} tag sequence.

     */

    public static final EventType END_ELEMENT = new EventType(END_ELEMENT_CODE);

    public static final int VALUE_BOOL_CODE = 5;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * boolean or an array of booleans.

     */

    public static final EventType VALUE_BOOL = new EventType(VALUE_BOOL_CODE, true);

    public static final int VALUE_BYTE_CODE = 6;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * byte or an array of bytes.

     */

    public static final EventType VALUE_BYTE = new EventType(VALUE_BYTE_CODE, true);

    public static final int VALUE_INT_CODE = 7;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * integer or an array of integers. For the sake of simplicity, the low level {@code SmallNum},

     * {@code Short}, {@code UShort}, and {@code Int} value types are mapped to this event type.

     */

    public static final EventType VALUE_INT = new EventType(VALUE_INT_CODE, true);

    public static final int VALUE_LONG_CODE = 8;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * long or an array of longs.

     */

    public static final EventType VALUE_LONG = new EventType(VALUE_LONG_CODE, true);

    public static final int VALUE_FLOAT_CODE = 9;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * float or an array of floats.

     */

    public static final EventType VALUE_FLOAT = new EventType(VALUE_FLOAT_CODE, true);

    public static final int VALUE_DOUBLE_CODE = 10;

    /**

     * Content event that indicates the parser is at a value token whose content is either a Java

     * double or an array of double.

     */

    public static final EventType VALUE_DOUBLE = new EventType(VALUE_DOUBLE_CODE, true);

    public static final int VALUE_STRING_CODE = 11;

    /**

     * Content event that indicates the parser is at a value token whose content is a Java String.

     * There are no such a structure as an array of Strings in the BXML spec.

     */

    public static final EventType VALUE_STRING = new EventType(VALUE_STRING_CODE, true);

    public static final int VALUE_CDATA_CODE = 12;

    /**

     * This is event equivalent to the {@code "<![CDATA[content]]>"} structure in textual XML,

     * signaled by the CDataSectionToken. This token is essentially equivalent to the

     * CharContentToken, except that its use may be regarded as a hint to a translator to regenerate

     * a CDATA section in textual XML.

     */

    public static final EventType VALUE_CDATA = new EventType(VALUE_CDATA_CODE, true);

    public static final int VALUE_SPACE_CODE = 13;

    /**

     * Content event that signals the precense of a WhiteSpace token. That is, a potentially

     * insignificant sequence of white space or newline characters

     */

    public static final EventType SPACE = new EventType(VALUE_SPACE_CODE, true);

    public static final int COMMENT_CODE = 14;

    /**

     * Indicates the parser is at a XML comment token

     */

    public static final EventType COMMENT = new EventType(COMMENT_CODE);

    public static final int ATTRIBUTE_CODE = 15;

    /**

     * Used only for writing attributes.

     * 

     * @see IXmlStreamWriter#writeStartAttribute(String, String)

     */

    public static final EventType ATTRIBUTE = new EventType(ATTRIBUTE_CODE);

    public static final int ATTRIBUTES_END_CODE = 16;

    /**

     * Used only for writing attributes.

     * 

     * @see IXmlStreamWriter#writeEndAttributes()

     */

    public static final EventType ATTRIBUTES_END = new EventType(ATTRIBUTES_END_CODE);

    public int getCode() {

        return code;

    }

    /**

     * Convenience method that returns whether this EventType represents a value token

     * 

     * @return {@code true} if {@code eventType} is one of

     *         {@code VALUE_BOOL, VALUE_BYTE, VALUE_INT, VALUE_LONG, VALUE_FLOAT, VALUE_DOUBLE,

     *         VALUE_STRING, VALUE_CDATA, SPACE}

     */

    public boolean isValue() {

        return isValueEvent;

    }

    /**

     * Convenience method that returns whether this EventType represents a tag element

     * 

     * @return {@code true} if {@code eventType} is one of {@code START_ELEMENT, END_ELEMENT}

     */

    public boolean isTag() {

        return START_ELEMENT == this || END_ELEMENT == this;

    }

}

/* gvSIG. Sistem a de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 9638 62 495

 *      gvsig@gva.es

 *      www.gvsig.gva.es

 */

package org.gvsig.xmlpull.lib.api.stream;

/**

 * Plain wrapper for an {@link IXmlStreamReader} aimed at easying the creation of IXmlStreamReader

 * decorators.

 * <p>

 * This class is a pure abstract wrapper, so all methods delegate to the wrapped object.

 * </p>

 * 

 * @author Gabriel Roldan (TOPP)

 * @version $Id: AbstractXmlStreamReaderWrapper.java 20425 2008-05-05 14:24:58Z groldan $

 */

public abstract class AbstractXmlStreamReaderWrapper implements IXmlStreamReader {

    private IXmlStreamReader wrapped;

    protected AbstractXmlStreamReaderWrapper() {

        // do nothing

    }

    protected AbstractXmlStreamReaderWrapper(IXmlStreamReader wrapped) {

        setWrapped(wrapped);

    }

    public void setWrapped(IXmlStreamReader wrapped) {

        this.wrapped = wrapped;

    }

    /**