Aplicación gvSIG con fines educativos

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

gvSIG Educa

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

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

Vistas Portables

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

Descripci?n

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

Este directorio contiene los fuentes de la funcionalidad Vistas Portables.

Requisitos

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

* Maven 2.6 or higher

* Java JDK 1.5 or higher

Para trabajar con eclipse

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

Ver `Gu?a del desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/>`_ y el fichero ``REAME-ECLIPSE.txt``

Contenido

==========

org.gvsig.educa.portableview.lib

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

Fuentes de la funcionalidad. Estos proyectos contienen los procesos y l?gica principal sin dependencias de interface de usuario.

org.gvsig.educa.portableview.swing

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

Componentes de interface de usuario para gestionar los servicios que ofrece la librer??a.

org.gvsig.educa.portableview.main

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

Peque?a aplicaci?n que permite ejecutar las funcionalidades y realizar pruebas funcionales.

Ver `Ejecutar aplicaci?n de pruebas`_ para saber como arrancarla.

pom.xml

---------

Archivo de definici?n de proyecto Maven.

README.txt LEEME.txt

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

Este fichero (en formato reStructureText, para mas informaci?n sobre este ver el `portal de gvSIG <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/guia-para-documentar/el-formato-restructuredtext>`_  en la `referencia de docUtils  <http://docutils.sourceforge.net/rst.html>`_)

Compilaci?n

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

Desde el shell

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

Ejecute este comando::

    org.gvsig.educa.portablewview$ mvn clean install

Desde eclipse

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

Ver `Trabajar con un proyecto de la gu?a de desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/trabajar-con-un-proyecto>`_

En algunos proyectos puede que sea necesario user el comando ``mvn eclipse:clean eclipse:eclipse`` e importar como *Standar/Import existing project...* en vez de cargar como *Maven Project*. Esto es debido a que, en algunas circunstancias, parece que el plugin de Maven del eclipse no prepara el *classpath* de forma correcta.

Empaquetado

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

Esta funcionalidad no tiene ning?n proyecto pensado para empaquetar de forma independiente.

Versionado

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

Para cambiar el n?mero de versi?n de los plugins solo es necesario ajustar la etiqueta ``project/version`` del fichero *pom.xml*. Los subproyectos heredar?n el valor.

La pol??tica de versi?n es la est?ndar. Los cambios en los numeroso son:

* tercer n?mero: Arreglo de errores y mejoras menores. Sin cambios en el API.

* segundo n?mero: Arreglo de erroes y mejoras. Pueden haber cambios menores en el API. Los elementos marcados como *deprecated* en versiones anteriores pueden eliminarse. Sin cambios de arquitectura.

* primer n?mero: Cambios mayores.

Crear un tag

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

TODO: usar el plugin *release* de maven

Usar el comando *svn copy*. El proceso podr?a ser:

#. Comprobar que no hay cambios en la copia local::

   svn up ; svn status

#. Comprobar que los proyecto compilan y pasan todas las bater?as de test::

   mvn clean install

#. Actualizar el fichero *pom.xml* con la versi?n de tag (normalmente quitando el sufijo *-SNAPSHOT*)

#. Crear el directorio para el tag en el servidor::

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

#. Subir la copia local al directorio del tag en el servidor::

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

#. Actualizar el *pom.xml* a la siguiente version (y a?adirle el sufijo *-SNAPSHOT*)

#. Subir los cambios del *pom.xml*::

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

i18n

======

Los ficheros de internacionalizaci?n se pueden encontrar en los directorios:

+ */org.gvsig.educa.portableview.swing/org.gvsig.educa.portableview.swing.impl/src/main/resources/org/gvsig/educa/portableview/swing/impl/i18n*

+ *org.gvsig.educa.portableview.lib/org.gvsig.educa.portableview.lib.impl/src/main/resources/org/gvsig/educa/portableview/impl/i18n*

La internacionalizaci?n est? basada en el mecanismo est?ndar de los *resource bundle*. Para a?adir un nuevo idioma es necesario a?adir el fichero de propiedades en todos los directorio con el codigo de idioma adecuado.

Ejecutar aplicaci?n de pruebas

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

Desde el Shell

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

Despu?s del proceso de `Compilaci?n`_ , ejecute estos comandos::

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

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

Desde el eclipse

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

Seleccione el proyecto ``org.gvsig.educa.portableview.main`` en el *Project tree* de la *Java perspective*, haga click con el bot?n derecho y seleccione ``Run as.../Java application``. Seleccione la clase ``Main`` del propio proyecto.

Si tiene problemas al ejecutar, compruebe la nota de la secci?n `Compilaci?n`_ sobre la importaci?n del proyecto.

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

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.educa.portableview.app</artifactId>

		<version>1.0.19</version>

	</parent>

	<artifactId>org.gvsig.educa.portableview.app.editor</artifactId>

	<name>org.gvsig.educa.portableview.app.editor</name>

	<dependencies>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId> org.gvsig.educa.portableview.app.viewer </artifactId>

                <scope>compile</scope>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.about.api</artifactId>

                <scope>compile</scope>

            </dependency>

	</dependencies>

	  	<properties>

		<gvsig.package.info.state>testing</gvsig.package.info.state>

        <gvsig.package.info.official>true</gvsig.package.info.official>

		<gvsig.package.info.dependencies>required: org.gvsig.app -ge 2.1.0</gvsig.package.info.dependencies>

        <gvsig.package.info.categories>Portable View</gvsig.package.info.categories>

        <gvsig.package.info.name>Portable View: editor</gvsig.package.info.name>

        <gvsig.package.info.description>Portable View document: Provides tools to create and generate packages of Portable View.</gvsig.package.info.description>

        <gvsig.package.info.owner>gvSIG Association</gvsig.package.info.owner>

        <gvsig.package.info.javaVM>j1_6</gvsig.package.info.javaVM>

        <gvsig.package.info.sourcesURL>${project.scm.url}</gvsig.package.info.sourcesURL>

		<gvsig.package.info.poolURL>https://devel.gvsig.org/download/projects/gvsig-educa/pool/</gvsig.package.info.poolURL>

    </properties>

</project>

#Thu Oct 29 16:19:58 CET 2015

buildNumber=29

/* 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.app.editor.impl;

import org.gvsig.andami.messages.NotificationManager;

import org.gvsig.educa.portableview.app.editor.CompilationListener;

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

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

/**

 * 

 * Utility class which allow just override {@link CompilationListener} that you

 * need without override the other (useful for inner class)

 * 

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public abstract class CompilationListenerAdapter implements CompilationListener {

    /** {@inheridDoc} */

    public void finished(PortableViewCompilerStatus status) {

        // Nothing to do

    }

    /** {@inheridDoc} */

    public void fail(PortableViewCompilerStatus status) {

        // Nothing to do

    }

    /** {@inheridDoc} */

    public void canceledCompilation(PortableViewCompilerStatus status) {

        // Nothing to do

    }

    /** {@inheridDoc} */

    public void canceledEditing(PortableViewCompilation compilation) {

        // Nothing to do

    }

    public void exception(String message, Throwable exception) {

        // use notification manager by default

        NotificationManager.addError(message, exception);

    }

}

/* 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.app.editor.impl;

import org.gvsig.educa.portableview.app.editor.PortableViewEditorLibrary;

import org.gvsig.educa.portableview.app.editor.PortableViewEditorLocator;

import org.gvsig.educa.portableview.app.editor.PortableViewEditorManager;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

/**

 * Library for default {@link PortableViewEditorManager} implementation

 * register.

 *

 * @author gvSIG team

 * @version $Id$

 */

public class PortableViewEditorDefaultImplLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsImplementationOf(PortableViewEditorLibrary.class);

    }

    /** {@inheridDoc} */

    @Override

    protected void doInitialize() throws LibraryException {

        PortableViewEditorLocator

            .registerManager(DefaultPortableViewEditorManager.class);

    }

    /** {@inheridDoc} */

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Do Nothing

    }

}

/* 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.app.editor.impl;

import java.io.File;

import java.io.IOException;

import java.util.List;

import javax.swing.JFileChooser;

import javax.swing.SwingUtilities;

import org.apache.commons.lang3.ObjectUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.messages.NotificationManager;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.app.project.Project;

import org.gvsig.app.project.ProjectManager;

import org.gvsig.app.project.documents.Document;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.app.project.documents.view.ViewManager;

import org.gvsig.educa.portableview.PortableViewException;

import org.gvsig.educa.portableview.PortableViewFileServices;

import org.gvsig.educa.portableview.PortableViewLocator;

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.educa.portableview.app.editor.CompilationListener;

import org.gvsig.educa.portableview.app.editor.PortableViewEditorManager;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocumentManager;

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

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

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

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

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.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

import org.gvsig.educa.portableview.swing.PortableViewWindowManager;

import org.gvsig.educa.portableview.swing.PortableViewWindowManager.MESSAGE_DIALOG_TYPE;

import org.gvsig.educa.portableview.swing.editor.PortableViewCompilationEditor;

import org.gvsig.educa.portableview.swing.editor.PortableViewCompilationEditorListener;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.swing.api.windowmanager.WindowManager.MODE;

/**

 * <p>

 * Default implementation of {@link PortableViewEditorManager}

 * </p>

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class DefaultPortableViewEditorManager implements

		PortableViewEditorManager {

	private PortableViewDocumentManager docManager;

	private final PortableViewManager manager;

	private final PortableViewSwingManager swingManager;

	private final PortableViewWindowManager winManager;

	private final PortableViewFileServices fileServices;

	private File workFolder;

	private final JFileChooser fileChooser;

	/**

     *

     */

	public DefaultPortableViewEditorManager() {

		swingManager = PortableViewSwingLocator.getSwingManager();

		manager = swingManager.getManager();

		fileServices = PortableViewLocator.getFileServices();

		winManager = swingManager.getWindowManager();

		fileChooser = new JFileChooser();

	}

	/**

	 * <p>

	 * {@link CompilationListener} instance which create a new

	 * {@link PortableViewDocument} from a {@link ViewDocument}

	 * </p>

	 * <p>

	 * Delegates on previously received listener (if any)

	 * </p>

	 *

	 * @author gvSIG Team

	 * @version $Id$

	 *

	 */

	private class CreateDocumentListener implements CompilationListener {

		private final CompilationListener delegate;

		private final boolean openWindow;

		private final ViewDocument sourceView;

		/**

		 * @param openWindow

		 *

		 */

		public CreateDocumentListener(ViewDocument sourceView,

				CompilationListener delegate, boolean openWindow) {

			this.sourceView = sourceView;

			this.delegate = delegate;

			this.openWindow = openWindow;

		}

		/** {@inheridDoc} */

		public void finished(PortableViewCompilerStatus status) {

			// Gets created map

			PortableView map = manager.getMapById(status.getResultCompilation()

					.getInformation().getId());

			// Check if a document already exist for this map

			PortableViewDocumentManager docManager = getDocManager();

			PortableViewDocument doc = docManager.getDocumentForMap(map);

			if (doc == null) {

				doc = docManager.createDocument(map);

				getProject().add(doc);

			} else {

				// If exist reload

				try {

					doc.reloadPortableView();

				} catch (Exception ex) {

					NotificationManager

							.addError(

									swingManager

											.getTranslation("problems_reloading_portable_view"),

									ex);

				}

			}

			// Link view to portable view

			doc.setSourceView(sourceView);

			if (openWindow) {

				final IWindow window = docManager.getMainWindow(doc);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						PluginServices.getMDIManager().addWindow(window);

					}

				});

			}

			if (delegate != null) {

				delegate.finished(status);

			}

		}

		/** {@inheridDoc} */

		public void canceledCompilation(PortableViewCompilerStatus status) {

			if (delegate != null) {

				delegate.canceledCompilation(status);

			}

		}

		/** {@inheridDoc} */

		public void canceledEditing(PortableViewCompilation compilation) {

			if (delegate != null) {

				delegate.canceledEditing(compilation);

			}

		}

		/** {@inheridDoc} */

		public void fail(PortableViewCompilerStatus status) {

			if (delegate != null) {

				delegate.fail(status);

			} else {

				String msg = swingManager

						.getTranslation(

								"problems_creating_portable_view_from_a_view")

						.concat(": ").concat(status.getFailMessage());

				if (status.getException() != null) {

					NotificationManager.addWarning(msg, status.getException());

				} else {

					NotificationManager.addWarning(msg);

				}

			}

		}

		public void exception(String message, Throwable exception) {

			if (delegate != null) {

				delegate.exception(message, exception);

			} else {

				String msg = swingManager

						.getTranslation(

								"problems_creating_portable_view_from_a_view")

						.concat(": ").concat(message);

				NotificationManager.addError(msg, exception);

			}

		}

	}

	/**

	 * <p>

	 * {@link CompilationListener} instance which update the

	 * {@link PortableViewDocument} from its related {@link ViewDocument} (

	 * {@link PortableViewDocument#getSourceView()})

	 * </p>

	 * <p>

	 * Delegates on previously received listener (if any)

	 * </p>

	 *

	 * @author gvSIG Team

	 * @version $Id$

	 *

	 */

	private class UpdateDocumentListener implements CompilationListener {

		private final CompilationListener delegate;

		private final boolean openWindow;

		private final PortableViewDocument toUpdate;

		/**

		 * @param openWindow

		 *

		 */

		public UpdateDocumentListener(PortableViewDocument toUpdate,

				CompilationListener delegate, boolean openWindow) {

			this.toUpdate = toUpdate;

			this.delegate = delegate;

			this.openWindow = openWindow;

		}

		/** {@inheridDoc} */

		public void finished(PortableViewCompilerStatus status) {

			// close doc windows if it was opened

			PluginServices.getMDIManager().closeSingletonWindow(toUpdate);

			// Reload maps

			try {

				toUpdate.reloadPortableView();

			} catch (Exception ex) {

				NotificationManager

						.addError(

								swingManager

										.getTranslation("problems_reloading_portable_view"),

								ex);

				return;

			}

			if (openWindow) {

				final IWindow window = toUpdate.getFactory().getMainWindow(

						toUpdate);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						PluginServices.getMDIManager().addWindow(window);

					}

				});

			}

			if (delegate != null) {

				delegate.finished(status);

			}

		}

		/** {@inheridDoc} */

		public void canceledCompilation(PortableViewCompilerStatus status) {

			if (delegate != null) {

				delegate.canceledCompilation(status);

			}

		}

		/** {@inheridDoc} */

		public void canceledEditing(PortableViewCompilation compilation) {

			if (delegate != null) {

				delegate.canceledEditing(compilation);

			}

		}

		/** {@inheridDoc} */

		public void fail(PortableViewCompilerStatus status) {

			if (delegate != null) {

				delegate.fail(status);

			} else {

				String msg = swingManager

						.getTranslation("problems_regeneration_portable_view")

						.concat(": ").concat(status.getFailMessage());

				if (status.getException() != null) {

					NotificationManager.addWarning(msg, status.getException());

				} else {

					NotificationManager.addWarning(msg);

				}

			}

		}

		public void exception(String message, Throwable exception) {

			if (delegate != null) {

				delegate.exception(message, exception);

			} else {

				String msg = swingManager

						.getTranslation("problems_regeneration_portable_view")

						.concat(": ").concat(message);

				NotificationManager.addError(msg, exception);

			}

		}

	}

	/** {@inheridDoc} */

	public void createPortableViewFromView(ViewDocument view,

			CompilationListener listener, boolean openWindow) {

		if (view == null) {

			throw new IllegalArgumentException("View document required");

		}

		PortableViewCompilation compilation = manager

				.createCompilationInstance();

		PortableViewCompilationInformation info = compilation.getInformation();

		info.setName(view.getName());

		info.setId(generateIdForViewName(view.getName()));

		info.setVersion(1);

		compilation.setMapContext(view.getMapContext().cloneFMap());

		PortableViewCompilationEditor editor = swingManager

				.getCopilationEditor(compilation, false);

		final CreateDocumentListener myListener = new CreateDocumentListener(

				view, listener, openWindow);

		editor.setListener(new PortableViewCompilationEditorListener() {

			public void finished(final PortableViewCompilationEditor editor) {

				editor.getSwingComponent().setVisible(false);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						try {

							compileInInstallFolder(editor.getCompilation(),

									myListener);

						} catch (Exception ex) {

							myListener.exception("Exception compiling", ex);

						}

					}

				});

			}

			public void canceled(final PortableViewCompilationEditor editor) {

				editor.getSwingComponent().setVisible(false);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						myListener.canceledEditing(editor.getCompilation());

					}

				});

			}

		});

		winManager.showCompilationEditor(editor, MODE.WINDOW);

	}

	/** {@inheridDoc} */

	public void compileInInstallFolder(PortableViewCompilation compilation,

			CompilationListener listener) {

		if (compilation == null) {

			throw new IllegalArgumentException("Compilation required");

		}

		PortableViewCompiler compiler = manager.createCompilerInstance();

		compiler.setTargetFolder(manager.getInstallationMapFolder());

		// prepare a temp folder

		compiler.setWorkFolder(getWorkFolder());

		PortableViewCompilerStatus result = compiler.compile(compilation);

		if (listener != null) {

			if (result.getStatus() == PortableViewCompilerStatus.Status.finished_ok) {

				listener.finished(result);

				return;

			}

			if (result.getStatus() == PortableViewCompilerStatus.Status.canceled) {

				listener.canceledCompilation(result);

				return;

			}

			listener.fail(result);

		}

	}

	/**

	 * Generates a PortableView id from a View Document name

	 *

	 * @param viewName

	 * @return

	 */

	private String generateIdForViewName(String viewName) {

		String name = StringUtils.replace(viewName.trim(), " ", "_");

		return name;

	}

	/**

	 * Prepare a work folder for compiler base on

	 * {@link PortableViewManager#getTemporalFolder()}

	 *

	 * @return

	 */

	private String getWorkFolder() {

		if (workFolder == null) {

			workFolder = fileServices.getNewWritableFolder(

					new File(manager.getTemporalFolder()), "_compiler_");

			workFolder.deleteOnExit();

		}

		return workFolder.getAbsolutePath();

	}

	/** {@inheridDoc} */

	public PortableViewDocumentManager getDocManager() {

		if (docManager == null) {

			docManager = (PortableViewDocumentManager) ProjectManager

					.getInstance().getDocumentManager(

							PortableViewDocumentManager.TYPENAME);

		}

		return docManager;

	}

	/** {@inheridDoc} */

	public File generatePackage(PortableViewDocument portableView,

			File targetFolder) throws PortableViewException, IOException {

		if (portableView == null) {

			throw new IllegalArgumentException(

					"Portable View document required");

		}

		return manager.generatePackageFile(portableView.getPortableView()

				.getInformation().getId(), targetFolder);

	}

	/** {@inheridDoc} */

	public File generatePackage(PortableViewDocument portableView)

			throws PortableViewException, IOException {

		File target = askForAOutputFolder(swingManager

				.getTranslation("Select_folder_to_store_package"));

		if (target != null) {

			return generatePackage(portableView, target);

		}

		return null;

	}

	/** {@inheridDoc} */

	public PortableViewDocument getPortableViewDocumentByView(ViewDocument view) {

		if (view == null) {

			throw new IllegalArgumentException("View document required");

		}

		List<Document> documents = getProject().getDocuments(

				PortableViewDocumentManager.TYPENAME);

		PortableViewDocument map;

		for (Document doc : documents) {

			map = (PortableViewDocument) doc;

			if (ObjectUtils.equals(map.getSourceView(), view)) {

				return map;

			}

		}

		return null;

	}

	/**

	 * Gets current gvSIG project

	 *

	 * @return

	 */

	public Project getProject() {

		return ProjectManager.getInstance().getCurrentProject();

	}

	/**

	 * Shows a dialog to ask a output folder

	 *

	 * @param description

	 *            of the file is for

	 * @return

	 */

	public File askForAOutputFolder(String description) {

		fileChooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);

		int targetFolderAnswere = fileChooser.showDialog(null, description);

		if (targetFolderAnswere != JFileChooser.APPROVE_OPTION) {

			return null;

		}

		return fileChooser.getSelectedFile();

	}

	/** {@inheridDoc} */

	public ViewDocument exportPortableViewToView(PortableViewDocument map,

			boolean openViewWindow) throws IOException,

			InvalidPortableViewFormatException, PersistenceException {

		File target;

		while (true) {

			target = askForAOutputFolder(swingManager

					.getTranslation("Select_folder_to_extract_data"));

			if (target == null) {

				return null;

			}

			if (!target.exists()) {

				continue;

			}

			if (target.list().length == 0) {

				break;

			} else {

				winManager.showMessageDialog(swingManager

						.getTranslation("Select_folder_to_extract_data"),

						swingManager.getTranslation("folder_must_be_empty"),

						MESSAGE_DIALOG_TYPE.WARNING);

			}

		}

		return exportPortableViewToView(map, target, openViewWindow);

	}

	/** {@inheridDoc} */

	public ViewDocument exportPortableViewToView(PortableViewDocument map,

			File exportFolder, boolean openViewWindow) throws IOException,

			InvalidPortableViewFormatException, PersistenceException {

		if (map == null) {

			throw new IllegalArgumentException(

					"Portable View document required");

		}

		if (!fileServices.isWritableFolder(exportFolder)) {

			throw new IllegalArgumentException(

					"Not a writable folder: ".concat(exportFolder

							.getAbsolutePath()));

		}

		if (exportFolder.list().length > 0) {

			throw new IllegalArgumentException(

					"Not a empty folder: ".concat(exportFolder

							.getAbsolutePath()));

		}

		File mapFile = new File(map.getPortableView().getSourceFilePath());

		fileServices.unzipFile(mapFile, exportFolder);

		// Prepares mapContext file path

		File mapContextFile = new File(exportFolder,

				"mapContext/mapContext.xml");

		// Check if mapContext file exists

		if (!mapContextFile.exists()) {

			throw new InvalidPortableViewFormatException(mapFile,

					"Missing mapContext/mapContext.xml file in deployed map: "

							.concat(mapContextFile.getAbsolutePath()));

		}

		if (!mapContextFile.isFile()) {

			throw new InvalidPortableViewFormatException(mapFile,

					"mapContext/mapContext.xml file in deployed map is not a file: "

							.concat(mapContextFile.getAbsolutePath()));

		}

		// Load map context

		MapContext mapContext = fileServices.loadMapContext(mapContextFile,

				exportFolder);

		// Create view document

		ProjectManager projectManager = ProjectManager.getInstance();

		final ViewDocument view = (ViewDocument) projectManager

				.createDocument(ViewManager.TYPENAME);

		PortableViewInformation info = map.getPortableView().getInformation();

		// Fill view values

		view.setName(map.getName());

		view.setComment(String.format(

				swingManager.getTranslation("generated_from_portable_view"),

				info.getId(), info.getName(), info.getVersion(),

				info.getBuildNumber()));

		view.setMapContext(mapContext);

		// Add view document to project

		getProject().add(view);

		if (openViewWindow) {

			// Open view window

			SwingUtilities.invokeLater(new Runnable() {

				public void run() {

					IWindow viewWindow = view.getFactory().getMainWindow(view);

					PluginServices.getMDIManager().addWindow(viewWindow);

				}

			});

		}

		// If map has no source view link it to the new one

		if (map.getSourceView() == null) {

			map.setSourceView(view);

		}

		return view;

	}

	/** {@inheridDoc} */

	public void regeneratePortableView(PortableViewDocument map,

			CompilationListener listener, boolean openWindow)

			throws InvalidPortableViewFormatException,

			CantLoadContextException, IOException {

		if (map == null) {

			throw new IllegalArgumentException(

					"Portable View document is required");

		}

		if (map.getSourceView() == null) {

			// No source view it can't regenerate it

			return;

		}

		ViewDocument document = map.getSourceView();

		// Get a compilation instance from map

		PortableViewCompilation compilation = manager

				.createCompilationInstanceFromMap(map.getPortableView());

		// Update map context from view

		compilation.setMapContext(document.getMapContext());

		// Create a editor and disable id change

		PortableViewCompilationEditor editor = swingManager

				.getCopilationEditor(compilation, false);

		editor.allowChangeId(false);

		// Add update listener

		final UpdateDocumentListener myListener = new UpdateDocumentListener(

				map, listener, openWindow);

		// Add editor listener which call to compiler or notify cancel to

		// listener

		editor.setListener(new PortableViewCompilationEditorListener() {

			public void finished(final PortableViewCompilationEditor editor) {

				editor.getSwingComponent().setVisible(false);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						try {

							compileInInstallFolder(editor.getCompilation(),

									myListener);

						} catch (Exception ex) {

							myListener.exception("Exception compiling", ex);

						}

					}

				});

			}

			public void canceled(final PortableViewCompilationEditor editor) {

				editor.getSwingComponent().setVisible(false);

				SwingUtilities.invokeLater(new Runnable() {

					public void run() {

						myListener.canceledEditing(editor.getCompilation());

					}

				});

			}

		});

		// Show editor

		winManager.showCompilationEditor(editor, MODE.WINDOW);

	}

}

/* 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.app.editor;

import javax.swing.SwingUtilities;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.messages.NotificationManager;

import org.gvsig.andami.plugins.Extension;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.app.project.documents.view.gui.IView;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.app.viewer.ui.PortableViewDocumentViewer;

import org.gvsig.educa.portableview.swing.PortableViewSwingLocator;

import org.gvsig.educa.portableview.swing.PortableViewSwingManager;

/**

 * Andami extension to update a Portable View from its source View.

 *

 * @author gvSIG Team

 * @version $Id$

 */

public class RegeneratePortableViewExtension extends Extension {

    private PortableViewEditorManager editorManager;

    private PortableViewSwingManager swingManager;

    public void initialize() {

        // Do nothing

    }

    @Override

    public void postInitialize() {

        editorManager = PortableViewEditorLocator.getManager();

        swingManager = PortableViewSwingLocator.getSwingManager();

    }

    public void execute(String actionCommand) {

        IWindow window = PluginServices.getMDIManager().getActiveWindow();

        final PortableViewDocument tmDocument = getRelatedPortableView(window);

        SwingUtilities.invokeLater(new Runnable() {

            public void run() {

                try {

                    editorManager.regeneratePortableView(tmDocument, null, true);

                } catch (Exception ex) {

                    NotificationManager.addError(swingManager

                        .getTranslation("problems_regeneration_portable_view"),

                        ex);

                }

            }

        });

    }

    /** {@inheridDoc} */

    public boolean isEnabled() {

        IWindow window = PluginServices.getMDIManager().getActiveWindow();

        PortableViewDocument thMap = getRelatedPortableView(window);

        return thMap != null && thMap.getSourceView() != null;

    }

    /** {@inheridDoc} */

    public boolean isVisible() {

        // it's a Portable View view

        IWindow window = PluginServices.getMDIManager().getActiveWindow();

        return window instanceof PortableViewDocumentViewer

            || window instanceof IView;

    }

    /**

     * <p>

     * Returns related portable view of a window

     * </p>

     *

     * @param window

     * @return

     */

    private PortableViewDocument getRelatedPortableView(IWindow window) {

        if (editorManager == null) {

            // initialization process not finished yet

            return null;

        }

        if (window instanceof IView) {

            return editorManager.getPortableViewDocumentByView(((IView) window)

                .getViewDocument());

        } else

            if (window instanceof PortableViewDocumentViewer) {

                return ((PortableViewDocumentViewer) window)

                    .getPortableViewDocument();

            }

        return null;

    }

}

/* 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.app.editor;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.app.project.documents.view.gui.IView;

/**

 * Andami extension which opens related portable view of a view

 * 

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public class OpenRelatedPortableViewExtension extends

    OpenRelatedDocumentExtension {

    @Override

    public boolean isVisible() {

        IWindow window = PluginServices.getMDIManager().getActiveWindow();

        return window instanceof IView && super.isVisible();

    }

}

/* 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.app.editor;

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

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

/**

 * Portable View Document compilation listener

 * 

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface CompilationListener {

    /**

     * Call when process is success

     * 

     * @param status

     */

    void finished(PortableViewCompilerStatus status);

    /**

     * Call when process is canceled in the compilation step

     * 

     * @param status

     */

    void canceledCompilation(PortableViewCompilerStatus status);

    /**

     * Call when user cancel the editor

     * 

     * @param compilation

     */

    void canceledEditing(PortableViewCompilation compilation);

    /**

     * Call when compilation process is not sucess

     * 

     * @param status

     */

    void fail(PortableViewCompilerStatus status);

    /**

     * Call when an exception is throw

     * 

     * @param message

     * @param exception

     */

    void exception(String message, Throwable exception);

}

/* 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.app.editor;

import java.io.File;

import java.io.IOException;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.educa.portableview.PortableViewException;

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocument;

import org.gvsig.educa.portableview.app.viewer.PortableViewDocumentManager;

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

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.swing.PortableViewSwingManager;

import org.gvsig.tools.persistence.exception.PersistenceException;

/**

 * <p>

 * Manager which make easy the creation, editing and share PortableView

 * </p>

 * <p>

 * This uses all services of {@link PortableViewManager} and

 * {@link PortableViewSwingManager} in a high level way.

 * </p>

 *

 * <p>

 * This manager provides the most important services which provides this add-on

 * </p>

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface PortableViewEditorManager {

    /**

     * Returns {@link PortableViewDocumentManager} instance

     *

     * @return

     */

    PortableViewDocumentManager getDocManager();

    /**

     * Compile a {@link PortableViewCompilation} and deploy it in current install

     * folder ( {@link PortableViewManager#getInstallationMapFolder()} )

     *

     * @param compilation

     *            to compile

     *

     * @param listener

     *            of the process

     */

    void compileInInstallFolder(PortableViewCompilation compilation,

        CompilationListener listener);

    /**

     * <p>

     * Create a new {@link PortableView} from a view contents and open it as a

     * {@link PortableViewDocument}

     * </p>

     * <p>

     * {@link PortableViewDocument} will be linked to source view so it can be

     * regenerated.

     * </p>

     *

     * @param view

     * @param listener

     * @param openWindow

     */

    void createPortableViewFromView(ViewDocument view,

        CompilationListener listener, boolean openWindow);

    /**

     * Gets the {@link PortableViewDocument} linked to a {@link ViewDocument}

     *

     * @param view

     * @return the document or null if not found

     */

    PortableViewDocument getPortableViewDocumentByView(ViewDocument view);

    /**

     * Generate a gvSIG add-ons installer package from a

     * {@link PortableViewDocument}

     *

     * @param portableView

     *            to packing

     * @param targetFolder

     *            to store result file

     * @return

     * @throws IOException

     * @throws PortableViewException

     */

    File generatePackage(PortableViewDocument portableView, File targetFolder)

        throws PortableViewException, IOException;

    /**

     * <p>

     * Generate a gvSIG add-ons installer package from a

     * {@link PortableViewDocument}

     * </p>

     * <p>

     * User will be prompted for folder to store result file

     * </p>

     *

     * @param portableView

     * @return

     * @throws IOException

     * @throws PortableViewException

     */

    File generatePackage(PortableViewDocument portableView)

        throws PortableViewException, IOException;

    /**

     * Export the contents of a Portable View into a folder and create a

     * {@link ViewDocument} in project with it's layers

     * <p>

     * User will be prompted for extract folder

     * </p>

     * <p>

     * If Portable view document has no related view link the new one to it

     * </p>

     *

     * @param map

     * @param openViewWindow

     * @return

     * @throws IOException

     * @throws InvalidPortableViewFormatException

     * @throws PersistenceException

     */

    ViewDocument exportPortableViewToView(PortableViewDocument map,

        boolean openViewWindow) throws IOException,

        InvalidPortableViewFormatException, PersistenceException;

    /**

     * Export the contents of a Portable View into a folder and create a

     * {@link ViewDocument} in project with it's layers

     * <p>

     * If Portable view document has no related view link the new one to it

     * </p>

     *

     * @param map

     * @param exportFolder

     *            <b>Warning:</b> this folder must be empty

     * @return

     * @throws IOException

     * @throws InvalidPortableViewFormatException

     * @throws PersistenceException

     */

    ViewDocument exportPortableViewToView(PortableViewDocument map,

        File exportFolder, boolean openViewWindow) throws IOException,

        InvalidPortableViewFormatException, PersistenceException;

    /**

     * <p>

     * Regenerates the Portable View from current state of source View

     * </p>

     * <p>

     * Portable View document must be linked to a view, otherwise this method do

     * nothing.

     * </p>

     *

     * @param map

     * @param listener

     * @param openWindow

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidPortableViewFormatException

     */

    void regeneratePortableView(PortableViewDocument map,

        CompilationListener listener, boolean openWindow)

        throws InvalidPortableViewFormatException, CantLoadContextException,

        IOException;

}

/* 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.app.editor;

import java.io.File;