Aplicación gvSIG con fines educativos

org.gvsig.educa.portableview.PortableViewLibrary

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview;

import org.gvsig.tools.exception.BaseException;

/**

 * Generic exception thrown in the PortableView API when the exception or error

 * may be dealt by the program or the user of the program which is a client of

 * the PortableView API.

 *

 * @see {@link PortableViewService}

 * @see {@link PortableViewManager}

 * @author gvSIG team.

 * @version $Id$

 */

public class PortableViewException extends BaseException {

    private static final long serialVersionUID = 6756475060924237176L;

    private static final String MESSAGE =

        "An error has been produced in the PortableView library";

    private static final String KEY = "_PortableViewException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public PortableViewException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     *

     * @param cause

     *            the original cause of the exception

     */

    public PortableViewException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected PortableViewException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected PortableViewException(String message, Throwable cause, String key,

        long code) {

        super(message, cause, key, code);

    }

}

/* 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.exception.BaseRuntimeException;

/**

 * Generic exception thrown in the PortableView API when the exception or error

 * may be dealt by the program or the user of the program which is a client of

 * the PortableView API.

 *

 * @see {@link PortableViewService}

 * @see {@link PortableViewManager}

 * @author gvSIG team.

 * @version $Id$

 */

public class PortableViewRuntimeException extends BaseRuntimeException {

    /**

     *

     */

    private static final long serialVersionUID = -4039843730204021312L;

    private static final String MESSAGE =

        "An error has been produced in the PortableView library";

    private static final String KEY = "_PortableViewRuntimeException";

    public PortableViewRuntimeException(String message) {

        super(message, KEY, serialVersionUID);

    }

    /**

     *

     * @param cause

     *            the original cause of the exception

     */

    public PortableViewRuntimeException(String message, Exception cause) {

        super(message, cause, KEY, serialVersionUID);

    }

    /**

     *

     * @param cause

     *            the original cause of the exception

     */

    public PortableViewRuntimeException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected PortableViewRuntimeException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected PortableViewRuntimeException(String message, Throwable cause, String key,

        long code) {

        super(message, cause, key, code);

    }

}

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

    /**

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

     *

     * @return

     */

    PortableViewCompiler createCompilerInstance();

    /**

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

     *

     * @param info

     * @return

     */

    String getBaseFileNameFromInfo(PortableViewInformation info);

    /**

     * Generates the base name for a PortableView file

     *

     * @param info

     * @return

     */

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

        int buildNumber);

    /**

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

     *

     * @param mapId

     *            id of map to export

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(String mapId, File targetFolder)

        throws PortableViewException, IOException;

    /**

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

     *

     * @param portableViewIntallFolder

     *            folder of a installed PortableView

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(File portableViewIntallFolder, File targetFolder)

        throws PortableViewException, IOException;

    /**

     * Returns the translation of a string.

     *

     * @param key

     *            String to translate

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

     */

    public String getTranslation(String key);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws in a PortableView compilation process

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class CompilationException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = -1052257268555865780L;

    private static final String MESSAGE =

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

    private static final String KEY = "_CompilationException";

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param message

     *            problem description

     * @param cause

     */

    public CompilationException(String portableViewId, String message,

        Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("portableViewId", portableViewId);

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param cause

     */

    public CompilationException(String portableViewId, Throwable cause) {

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

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface CompilationValidationMessage {

    public enum Type {

        MESSAGE, WARNING, ERROR

    };

    Type getType();

    String getMessage();

    String getSource();

}