Aplicación gvSIG con fines educativos » gvSIG educa bugs

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.educa.portableview.lib.prov.installer;

import org.gvsig.educa.portableview.lib.prov.installer.execution.PortableViewInstallerExecutionProviderFactory;

import org.gvsig.installer.lib.api.InstallerLibrary;

import org.gvsig.installer.lib.spi.InstallerProviderLocator;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.service.spi.ProviderManager;

public class PortableViewInstallerProviderLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsServiceOf(InstallerLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        ProviderManager providerManager =

            InstallerProviderLocator.getProviderManager();

        providerManager

            .addProviderFactory(new PortableViewInstallerExecutionProviderFactory());

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.educa.portableview.lib.prov.installer.execution;

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.service.spi.AbstractProviderFactory;

import org.gvsig.tools.service.spi.Provider;

import org.gvsig.tools.service.spi.ProviderServices;

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class PortableViewInstallerExecutionProviderFactory extends

    AbstractProviderFactory {

    public static final String PROVIDER_DESCRIPTION =

        "Portable View installation provider";

    private DynClass dynclass;

    @Override

    protected DynClass createParametersDynClass() {

        if (dynclass == null) {

            initialize();

        }

        return dynclass;

    }

    @Override

    protected Provider doCreate(DynObject parameters, ProviderServices services) {

        return new PortableViewInstallerExecutionProvider(services);

    }

    @Override

    public String getName() {

        return PortableViewManager.INSTALLER_PROVIDER_NAME;

    }

    public void initialize() {

        if (dynclass == null) {

            DynObjectManager dynObjectManager =

                ToolsLocator.getDynObjectManager();

            dynclass =

                dynObjectManager.createDynClass(this.getName(),

                    PROVIDER_DESCRIPTION);

            dynObjectManager.add(dynclass);

        }

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.educa.portableview.lib.prov.installer.execution;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import org.gvsig.educa.portableview.PortableViewLocator;

import org.gvsig.educa.portableview.PortableViewManager;

import org.gvsig.installer.lib.api.PackageInfo;

import org.gvsig.installer.lib.api.execution.InstallPackageServiceException;

import org.gvsig.installer.lib.spi.InstallPackageProviderServices;

import org.gvsig.installer.lib.spi.InstallerProviderLocator;

import org.gvsig.installer.lib.spi.InstallerProviderManager;

import org.gvsig.installer.lib.spi.execution.InstallPackageProvider;

import org.gvsig.tools.service.spi.AbstractProvider;

import org.gvsig.tools.service.spi.ProviderServices;

public class PortableViewInstallerExecutionProvider extends AbstractProvider

    implements InstallPackageProvider {

    private static final InstallerProviderManager installerProviderManager =

        InstallerProviderLocator.getProviderManager();

    private final PortableViewManager tmManager;

    public PortableViewInstallerExecutionProvider(

        ProviderServices providerServices) {

        super(providerServices);

        tmManager = PortableViewLocator.getManager();

    }

    public void install(File applicationDirectory, InputStream inputStream,

        PackageInfo packageInfo) throws InstallPackageServiceException {

        try {

            File installationFolder =

                new File(tmManager.getInstallationMapFolder());

            InstallPackageProviderServices installerProviderServices =

                installerProviderManager.createInstallerProviderServices();

            installerProviderServices.decompress(inputStream,

                installationFolder);

        } catch (Exception e) {

            try {

                // if there is an exception, installLater is called

                installLater(applicationDirectory, inputStream, packageInfo);

            } catch (IOException e1) {

                e1.printStackTrace();

                throw new InstallPackageServiceException(e1);

            }

        }

    }

    /**

     * This function will is called when an exception is produced during the

     * installation of a plugin. It will prepare the package to be installed on

     * the next gvSIG restart.

     */

    public void installLater(File applicationDirectory,

        InputStream inputStream, PackageInfo packageInfo)

        throws InstallPackageServiceException, IOException {

    }

}

org.gvsig.educa.portableview.lib.prov.installer.PortableViewInstallerProviderLibrary

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

    <version>1.0.91</version>

  </parent>

  <artifactId>org.gvsig.educa.portableview.lib.prov.installer</artifactId>

  <name>org.gvsig.educa.portableview.lib.prov.installer</name>

  <dependencies>

  	<dependency>

  		<groupId>org.gvsig</groupId>

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

  	</dependency>

  	<dependency>

  		<groupId>org.gvsig</groupId>

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

  	</dependency>

  	<dependency>

  		<groupId>org.gvsig</groupId>

  		<artifactId>org.gvsig.educa.portableview.lib.api</artifactId>

  	</dependency>

  	<dependency>

  		<groupId>org.gvsig</groupId>

  		<artifactId>org.gvsig.educa.portableview.lib.impl</artifactId>

  	</dependency>

  </dependencies>

</project>

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

====

    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.

/* 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.zip.ZipException;

import org.gvsig.fmap.mapcontext.MapContext;

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

/**

 * Portable View Utilities related to files

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface PortableViewFileServices {

    /**

     * <p>

     * Unzip a file into a folder

     * </p>

     * 

     * @param zipFile

     * @param outputFloder

     *            must exists. WARNING: <b>Contents will be removed before

     *            unzip</b>

     * @throws IOException

     * @throws ZipException

     * @throws IllegalArgumentException

     *             if zipFile is not a file or outputFloder doesn't exists or is

     *             read-only

     */

    void unzipFile(File zipFile, File outputFloder) throws ZipException,

        IOException;

    /**

     * <p>

     * Create a zip file which will contains all contents of a folder

     * </p>

     * <p>

     * Files will be use relative path to <code>rootFolder</code>

     * </p>

     * 

     * @param rootFolder

     *            rootFolder (must be an existing folder)

     * @param targetFile

     *            final file (must not exists)

     * @throws IOException

     * @throws IllegalArgumentException

     *             if there are any problem in parameters

     */

    void zipFolder(File rootFolder, File targetFile) throws IOException;

    /**

     * Informs if <code>folder</code> is a writable folder( exists & isDir &

     * canWrite)

     * 

     * @param folder

     * @return

     */

    boolean isWritableFolder(File folder);

    /**

     * Informs if <code>folder</code> is a readable folder( exists & isDir &

     * canRead)

     * 

     * @param folder

     * @return

     */

    boolean isReadableFolder(File folder);

    /**

     * Informs if <code>file</code> is a readable file ( exists & isFile &

     * canRead)

     * 

     * @param file

     * @return

     */

    boolean isReadableFile(File file);

    /**

     * <p>

     * Look for a folder on a <code>baseFolder</code> starts with

     * <code>baseName</code> which is writable.

     * </p>

     * <p>

     * The pattern is: <code>baseFolder/baseName.0000</code> where

     * <code>000</code> it's a counter.

     * </p>

     * 

     * @param baseFolder

     *            existing and writable folder

     * @param baseName

     *            start of new folder

     * @return new folder

     * @throws IllegalArgumentException

     *             if base folder is not a writable folder

     * @throws IllegalStateException

     *             if can't found a suitable folder

     */

    File getWritableFolder(File baseFolder, String baseName);

    /**

     * <p>

     * Create a new folder on a <code>baseFolder</code> starts with

     * <code>baseName</code> which is new and writable.

     * </p>

     * <p>

     * The pattern is: <code>baseFolder/baseName.0000</code> where

     * <code>000</code> it's a counter.

     * </p>

     * 

     * @param baseFolder

     *            existing and writable folder

     * @param baseName

     *            start of new folder

     * @return new folder

     * @throws IllegalArgumentException

     *             if base folder is not a writable folder

     * @throws IllegalStateException

     *             if can't found a suitable folder

     */

    File getNewWritableFolder(File baseFolder, String baseName);

    /**

     * <p>

     * Create {@link File} instance for a new file on a <code>baseFolder</code>

     * starts with <code>baseName</code>.

     * </p>

     * <p>

     * The pattern is: <code>baseFolder/baseName.0000.ext</code> where

     * <code>000</code> it's a counter.

     * </p>

     * <p>

     * This <b>no create</b> the file into the file system.

     * </p>

     * 

     * @param baseFolder

     *            existing and writable folder

     * @param name

     *            start of new file

     * @return new folder

     * @throws IllegalArgumentException

     *             if base folder is not a writable folder

     * @throws IllegalStateException

     *             if can't found a suitable folder

     */

    File getNewFileName(File baseFolder, String name);

    /**

     * <p>

     * Return <code>path</code> as relative from <code>basePath</code> only if

     * <code>basePath</code> is an ancestor of <code>path</code>:

     * </p>

     * 

     * @param path

     * @param basePath

     * @return

     * @see FilenameUtils#getRelativeTo(String, String)

     */

    File getRelativeTo(File path, File basePath);

    /**

     * <p>

     * Load a mapContext from a file adjusting file paths which are supposed

     * relatives to a folder

     * </p>

     * 

     * @param mapContext

     *            persistence file

     * @param relativaPathFolder

     *            for files refered in mapContext

     * @return

     * @throws IOException

     * @throws PersistenceException

     */

    MapContext loadMapContext(File mapContext, File relativaPathFolder)

        throws IOException, PersistenceException;

}

/* 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.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the PortableView library, providing

 * access to all PortableView services through the {@link PortableViewManager} .

 *

 * @author gvSIG team

 * @version $Id$

 */

public class PortableViewLocator extends BaseLocator {

    /**

     * PortableView manager name.

     */

    public static final String MANAGER_NAME = "PortableView.manager";

    /**

     * PortableView manager description.

     */

    public static final String MANAGER_DESCRIPTION = "PortableView Manager";

    /**

     * PortableView file services name.

     */

    public static final String FILESERVICES_NAME = "PortableView.fileservices";

    /**

     * PortableView file services manager description.

     */

    public static final String FILESERVICES_DESCRIPTION =

        "PortableView File Servides";

    private static final String LOCATOR_NAME = "PortableView.locator";

    /**

     * Unique instance.

     */

    private static final PortableViewLocator INSTANCE = new PortableViewLocator();

    /**

     * Return the singleton instance.

     *

     * @return the singleton instance

     */

    public static PortableViewLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Return the Locator's name.

     *

     * @return a String with the Locator's name

     */

    @Override

    public final String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to the PortableViewManager.

     *

     * @return a reference to the PortableViewManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static PortableViewManager getManager() throws LocatorException {

        return (PortableViewManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the PortableViewManager interface.

     *

     * @param clazz

     *            implementing the PortableViewManager interface

     */

    public static void registerManager(Class<? extends PortableViewManager> clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

    /**

     * Return a reference to the PortableViewFileServices.

     *

     * @return a reference to the PortableViewFileServices

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static PortableViewFileServices getFileServices()

        throws LocatorException {

        return (PortableViewFileServices) getInstance().get(FILESERVICES_NAME);

    }

    /**

     * Registers the Class implementing the PortableViewFileServices interface.

     *

     * @param clazz

     *            implementing the PortableViewFileServices interface

     */

    public static void registerFileServices(

        Class<? extends PortableViewFileServices> clazz) {

        getInstance().register(FILESERVICES_NAME, FILESERVICES_DESCRIPTION,

            clazz);

    }

}

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

    /**