Application: gvSIG desktop » gvSIG data provider for GPE

<project name="org.gvsig.initial.build" default="prepare-workspace">

	<dirname property="org.gvsig.initial.build.basedir" file="${ant.file.org.gvsig.initial.build}" />

	<property name="workspace.basedir" value="${org.gvsig.initial.build.basedir}/.." />

	<property name="build.basedir" value="${workspace.basedir}/org.gvsig.maven.base.build" description="Eclipse workspace location" />

	<property name="build.jar.version" value="1.0.8-SNAPSHOT" />

	<property name="build.jar.file" value="org.gvsig.maven.base.build-${build.jar.version}.jar" />

	<property name="ant.libs.dir" location="${build.basedir}" description="Additional ant tasks libs folder" />

	<target name="check-maven-base-build-available">

		<available file="${user.home}/.m2/repository/org/gvsig/org.gvsig.maven.base.build/${build.jar.version}/${build.jar.file}" property="maven-base-build-available" />

	</target>

	<target name="get-maven-base-build-local" depends="check-maven-base-build-available" if="maven-base-build-available">

		<!-- Unzip de build jar file from the maven repository into the workspace root folder -->

		<copy todir="${workspace.basedir}" preservelastmodified="false" filtering="false">

			<zipfileset src="${user.home}/.m2/repository/org/gvsig/org.gvsig.maven.base.build/${build.jar.version}/${build.jar.file}">

				<patternset>

					<exclude name="META-INF/**" />

				</patternset>

			</zipfileset>

		</copy>

	</target>

	<target name="get-maven-base-build-remote" depends="check-maven-base-build-available" unless="maven-base-build-available">

		<mkdir dir="target" />

		<!-- Download the build jar file -->

		<get src="http://devel.gvsig.org/m2repo/j2se/org/gvsig/org.gvsig.maven.base.build/${build.jar.version}/${build.jar.file}" dest="target/${build.jar.file}" verbose="true" />

		<!-- Unzip de build jar file into the workspace root folder -->

		<copy todir="${workspace.basedir}" preservelastmodified="false" filtering="false">

			<zipfileset src="target/${build.jar.file}">

				<patternset>

					<exclude name="META-INF/**" />

				</patternset>

			</zipfileset>

		</copy>

	</target>

	<target name="find.depends.natives.file">

	    <condition property="depends.natives.file.exists">

            <available file="${org.gvsig.initial.build.basedir}/DEPENDS_ON_NATIVE_LIBRARIES"/>

	    </condition>	

	</target>

	<target name="find.gvsig.platform.properties.file" 

			depends="find.depends.natives.file"

			if="depends.natives.file.exists">

	    <condition property="gvsig.platform.exists">

            <available file="${user.home}/.gvsig.platform.properties"/>

	    </condition>	

	</target>

	<target name="check.gvsig.platform.properties" 

			depends="find.gvsig.platform.properties.file">

		<fail if="depends.natives.file.exists" unless="gvsig.platform.exists">

ERROR!!

You have to define your gvSIG platform properties, 

by creating the file: ${user.home}/.gvsig.platform.properties

with the following content:

native_platform=linux

native_distribution=all

native_compiler=gcc4

native_arch=i386

native_libraryType=dynamic

export native_classifier=${native_platform}-${native_distribution}-${native_compiler}-${native_arch}-${native_libraryType}

Replace the fifth initial variables values with the ones appropiate 

to your platform.

If you use maven in the command line, you can use the previous file also

to define the MAVEN_OPTS environment variable, by adding to your 

.bash_rc file something like this:

if [ -f "${HOME}/.gvsig.platform.properties" ]

then

    . ${HOME}/.gvsig.platform.properties

    export MAVEN_OPTS="-Xmx256M -XX:MaxPermSize=64m -Dnative-classifier=${native_classifier}"

else

    export MAVEN_OPTS="-Xmx256M -XX:MaxPermSize=64m"

fi

It will work if you use the bash shell. In any other case or platform, you'll

have to define your MAVEN_OPTS environment variable and set the 

"native-classifier" parameter directly.

		</fail>			

	</target>

	<target name="prepare-workspace" depends="get-maven-base-build-local,get-maven-base-build-remote,check.gvsig.platform.properties">

		<mkdir dir="target" />

		<chmod dir="${build.basedir}/maven/bin" perm="u+x" includes="m2,mvn,mvnDebug" />

		<!-- Copy the maven launchers to the workspace metadata folder -->

		<copy todir="${workspace.basedir}/.metadata">

			<fileset dir="${build.basedir}/eclipse-launchers">

				<exclude name="**/org.eclipse.jdt.core.prefs" />

				<exclude name="**/org.eclipse.core.variables.prefs" />

			</fileset>

		</copy>

		<concat destfile="${workspace.basedir}/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.core.prefs" append="true">

			<filelist dir="${build.basedir}/eclipse-launchers/.plugins/org.eclipse.core.runtime/.settings" files="org.eclipse.jdt.core.prefs" />

		</concat>

		<concat destfile="${workspace.basedir}/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.core.variables.prefs" append="true">

			<filelist dir="${build.basedir}/eclipse-launchers/.plugins/org.eclipse.core.runtime/.settings" files="org.eclipse.core.variables.prefs" />

		</concat>

		<!-- Configure the eclipse workspace -->

		<ant antfile="${build.basedir}/maven-goals.xml" target="mvn-configure-eclipse-workspace" />

		<!-- Configure the gvSIG profile -->

		<ant antfile="${build.basedir}/check-gvsig-profile.xml" />

		<property name="user-settings-file-location" value="${user.home}/.m2/settings.xml" />

		<taskdef name="xmltask" classname="com.oopsconsultancy.xmltask.ant.XmlTask">

			<classpath>

				<pathelement location="${ant.libs.dir}/com.oopsconsultancy.xmltask-1.16.1.jar" />

			</classpath>

		</taskdef>

		<xmltask source="${user-settings-file-location}" dest="${user-settings-file-location}">

			<copy path="//:settings/:profiles/:profile[:id/text() = 'gvsig-install']/:properties/:gvsig.install.dir/text()" property="current-gvsig-location" />

		</xmltask>

		<replace file="${workspace.basedir}/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.jdt.core.prefs" token="@GVSIG_HOME@" value="${current-gvsig-location}" />

		<replace file="${workspace.basedir}/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.core.variables.prefs" token="@GVSIG_HOME@" value="${current-gvsig-location}" />

		<!-- Compile, install and generate eclipse projects -->

		<ant antfile="${build.basedir}/maven-goals.xml" target="mvn-install-and-eclipse-eclipse" />

		<echo>INFORMATION!!!</echo>

		<echo>Restart eclipse and then proceed to import the subprojects contained into the main project</echo>

		<!-- TODO: copiar al proyecto de configuración general -->

	</target>

	<target name="clean">

		<delete dir="target" />

	</target>

</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.gpe</artifactId>

	<packaging>pom</packaging>

	<version>2.1.0</version>

	<name>org.gvsig.gpe</name>

	<description>Generic Persistence Engine</description>

	<url>http://devel.gvsig.org/sites/org.gvsig.gpe/${project.version}</url>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.maven.base.pom</artifactId>

		<version>1.0.9</version>

	</parent>

    <scm>

        <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-gpe/org.gvsig.gpe/library/tags/2.1.0</connection>

        <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-gpe/org.gvsig.gpe/library/tags/2.1.0</developerConnection>

        <url>https://devel.gvsig.org/redmine/projects/gvsig-gpe/repository/show/org.gvsig.gpe/library/tags/2.1.0</url>

    </scm>

	<distributionManagement>

		<site>

			<id>gvsig-repository</id>

            <url>dav:https://devel.gvsig.org/sites/org.gvsig.gpe/${project.version}</url>

		</site>

	</distributionManagement>

	<repositories>

		<repository>

			<id>gvsig-public-http-repository</id>

			<name>gvSIG maven public HTTP repository</name>

			<url>http://devel.gvsig.org/m2repo/j2se</url>

			<releases>

				<enabled>true</enabled>

				<updatePolicy>daily</updatePolicy>

				<checksumPolicy>warn</checksumPolicy>

			</releases>

			<snapshots>

				<enabled>true</enabled>

				<updatePolicy>daily</updatePolicy>

				<checksumPolicy>warn</checksumPolicy>

			</snapshots>

		</repository>

	</repositories>

	<build>

		<plugins>

			<plugin>

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

				<artifactId>maven-release-plugin</artifactId>

				<configuration>

					<tagBase>https://devel.gvsig.org/svn/gvsig-gpe/org.gvsig.gpe/library/tags</tagBase>

				</configuration>

			</plugin>

		</plugins>

	</build>

	<dependencyManagement>

		<dependencies>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>3.0.0</version>

				<scope>compile</scope>

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>3.0.0</version>

				<classifier>tests</classifier>

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.i18n</artifactId>

				<version>2.0</version>

				<scope>compile</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.compat</artifactId>

				<version>2.0</version>

				<scope>compile</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.compat</artifactId>

				<classifier>se</classifier>

				<version>2.0</version>

				<scope>runtime</scope>				

			</dependency>

			<!--

			<dependency>

				<groupId>org.gvsig.mobile</groupId>

				<artifactId>org.gvsig.mobile.compat</artifactId>

				<version>2.0-SNAPSHOT</version>

				<scope>runtime</scope>				

			</dependency>

			-->

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>compile</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>runtime</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>runtime</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>runtime</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>runtime</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>compile</scope>				

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

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

				<version>2.0.0</version>

				<scope>runtime</scope>				

			</dependency>

			<dependency>

				<groupId>stax</groupId>

				<artifactId>stax-api</artifactId>

				<version>1.0.1</version>

				<scope>compile</scope>				

			</dependency>

			<dependency>

				<groupId>stax</groupId>

				<artifactId>stax</artifactId>

				<version>1.2.0</version>

				<scope>compile</scope>				

			</dependency>

		</dependencies>

	</dependencyManagement>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

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

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

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

			<classifier>tests</classifier>

			<scope>test</scope>

		</dependency>

	</dependencies>

	<modules>

		<module>org.gvsig.gpe.lib</module>

		<module>org.gvsig.gpe.prov</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):

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

*/

package org.gvsig.gpe.lib.api;

import java.io.File;

import java.net.URI;

import java.util.Iterator;

import org.gvsig.gpe.lib.api.exceptions.ParserCreationException;

import org.gvsig.gpe.lib.api.exceptions.WriterHandlerCreationException;

import org.gvsig.gpe.lib.api.parser.IGPEContentHandler;

import org.gvsig.gpe.lib.api.parser.IGPEContentHandlerInmGeom;

import org.gvsig.gpe.lib.api.parser.IGPEErrorHandler;

import org.gvsig.gpe.lib.api.writer.IGPEWriterHandler;

/**

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

 */

public interface GPEManager {

    /**

     * Return true if exists a driver that can open the file

     * @param uri

     * File to open

     * @return

     * true if the driver exists

     */

    public boolean accept(URI uri);

    /**

	 * Method to parse a file. It cannot to throw 

	 * any exception and it cannot to return any value.

	 * In a future it could be implemented like a independent

	 * thread

	 * @param contents

	 * Application ContentHandler

	 * @param errors

	 * Application ErrorsHandler

	 * @param uri

	 * File to open

	 * @throws ParserCreationException 

	 * @throws Exception

	 */

	public void parse(IGPEContentHandler contents, IGPEErrorHandler errors, URI uri) throws ParserCreationException;

	/**

	 * Method to parse a file. It cannot to throw 

	 * any exception and it cannot to return any value.

	 * In a future it could be implemented like a independent

	 * thread

	 * @param contents

	 * Application ContentHandler

	 * @param errors

	 * Application ErrorsHandler

	 * @param file

	 * File to open

	 * @throws ParserCreationException 

	 * @throws Exception

	 */

	public void parse(IGPEContentHandler contents, IGPEErrorHandler errors, File file) throws ParserCreationException;

	 /**

	 * Method to parse a file. It cannot to throw 

	 * any exception and it cannot to return any value.

	 * In a future it could be implemented like a independent

	 * thread

	 * @param contents

	 * Application ContentHandler

	 * @param errors

	 * Application ErrorsHandler

	 * @param uri

	 * File to open

	 * @throws ParserCreationException 

	 * @throws Exception

	 */

	public void parse(IGPEContentHandlerInmGeom contents, IGPEErrorHandler errors, URI uri) throws ParserCreationException;

	/**

	 * Method to parse a file. It cannot to throw 

	 * any exception and it cannot to return any value.

	 * In a future it could be implemented like a independent

	 * thread

	 * @param contents

	 * Application ContentHandler

	 * @param errors

	 * Application ErrorsHandler

	 * @param file

	 * File to open

	 * @throws ParserCreationException 

	 * @throws Exception

	 */

	public void parse(IGPEContentHandlerInmGeom contents, IGPEErrorHandler errors, File file) throws ParserCreationException;

	/**

	 * Create a new content writer from a name

	 * @param name

	 * GPEWriterHandler name

	 * GPEParser name

	 * @param contenHandler

	 * Application contenHandler usett to throw the parsing events

	 * @param errorHandler

	 * Application errror handler used to put errors and warnings

	 * @throws GPEWriterHandlerCreationException 	

	 */

	public IGPEWriterHandler createWriter(String name) throws WriterHandlerCreationException;

	/**

	 * Create a new writer from a class name. This method can be used 

	 * if the class name is known but, the common method to get a writer

	 * is using the mime type.     * 

	 * @param prefferredImplClassName

	 * The name of the class that implements {@link GPEWriterHandler}

	 * @return

	 * A writer for a concrete format.

	 * @throws WriterHandlerCreationException

	 * If it is not possible to create a writer

	 */

	public IGPEWriterHandler createWriterByClass(String prefferredImplClassName) throws WriterHandlerCreationException; 

	/**

	 * Create a new writer from a mime type. Each writer has a method

	 * named {@link GPEWriterHandler#getFormat()} that returns the mimetype

	 * that the writer can write. One writer only supports one mimetype.

	 * <p>

	 * This method retrieve all the writers and returns the first

	 * one that is able to write the mimetype. If there are more

	 * writer that can write the format will not be used.

	 * </p>

	 * @param mimeType

	 * The mimetype of the file to write

	 * @return

	 * A writer that can write the mimetype.

	 * @throws WriterHandlerCreationException

	 * If it is not possible to create a writer

	 * @see 

	 * <a href="http://www.iana.org/assignments/media-types/">http://www.iana.org/assignments/media-types/</a>

	 */

	public IGPEWriterHandler createWriterByMimeType(String mimeType) throws WriterHandlerCreationException;

	/**

	 * Returns an iterator with the name of all the properties that 

	 * has been established.

	 */

	public Iterator getKeys();

	/**

	 * Gets a String property

	 * @param key

	 * Property name

	 * @return

	 */

	public String getStringProperty(String key);

	/**

	 * Gets a int property

	 * @param key

	 * Property name

	 * @return

	 * The int property or -1

	 */

	public int getIntPropertyProperty(String key);

	/**

	 * Gets a boolean property. If the property doesn't exist

	 * it returns false.

	 * @param key

	 * Property name

	 * @return

	 * The boolean property or false

	 */

	public boolean getBooleanProperty(String key);

	/**

	 * Gets a property

	 * @param key

	 * Property name

	 * @return

	 */

	public Object getProperty(String key);

	/**

	 * Sets a property

	 * @param key

	 * @param value

	 */

	public void setProperty(String key, Object value);

}

/* 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):

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

*/

package org.gvsig.gpe.lib.api;

/**

 * This class contains the generic properties for all the 

 * GPE parsers and writers. 

 */

public class GPEProperties {

	public static final String DECIMAL_DIGITS = "decimalDigits";

}

package org.gvsig.gpe.lib.api.parser;

/* 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

 */

/* CVS MESSAGES:

 *

 * $Id: IGPEErrorHandler.java 153 2007-06-20 09:35:37Z jorpiell $

 * $Log$

 * Revision 1.4  2007/06/20 09:35:37  jorpiell

 * Add the javadoc comments

 *

 * Revision 1.3  2007/04/19 07:23:20  jorpiell

 * Add the add methods to teh contenhandler and change the register mode

 *

 * Revision 1.2  2007/04/12 17:06:42  jorpiell

 * First GML writing tests

 *

 * Revision 1.1  2007/04/11 08:46:21  csanchez

 * Actualizacion protoripo libGPE

 *

 *

 */

/**

 * This interface defines the GPE error handler. It has methods

 * to register the errors and the warnings that can happen

 * wherear a parser is reading or writing a file. 

 * @author Jorge Piera Llodr? (jorge.piera@iver.es)

 * @author Carlos S?nchez Peri??n (sanchez_carper@gva.es)

 */

public interface IGPEErrorHandler {

	/**

	 * This method is invoked when a parser has found

	 * an error that has to stop the reading or the writing 

	 * process

	 * @param e

	 * The detected exception

	 */

	public void addError(Throwable e);

	public int getErrorsSize();

	public Throwable getErrorAt(int i);

	/**

	 * This method is invoke when a parser has detected a

	 * error, but it is able to manage it by itself

	 * @param e

	 * The detected exception

	 */

	public void addWarning(Throwable e);

	public int getWarningsSize();

	public Throwable getWarningAt(int i);

}

package org.gvsig.gpe.lib.api.parser;

/* 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

*/

/* CVS MESSAGES:

*

* $Id: IGPEContentHandler.java 202 2007-11-27 12:00:11Z jpiera $

* $Log$

* Revision 1.18  2007/06/20 09:35:37  jorpiell

* Add the javadoc comments

*

* Revision 1.17  2007/06/19 10:34:51  jorpiell

* Add some comments and creates a warning when an operation is not supported

*

*

*/

/**

 * This interface defines the "contract" between the consumer

 * application and libGPE. It has methods that will be invoke

 * by the parser every time that an event happens

 * @author Jorge Piera Llodr? (jorge.piera@iver.es)

 * @author Carlos S?nchez Peri??n (sanchez_carper@gva.es)

 */

public interface IGPEContentHandler extends IGPEContentHandlerSFP0{

	/**

	 * This method is thrown when the parser find a new 

	 * bounding box.

	 * @param id

	 * Bounding box identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * The consumer application object that represents

	 *  a bounding box

	 */

	public Object startBbox(String id, ICoordinateIterator coords, String srs);

	/**

	 * This method indicates that the parser thas finished to

	 * parse the bounding box.

	 * @param bbox

	 * The consumer application object that represents a

	 * bounding box

	 */

	public void endBbox(Object bbox);

	/**

	 * It is thrown every time that a new layer is detected.

	 * @param id

	 * Layer identifier

	 * @param namespace

	 * XML namespace

	 * @param name

	 * Layer name

	 * @param description

	 * Layer description

	 * @param srs

	 * Layer spatial reference system

	 * @param attributes

	 * Layer attributes

	 * @param parentLayer

	 * Layer that contains it

	 * @param bBox

	 * Layer bounding box

	 * @return

	 * The consumer application object that represents a layer

	 */

	public Object startLayer(String id,  String namespace, String name, String description, 

			String srs, IAttributesIterator attributes, Object parentLayer, Object bBox);

	/**

	 * It is thrown when a layer has been finished to parse.

	 * @param layer

	 * The consumer application object that represents a layer

	 */

	public void endLayer(Object layer);

	/**

	 * It adds a name to one layer that has been previously 

	 * created using the startLayer method.

	 * @param name

	 * Layer name

	 * @param layer

	 * The consumer application object that represents a layer

	 */

	public void addNameToLayer(String name, Object layer);

	/**

	 * It adds the description to one layer that has been previously 

	 * created using the startLayer method.

	 * @param description

	 * Layer description

	 * @param layer

	 * The consumer application object that represents a layer

	 */

	public void addDescriptionToLayer(String description, Object layer);

	/**

	 * It adds a spatial reference system to one layer that 

	 * has been previously created using the startLayer method.

	 * @param srs

	 * Spatial reference system

	 * @param layer

	 * The consumer application object that represents a layer

	 */

	public void addSrsToLayer(String srs, Object Layer);

	/**

	 * It establish the relationship parent-child between two layers

	 * that have been previously created using the startLayer method.

	 * @param parent

	 * The consumer application object that represents the parent layer

	 * @param layer

	 * The consumer application object that represents the child layer

	 */

	public void addParentLayerToLayer(Object parent, Object layer);

	/**

	 * It adds a bounding box to one layer that  has been previously 

	 * created using the startLayer method.

	 * @param bbox

	 * Layer bounding box

	 * @param layer

	 * The consumer application object that represents a layer

	 */

	public void addBboxToLayer(Object bbox, Object layer);

	/**

	 * It is thrown when the parser has found a new feature.

	 * @param id

	 * Feature identifier

	 * @param name

	 * Feature name

	 * @param namespace

	 * XML namespace

	 * @param attributes

	 * Feature attributes

	 * @param layer

	 * Consumer application object that represents a layer

	 * @return

	 * Consumer application object that represents a feature

	 */

	public Object startFeature(String id, String namespace, String name, IAttributesIterator attributes, Object layer);

	/**

	 * This method is thrown when the parser has finished to

	 * parse a feature.

	 * @param feature

	 * Consumer application object that represents a feature

	 */

	public void endFeature(Object feature);

	/**

	 * This method adds a name to one layer that has been

	 * previously created using the startFeature method. 

	 * @param name

	 * Feature name

	 * @param feature

     * Consumer application object that represents a feature

	 */

	public void addNameToFeature(String name, Object feature);	

	/**

	 * This method adds a feature to one layer that has been 

	 * previously created using the startLayer method. 

	 * @param feature

	 * Consumer application object that represents a feature

	 * @param layer

	 * Consumer application object that represents a layer

	 */

	public void addFeatureToLayer(Object feature, Object layer);

	/**

	 * It is thrown when the parser has found a new element

	 * @param namespace

	 * XML namespace

	 * @param name

	 * Element name

	 * @param value

	 * Element value

	 * @param attributes

	 * Element attributes

	 * @param parentElement

	 * The parent of this element (if exists)

	 * @return

	 * Consumer application object that represents an element 

	 */

	public Object startElement(String namespace, String name, Object value,

			IAttributesIterator attributes, Object parentElement);

	/**

	 * This method is thrown when the parser find the end 

	 * of an element.

	 * @param element

	 * Consumer application object that represents an element 

	 */

	public void endElement(Object element);

	/**

	 * It is thrown to establish a relationship parent-child

	 * between two elements.

	 * @param parent

	 * Consumer application object that represents the parent element 

	 * @param element

	 * Consumer application object that represents the child element 

	 */

	public void addParentElementToElement(Object parent, Object element);

	/**

	 * This method adds an element to one feature that has been 

	 * previously created using the startFeature method

	 * @param element

	 * Consumer application object that represents an element 

	 * @param feature

	 * Consumer application object that represents the feature 

	 */

	public void addElementToFeature(Object element, Object feature);

	/**

	 * This method indicates that the parser has found a point. 

	 * @param id

	 * Point identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a point 

	 */

	public Object startPoint(String id, ICoordinateIterator coords, String srs);

	/**

	 * It is thrown when the point has been completely parsed.

	 * @param point

	 * Consumer application object that represents a point 

	 */

	public void endPoint(Object point);

	/**

	 * This method indicates that the parser has found a lineString. 

	 * @param id

	 * LineString identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a lineString 

	 */

	public Object startLineString( String id, ICoordinateIterator coords, String srs);

	/**

     * It is thrown when the lineString has been completely parsed.

	 * @param lineString

	 * Consumer application object that represents a lineString 

	 */

	public void endLineString(Object lineString);

	/**

	 * This method indicates that the parser has found a linearRing. 

	 * @param id

	 * LinearRing identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a linarRing 

	 */

	public Object startLinearRing(String id, ICoordinateIterator coords, String srs);

	/**

	 * It is thrown when the linearRing has been completely parsed.

	 * @param linearRing

	 * Consumer application object that represents a linearRing 

	 */

	public void endLinearRing(Object linearRing);

	/**

	 * This method indicates that the parser has found a polygon. 

	 * @param id

	 * Polygon identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a polygon 

	 */

	public Object startPolygon(String id, ICoordinateIterator coords, String srs);

	/**

	 * It is thrown when the polygon has been completely parsed.

	 * @param polygon

	 * Consumer application object that represents a polygon 

	 */

	public void endPolygon(Object polygon);	

	/**

	 * This method associates a innerPolygon with its polygon

	 * @param innerPolygon

     * Consumer application object that represents a innerPolygon 

	 * @param Polygon

	 * Consumer application object that represents a polygon 

	 */

	public void addInnerPolygonToPolygon(Object innerPolygon, Object Polygon);

	/**

	 * This method indicates that the parser has found a InnerPolygon. 

	 * @param id

	 * InnerPolygon identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a innerPolygon 

	 */

	public Object startInnerPolygon(String id, ICoordinateIterator coords, String srs);

	/**

	 * It is thrown when the innerPolygon has been completely parsed.

	 * @param innerPolygon

	 * Consumer application object that represents a innerPolygon 

	 */

	public void endInnerPolygon(Object innerPolygon);

	/**

	 * This method indicates that the parser has found a multipoint. 

	 * @param id

	 * MultiPoint identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a multiPoint 

	 */

	public Object startMultiPoint(String id, String srs);

	/**

	 * It is thrown when the multiPoint has been completely parsed

	 * @param multiPoint

	 * Consumer application object that represents a multiPoint

	 */

	public void endMultiPoint(Object multiPoint);

	/**

	 * It is thrown to add a point to one multiPoint.

	 * @param point

     * Consumer application object that represents a point

	 * @param multiPoint

	 * Consumer application object that represents a multiPoint

	 */

	public void addPointToMultiPoint(Object point,Object multiPoint);

	/**

	 * This method indicates that the parser has found a multiLineString. 

	 * @param id

	 * MultiLineString identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a multiLineString 

	 */

	public Object startMultiLineString(String id, String srs);

	/**

	 * It is thrown when the multiLineString has been completely parsed

	 * @param multiLineString

	 * Consumer application object that represents a multiLineString

	 */

	public void endMultiLineString(Object multiLineString);	

	/**

	 * It is thrown to add a lineString to one lineString.

	 * @param lineString

     * Consumer application object that represents a lineString

	 * @param multiLineString

	 * Consumer application object that represents a multiLineString

	 */

	public void addLineStringToMultiLineString(Object lineString,Object multiLineString);

	/**

	 * This method indicates that the parser has found a multiPolygon. 

	 * @param id

	 * MultiPolygon identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a multiPolygon 

	 */

	public Object startMultiPolygon(String id, String srs);

	/**

	 * It is thrown when the multiPolygon has been completely parsed

	 * @param multiPolygon

	 * Consumer application object that represents a multiPolygon

	 */

	public void endMultiPolygon(Object multiPolygon);

	/**

	 * It is thrown to add a polygon to one multiPolygon.

	 * @param polygon

     * Consumer application object that represents a polygon

	 * @param multiPolygon

	 * Consumer application object that represents a multiPolygon

	 */

	public void addPolygonToMultiPolygon(Object polygon,Object multiPolygon);

	/**

	 * This method indicates that the parser has found a multiGeometry. 

	 * @param id

	 * MultiGeometry identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a multiGeometry

	 */

	public Object startMultiGeometry(String id, String srs);

	/**

	 * It is thrown when the multiGeometry has been completely parsed

	 * @param multiGeometry

	 * Consumer application object that represents a multiGeometry

	 */

	public void endMultiGeometry(Object multiGeometry);

	/**

	 * It is thrown to add a geometry to one multiGeometry.

	 * @param geometry

     * Consumer application object that represents a geometry

	 * @param multiGeometry

	 * Consumer application object that represents a multiGeometry

	 */

	public void addGeometryToMultiGeometry(Object geometry,Object multiGeometry);

	/**

	 * This method adds a bounding box to a feature.

	 * @param bbox

	 * Consumer application object that represents a bounding

	 * box

	 * @param feature

	 * Consumer application object that represents a feature

	 */

	public void addBboxToFeature(Object bbox, Object feature);

	/**

	 * This method adds a geometry to a feature. 

	 * @param geometry

	 * Consumer application object that represents a geometry

	 * @param feature

	 * Consumer application object that represents a feature

	 */

	public void addGeometryToFeature(Object geometry, Object feature);

	/**

	 * It is thrown when the parser has found a new metadata tag

	 * @param type

	 * String with the type of metadata, if is a description or any else

	 * @param data

	 * String with the value of the data.

	 * @param attributes 

	 * Object to pass the Atributtes

	 * @return

	 * Consumer application object that represents metadata 

	 */

	public Object startMetadata(String type, String data, IAttributesIterator attributes);

	/**

	 * This method adds metadata to feature. 

	 * @param metadata

	 * Consumer application object that represents metadata

	 * @param feature

	 * Consumer application object that represents a feature

	 */

	public void addMetadataToFeature(Object metadata, Object feature);

	/**

	 * This method adds metadata to complex metadata. 

	 * @param metadata

	 * Consumer application object that represents metadata

	 * @param parent

	 * Consumer application object that represents the complex metadata

	 */

	public void addMetadataToMetadata(Object metadata, Object parent);

	/**

	 * This method is thrown when the parser find the end of the metadata

	 * of an element.

	 * @param metadata

	 * Consumer application object that represents metadata 

	 */

	public void endMetadata(Object metadata);

	/**

	 * This method is thrown when the parser find the end of and element time tag

	 * @param time

	 * Consumer application object that represents time 

	 */

	public void endTime(Object time);

	/**

	 * It is thrown when the parser has found a new time tag tag

	 * @param type

	 * String with the type of time, if is a description or any else

	 * @param data

	 * String with the value of the data.

	 * @return

	 * Consumer application object that represents time

	 */

	public Object startTime(String name, String description, String type, String time, Object previous, Object next);

	public Object startTime(String type, String time);

	/**

	 * This method adds time to feature. 

	 * @param time

	 * Consumer application object that represents time

	 * @param feature

	 * Consumer application object that represents a feature

	 */

	public void addTimeToFeature(Object time, Object feature);

}

package org.gvsig.gpe.lib.api.parser;

/* 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

 */

/* CVS MESSAGES:

 *

 * $Id$

 * $Log$

 *

 */

/**

 * @author Jorge Piera LLodr? (jorge.piera@iver.es)

 */

public interface IGPEContentHandlerSFP0 {

	/**

	 * This method indicates that the parser has found a curve. 

	 * @param id

	 * curve identifier

	 * @param coords

	 * A coordinates iterator

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a lineString 

	 */

	public Object startCurve(String id, ICoordinateIterator coords, String srs);

	/**

	 * This method indicates that the parser has found a curve. 

	 * @param id

	 * curve identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a lineString 

	 */

	public Object startCurve(String id, String srs);

	/**

     * It is thrown when the Curve has been completely parsed.

	 * @param Curve

	 * Consumer application object that represents a Curve 

	 */

	public void endCurve(Object Curve);

	/**

	 * It adds a segment to a curve.

	 * @param segment

	 * The segment to add

	 * @param curve

	 * The curve

	 */

	public void addSegmentToCurve(Object segment, Object curve);

	/**

	 * This method indicates that the parser has found a multiCurve. 

	 * @param id

	 * MultyCurve identifier

	 * @param srs

	 * Spatial reference system

	 * @return

	 * Consumer application object that represents a multiCurve 

	 */

	public Object startMultiCurve(String id, String srs);

	/**

	 * It is thrown when the multiCurve has been completely parsed

	 * @param multiCurve

	 * Consumer application object that represents a multiCurve

	 */

	public void endMultiCurve(Object multiCurve);

	/**

	 * It is thrown to add a curve to one multiCurve.

	 * @param curve

     * Consumer application object that represents a curve

	 * @param multiCurve

	 * Consumer application object that represents a multiCurve

	 */

	public void addCurveToMultiCurve(Object curve, Object multiCurve);

}

package org.gvsig.gpe.lib.api.parser;

import java.io.IOException;

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

/* 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

*/

/* CVS MESSAGES:

*

* $Id$

* $Log$

*

*/

/**

* @author Carlos S?nchez Peri??n

*/

public interface IAttributesIterator {

	/**

    * Returns whether there are more attributes in this sequence

    * 

    * @return

    * @throws IOException

    */

   public boolean hasNext() throws IOException;