Aplicación gvSIG con fines educativos » Mapas temáticos

===============

gvSIG Educa

===============

---------------------

Portable View

---------------------

Description

==============

This folder contains the sources of the Portable View functionality.

Requirements

==============

* Maven 2.6 or higher

* Java JDK 1.5 or higher

For eclipse

-------------

See `developer guide at gvSIG.org <http://www.gvsig.org/plone/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2-1-0/introduccion>`_ and the file ``REAME-ECLIPSE.txt``

Contents

==========

org.gvsig.educa.portableview.lib

---------------------------------

Functionality sources. This project just contain the main process and the logic without any dependency with User Interface.

org.gvsig.educa.portableview.swing

-------------------------------------

User Interface components to access a manage the application services.

org.gvsig.educa.portableview.main

-----------------------------------

Little test application which allow run the main functionality of application.

See `Execute little test application`_ to know how run it.

pom.xml

---------

Maven project definition file

README.rst

--------------

This file (in reStructureText format, for more info this format look at `gvSIG portal <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/guia-para-documentar/el-formato-restructuredtext>`_  or at `docUtils reference <http://docutils.sourceforge.net/rst.html>`_)

Compilation

================

From shell

------------

Execute this command::

    org.gvsig.educa.portableview$ mvn clean install

From eclipse

--------------

See `work in a proyect of the developer guide at gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/trabajar-con-un-proyecto>`_

In some project, could be better use ``mvn eclipse:clean eclipse:eclipse``  than import project as a *Maven project*. Maven plugin of eclipse does not set classpath correctly in some project.

Packing

========

This functionality has no stand-alone packing process.

Version

---------------

To changes version number just set in in ``project/version`` tag of *pom.xml* in this folder. Sub-projects will inherit it.

Version polity is the standard in project. Changes in version number:

* third number: Bug fixes and minors improvements. API must have no changes from previous version.

* second number: Bug fixes and mayor improvements. API can have minor changes. Previously deprecated classes could be removed. No architectural changes.

* first number: Mayor changes.

Create a tag

------------------

TODO: use *maven release* plugin

Use svn copy command to copy version in server. Process could be like this:

#. Check that there ins no changes in workspace::

   svn up ; svn status

#. Check that project compiles and passes all test.

   mvn clean install

#. Update *pom.xml* to set version of tag (usually removing *-SNAPSHOT*)

#. create tag folder on server::

   svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview/tags/{version}

#. Copy current workcopy to tag folder::

   svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview/tags/{version}

#. Update *pom.xml* to next version

#. Commit *pom.xml* changes::

   svn commit -m "Set new version {version}-SNAPSHOT" pom.xml

i18n

======

The files for internationalization can be found in this folders:

+ *org.gvsig.educa.portablewview.app.viewer/src/main/resources-plugin*

+ *org.gvsig.educa.portablewview.app.editor/src/main/resources-plugin*

The internationalization of this application is based on standard java resource bundle mechanism. So, to add a new language just add the file with the language code to every related folder.

Execute little test application

=================================

From shell

------------

After compile the application, execute this command::

    org.gvsig.educa.portablewview$ cd org.gvsig.educa.thematicmap.main

    org.gvsig.educa.portablewview/org.gvsig.educa.portablewview.main$ mvn exec:java

Form eclipse

------------------

Select ``org.gvsig.educa.portableview.main`` project in *Project tree* using *Java perspective*, click with right mouse button and select ``Run as.../Java application``. Select ``Main`` class for project.

====

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2012 gvSIG Association.

    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.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

====

Put into this folder the resources needed by your classes.

This folder is added to the classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your classes.

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

<!--

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2012 gvSIG Association.

    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.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

-->

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	org.gvsig.tools packages.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.tools">

		<priority value="DEBUG" />

	</category>

	<category name="org.gvsig.construc">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

org.gvsig.educa.portableview.PortableViewLibrary

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

 *

 */

package org.gvsig.educa.portableview;

import org.gvsig.fmap.dal.DALLibrary;

import org.gvsig.fmap.mapcontext.MapContextLibrary;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

/**

 * Library for API initialization and configuration.

 *

 * @author gvSIG team

 * @version $Id$

 */

public class PortableViewLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(PortableViewLibrary.class);

        require(DALLibrary.class);

        require(MapContextLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

        // Do nothing

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Validate there is any implementation registered.

        PortableViewManager manager = PortableViewLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                PortableViewLocator.MANAGER_NAME,

                PortableViewLocator.getInstance());

        }

    }

}

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

 *

 */

package org.gvsig.educa.portableview.map;

import java.io.File;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws when try to open a PortableView file with invalid format

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class InvalidPortableViewFormatException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = 8895685032043751029L;

    private static final String MESSAGE =

        "Invalid format of a PortableView file [%(filePath)]: %(info)";

    private static final String KEY = "_InvalidPortableViewFormatException";

    /**

     * Invalid format of a portable view file by unspecified problem

     *

     * @param mapFile

     */

    public InvalidPortableViewFormatException(File mapFile) {

        this(mapFile, "unspecified problem");

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param message

     *            problem description

     */

    public InvalidPortableViewFormatException(File mapFile, String message) {

        super(MESSAGE, KEY, serialVersionUID);

        setValue("info", message);

        setValue("filePath", mapFile.getAbsolutePath());

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param message

     *            problem description

     * @param cause

     */

    public InvalidPortableViewFormatException(File mapFile, String message,

        Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("filePath", mapFile.getAbsolutePath());

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     */

    public InvalidPortableViewFormatException(File mapFile, Throwable cause) {

        this(mapFile, "initializing problem", cause);

    }

}

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

 *

 */

package org.gvsig.educa.portableview.map;

import java.io.IOException;

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.tools.dispose.Disposable;

/**

 * <i>Portable View</i> instance.

 * </p>

 * This class' instances contains information about a installed <i>Portable

 * View</i>

 *

 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

 * @version $Rev$

 * @since {version}

 */

public interface PortableView extends Disposable {

    /**

     * Gets information about this <i>Portable View</i>

     *

     * @return

     */

    PortableViewInformation getInformation();

    /**

     * Opens this <i>Portable View</i>

     * </p>

     * This unzip <i>Portable View</i> contents into temporal folder (if it isn't

     * created yet)

     * and prepares data

     * </p>

     * unzip folder is defined in {@link PortableViewManager#getTemporalFolder()}

     * </p>

     *

     * @throws InvalidPortableViewFormatException

     * @throws CantLoadContextException

     * @throws IOException

     */

    void open() throws InvalidPortableViewFormatException,

        CantLoadContextException, IOException;

    /**

     * Informs if <i>Portable View</i> it's already opened or not

     *

     * @return if it's opened

     */

    boolean isOpen();

    /**

     * Unloads all data loaded in memory and cleans its temporal folder

     *

     * @throws IOException

     *             if any problem is found cleaning temporal folder

     *

     */

    void close() throws IOException;

    /**

     * Gets MapContext with <i>Portable View</i> representation

     *

     * @return MapContext instance

     * @throws IllegalStateException

     *             if {@link #isOpen()} == false

     */

    MapContext getMapContext();

    /**

     * Gets the file which PortableView data

     *

     * @return

     */

    String getSourceFilePath();

}

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

 *

 */

package org.gvsig.educa.portableview.map;

import java.io.File;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws when try to load the MapContext of a PortableView file

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class CantLoadContextException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = -6565034273641780414L;

    private static final String MESSAGE =

        "Problem loading MapContext file [%(mapContextPath)] of a PortableView file [%(mapPath)]: %(info)";

    private static final String KEY = "_CantLoadContextException";

    /**

     * Cannot load mapContext from a Portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param message

     *            problem description

     * @param cause

     */

    public CantLoadContextException(File mapFile, File mapContextFile,

        String message, Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("mapPath", mapFile.getAbsolutePath());

        setValue("mapContextPath", mapContextFile.getAbsolutePath());

    }

    /**

     * Cannot load mapContext from a Portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param cause

     */

    public CantLoadContextException(File mapFile, File mapContextFile,

        Throwable cause) {

        this(mapFile, mapContextFile, "loading problem", cause);

    }

}

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

 *

 */

package org.gvsig.educa.portableview.map;

import java.io.File;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws when try to open an installed PortableView folder with

 * invalid format (missing package.info file or no match data)

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class InvalidInstalledPortableViewException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = 1L;

    private static final String MESSAGE =

        "Invalid format of an installed PortableView [%(folderPath)]: %(info)";

    private static final String KEY = "_InvalidInstalledPortableViewException";

    /**

     * Invalid format of an installed portable view folder by unspecified problem

     *

     * @param mapFile

     */

    public InvalidInstalledPortableViewException(File mapFolder) {

        this(mapFolder, "unspecified problem");

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param message

     *            problem description

     */

    public InvalidInstalledPortableViewException(File mapFolder, String message) {

        super(MESSAGE, KEY, serialVersionUID);

        setValue("info", message);

        setValue("folderPath", mapFolder.getAbsolutePath());

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param message

     *            problem description

     * @param cause

     */

    public InvalidInstalledPortableViewException(File mapFolder, String message,

        Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("folderPath", mapFolder.getAbsolutePath());

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     */

    public InvalidInstalledPortableViewException(File mapFile, Throwable cause) {

        this(mapFile, "initializing problem", cause);

    }

}

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

 *

 */

package org.gvsig.educa.portableview.map;

import java.util.Date;

import org.cresques.cts.IProjection;

import org.omg.CORBA.DynValue;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynStruct;

/**

 * Information about a <i>Portable View</i>:

 * <ul>

 * <li>Name and description</li>

 * <li>Author</li>

 * <li>License</li>

 * </ul>

 *

 * TODO Add more data

 *

 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

 * @version $Rev$

 * @since {version}

 */

public interface PortableViewInformation {

    public static final String DYN_DEFINITION_NAME = "PortableViewInformation";

    /**

     * Gets <i>Portable View</i> identifier

     *

     * @return

     */

    String getId();

    /**

     * Gets <i>Portable View</i> name

     *

     * @return

     */

    String getName();

    /**

     * Gets <i>Portable View</i> description

     *

     * @return

     */

    String getDescription();

    /**

     * Gets <i>Portable View</i> version

     *

     * @return

     */

    int getVersion();

    /**

     * Gets <i>Portable View</i> build number

     *

     * @return

     */

    int getBuildNumber();

    /**

     * Gets <i>Portable View</i> creation timestamp

     *

     * @return

     */

    Date getCreationTimestamp();

    /**

     * Gets full envelope

     *

     * @return

     */

    Envelope getFullEnvelope();

    /**

     * Returns CRS

     *

     * @return

     */

    IProjection getCRS();

    /**

     * Returns {@link DynValue} definition

     *

     * @return

     */

    DynStruct getDynDefinition();

    /**

     * Returns {@link DynObject} description

     *

     * @return

     */

    DynObject getDynObject();

}

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

 *

 */

package org.gvsig.educa.portableview;

import java.io.File;

import java.io.IOException;

import java.util.List;

import org.gvsig.educa.portableview.compilation.PortableViewCompilation;

import org.gvsig.educa.portableview.compilation.PortableViewCompiler;

import org.gvsig.educa.portableview.map.CantLoadContextException;

import org.gvsig.educa.portableview.map.InvalidPortableViewFormatException;

import org.gvsig.educa.portableview.map.PortableView;

import org.gvsig.educa.portableview.map.PortableViewInformation;

import org.gvsig.tools.dispose.Disposable;

/**

 * Library Manager.

 * </p>

 * Expose main library's functionalities:

 * <ul>

 * <li>Set default folders configuration</li>

 * <li>Get installed <i>Portable View</i></li>

 * <li>Identify and get a <i>Portable View</i> from a file</li>

 * <li>Create a new {@link PortableViewCompilation} instance</li>

 * <li>Create a new {@link PortableViewCompiler} instance</li>

 * </ul>

 *

 * @author gvSIG team

 * @version $Id$

 */

public interface PortableViewManager extends Disposable {

    public static final String  INSTALLER_PROVIDER_NAME = "PortableView";

    /**

     * Gets default folder to locate installed <i>Portable View</i>

     *

     * @return default installation folder

     */

    String getInstallationMapFolder();

    /**

     * Sets default folder to locate installed <i>Portable View</i>

     *

     * @param folder

     * @throws IllegalArgumentException

     *             if <code>folder</code> is a file or can't read or not exists

     */

    void setInstallationMapFolder(String folder);

    /**

     * Gets the folder to use to <i>open</i> any <i>Portable

     * View</i> before access to the information contained in it.

     *

     * @return temporal folder

     */

    String getTemporalFolder();

    /**

     * Sets the folder to use to <i>open</i> any <i>Portable View</i>

     *

     * @param folder

     * @throws IllegalArgumentException

     *             if <code>folder</code> is a file or can't write

     */

    void setTemporalFolder(String folder);

    /**

     * Clear all data in temporal folder

     */

    void cleanAllTemporalData();

    /**

     * Returns all <i>Portable View</i> installed

     * </p>

     * Uses installation folder to locate them

     *

     * @return All <i>Portable View></i> installed

     */

    List<PortableView> getInstalledMaps();

    /**

     * Returns all <i>Portable View</i> installed into the specified folder

     * </p>

     * Uses installation folder to locate them

     *

     * @param folder

     *            to analyze

     * @return All <i>Portable View></i> installed

     * @throws IllegalArgumentException

     *             if folder is not valid (a readable folder)

     */

    List<PortableView> getInstalledMaps(String folder);

    /**

     * Gets a {@link PortableView} from a file

     * </p>

     *

     * @param file

     * @return the <i>Portable View</i>

     * @throws InvalidPortableViewFormatException

     */

    PortableView getMapFromFile(File file)

        throws InvalidPortableViewFormatException;

    /**

     * Gets a {@link PortableView} from intalledMaps

     * by its id

     * </p>

     *

     * @param mapid

     *            PortableView id

     * @return the <i>Portable View</i>

     */

    PortableView getMapById(String mapId);

    /**

     * Informs if a file is a valid <i>Portable View</i> file

     *

     * @param file

     * @return

     */

    boolean isMap(File file);

    /**

     * Informs if a folder is a valid <i>Portable View</i> installed folder

     *

     * @param file

     * @return

     */

    boolean isAPortableViewIntalledFolder(File folder);

    /**

     * Creates a new instance of a {@link PortableViewCompilation}

     *

     * @return

     */

    PortableViewCompilation createCompilationInstance();

    /**

     * Creates a new instance of a {@link PortableViewCompilation} based on

     * values <code>map</code>

     *

     * @param map

     *            to use as template

     * @return

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidPortableViewFormatException

     */

    PortableViewCompilation createCompilationInstanceFromMap(PortableView map)

        throws InvalidPortableViewFormatException, CantLoadContextException,

        IOException;

    /**

     * Create a new instance of a {@link PortableViewCompiler}

     *

     * @return

     */

    PortableViewCompiler createCompilerInstance();

    /**

     * Generates the base name for a PortableView file using its info data

     *

     * @param info

     * @return

     */

    String getBaseFileNameFromInfo(PortableViewInformation info);

    /**

     * Generates the base name for a PortableView file

     *

     * @param info

     * @return

     */

    String getBaseFileNameFromInfo(String id, String name, int version,

        int buildNumber);

    /**

     * Create a gvSIG package file (gvspkg) from a portableView

     *

     * @param mapId

     *            id of map to export

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(String mapId, File targetFolder)

        throws PortableViewException, IOException;

    /**

     * Create a gvSIG package file (gvspkg) from a portableView installed folder

     *

     * @param portableViewIntallFolder

     *            folder of a installed PortableView

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(File portableViewIntallFolder, File targetFolder)

        throws PortableViewException, IOException;

    /**

     * Returns the translation of a string.

     *

     * @param key

     *            String to translate

     * @return a String with the translation of the string passed by parameter

     */

    public String getTranslation(String key);

}

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

 *

 */

package org.gvsig.educa.portableview.compilation;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws in a PortableView compilation process

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class CompilationException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = -1052257268555865780L;

    private static final String MESSAGE =

        "Problem found compiling Portable view [%(portableViewId)]: %(info)";

    private static final String KEY = "_CompilationException";

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param message

     *            problem description

     * @param cause

     */

    public CompilationException(String portableViewId, String message,

        Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("portableViewId", portableViewId);

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param cause

     */

    public CompilationException(String portableViewId, Throwable cause) {

        this(portableViewId, "compilation problem", cause);

    }

}

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

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface CompilationValidationMessage {

    public enum Type {

        MESSAGE, WARNING, ERROR

    };

    Type getType();

    String getMessage();

    String getSource();

}

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

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

 * Process to generate a file which will contains a <i>Portable View</i>

 *

 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

 * @version $Id$

 */

public interface PortableViewCompiler {

    /**

     * Gets temporal folder used by the process to prepare file

     *

     * @return

     */

    String getWorkFolder();

    /**

     * Sets temporal folder used by the process to prepare file

     *

     * @param folder

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setWorkFolder(String folder);

    /**

     * Gets folder used to deploy generated file

     *

     * @return

     */

    String getTargetFolder();

    /**

     * Sets folder where deploy generated file

     *

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setTargetFolder(String folder);

    /**

     * Set the process listener

     *

     * @param listener

     */

    void setCompilerListener(PortableViewCompilerListener listener);

    /**

     * <p>

     * Process compilation to generate a <i>Portable View</i>

     * </p>

     * <p>

     * <code>compilation</code> data will be update at the end of process if

     * it's success (build number, creation stamp).

     * </p>

     *

     * @param compilation

     * @return

     * @throws IllegalArgumentException

     *             if targetFolder or workFolder are not set

     */

    PortableViewCompilerStatus compile(PortableViewCompilation compilation);

}

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

 *

 */

package org.gvsig.educa.portableview.compilation;

import java.util.List;

import org.gvsig.fmap.mapcontext.MapContext;

/**

 * Interface for classes which contain all information needed to

 * generate a new Portable View file

 *

 * @author gvSIG Team

 * @version $Id$

 */

public interface PortableViewCompilation {

    /**

     * <p>

     * Gets object which contain PortableView information

     * </p>

     * <p>

     * Fill this object with the values of the information to target map

     * </p>

     *

     * @return

     */

    PortableViewCompilationInformation getInformation();

    /**

     * Gets current map context

     *

     * @return

     */

    MapContext getMapContext();

    /**

     * Sets map context for PortableView

     *

     * @param mapContext

     */

    void setMapContext(MapContext mapContext);

    /**

     * Validates compilation

     *

     * @param messages

     *            <i>output parameter</i> which will fill with validation

     *            messages

     * @return true is valid or false if any problems found (see

     *         <code>messages</code> parameter to get why)

     */

    boolean isValid(List<CompilationValidationMessage> messages);

}

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

 *

 */

package org.gvsig.educa.portableview.compilation;

import java.io.File;

import org.gvsig.tools.task.TaskStatus;

/**

 * Status of a Compiler process

 *

 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

 * @version $Id$

 */

public interface PortableViewCompilerStatus extends TaskStatus {

    /**

     * Available status of a {@link PortableViewCompilerStatus}

     *

     * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

     * @version $Rev$

     * @since {version}

     */

    enum Status {

        preparing, processing, canceled, finished_ok, finished_fail, finished_error

    };

    /**

     * Gets current status

     *

     * @return

     */

    Status getStatus();

    /**

     * Current step

     *

     * @return

     */

    int getCurrentStep();

    /**

     * Total steps

     *

     * @return

     */

    int getTotalSteps();

    /**

     * Current step i18n description key

     *

     * @return

     */

    String getCurrentStepKey();

    /**

     * Gets message from current step

     */

    String getCurrentStepMessage();

    /**

     * Gets generated file (if {@link Status#finished_ok} )

     *

     * @return

     */

    File getGeneratedPortableViewFile();

    /**

     * Gets generated folder of installed portableView for gvSIG installer

     * integration (if {@link Status#finished_ok} )

     *

     * @return

     */

    File getGeneratedInstalationPortableViewFolder();

    /**

     * Gets message (if {@link Status#finished_fail} or

     * {@link Status#finished_error})

     *

     * @return

     */

    String getFailMessage();

    /**

     * Gets exception if any (if {@link Status#finished_error})

     *

     * @return

     */

    Throwable getException();

    /**

     * Gets result compilation (if {@link Status#finished_ok}) modified by the

     * process (updated buildNumber, creation timestamp, etc...)

     *

     * @return

     */

    PortableViewCompilation getResultCompilation();

}