Aplicación gvSIG con fines educativos » Interfaz de usuario

<?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.List;

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

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

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

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

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

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

import org.gvsig.tools.dispose.Disposable;

/**

 * Library Manager.

 * </p>

 * Expose main library's functionalities:

 * <ul>

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

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

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

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

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

 * </ul>

 *

 * @author gvSIG team

 * @version $Id$

 */

public interface PortableViewManager extends Disposable {

    public static final String  INSTALLER_PROVIDER_NAME = "PortableView";

    /**

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

     *

     * @return default installation folder

     */

    String getInstallationMapFolder();

    /**

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

     *

     * @param folder

     * @throws IllegalArgumentException

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

     */

    void setInstallationMapFolder(String folder);

    /**

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

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

     *

     * @return temporal folder

     */

    String getTemporalFolder();

    /**

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

     *

     * @param folder

     * @throws IllegalArgumentException

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

     */

    void setTemporalFolder(String folder);

    /**

     * Clear all data in temporal folder

     */

    void cleanAllTemporalData();

    /**

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

     * </p>

     * Uses installation folder to locate them

     *

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

     */

    List<PortableView> getInstalledMaps();

    /**

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

     * </p>

     * Uses installation folder to locate them

     *

     * @param folder

     *            to analyze

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

     * @throws IllegalArgumentException

     *             if folder is not valid (a readable folder)

     */

    List<PortableView> getInstalledMaps(String folder);

    /**

     * Gets a {@link PortableView} from a file

     * </p>

     *

     * @param file

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

     * @throws InvalidPortableViewFormatException

     */

    PortableView getMapFromFile(File file)

        throws InvalidPortableViewFormatException;

    /**

     * Gets a {@link PortableView} from intalledMaps

     * by its id

     * </p>

     *

     * @param mapid

     *            PortableView id

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

     */

    PortableView getMapById(String mapId);

    /**

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

     *

     * @param file

     * @return

     */

    boolean isMap(File file);

    /**

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

     *

     * @param file

     * @return

     */

    boolean isAPortableViewIntalledFolder(File folder);

    /**

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

     *

     * @return

     */

    PortableViewCompilation createCompilationInstance();

    /**

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

     * values <code>map</code>

     *

     * @param map

     *            to use as template

     * @return

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidPortableViewFormatException

     */

    PortableViewCompilation createCompilationInstanceFromMap(PortableView map)

        throws InvalidPortableViewFormatException, CantLoadContextException,

        IOException;

    /**

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

     *

     * @return

     */

    PortableViewCompiler createCompilerInstance();

    /**

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

     *

     * @param info

     * @return

     */

    String getBaseFileNameFromInfo(PortableViewInformation info);

    /**

     * Generates the base name for a PortableView file

     *

     * @param info

     * @return

     */

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

        int buildNumber);

    /**

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

     *

     * @param mapId

     *            id of map to export

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(String mapId, File targetFolder)

        throws PortableViewException, IOException;

    /**

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

     *

     * @param portableViewIntallFolder

     *            folder of a installed PortableView

     * @param targetFolder

     *            where write package file

     * @return

     * @throws PortableViewException

     * @throws IOException

     */

    File generatePackageFile(File portableViewIntallFolder, File targetFolder)

        throws PortableViewException, IOException;

    /**

     * Returns the translation of a string.

     *

     * @param key

     *            String to translate

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

     */

    public String getTranslation(String key);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

import org.gvsig.educa.portableview.PortableViewException;

/**

 * Exception Throws in a PortableView compilation process

 *

 * @author gvSIG Team

 * @version $Id$

 *

 */

public class CompilationException extends PortableViewException {

    /**

     *

     */

    private static final long serialVersionUID = -1052257268555865780L;

    private static final String MESSAGE =

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

    private static final String KEY = "_CompilationException";

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param message

     *            problem description

     * @param cause

     */

    public CompilationException(String portableViewId, String message,

        Throwable cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

        setValue("info", message);

        setValue("portableViewId", portableViewId);

    }

    /**

     * Invalid format of a portable view file

     *

     * @param mapFile

     * @param mapContextFile

     * @param cause

     */

    public CompilationException(String portableViewId, Throwable cause) {

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

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public interface CompilationValidationMessage {

    public enum Type {

        MESSAGE, WARNING, ERROR

    };

    Type getType();

    String getMessage();

    String getSource();

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

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

 *

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

 * @version $Id$

 */

public interface PortableViewCompiler {

    /**

     * Gets temporal folder used by the process to prepare file

     *

     * @return

     */

    String getWorkFolder();

    /**

     * Sets temporal folder used by the process to prepare file

     *

     * @param folder

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setWorkFolder(String folder);

    /**

     * Gets folder used to deploy generated file

     *

     * @return

     */

    String getTargetFolder();

    /**

     * Sets folder where deploy generated file

     *

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setTargetFolder(String folder);

    /**

     * Set the process listener

     *

     * @param listener

     */

    void setCompilerListener(PortableViewCompilerListener listener);

    /**

     * <p>

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

     * </p>

     * <p>

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

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

     * </p>

     *

     * @param compilation

     * @return

     * @throws IllegalArgumentException

     *             if targetFolder or workFolder are not set

     */

    PortableViewCompilerStatus compile(PortableViewCompilation compilation);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

import java.util.List;

import org.gvsig.fmap.mapcontext.MapContext;

/**

 * Interface for classes which contain all information needed to

 * generate a new Portable View file

 *

 * @author gvSIG Team

 * @version $Id$

 */

public interface PortableViewCompilation {

    /**

     * <p>

     * Gets object which contain PortableView information

     * </p>

     * <p>

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

     * </p>

     *

     * @return

     */

    PortableViewCompilationInformation getInformation();

    /**

     * Gets current map context

     *

     * @return

     */

    MapContext getMapContext();

    /**

     * Sets map context for PortableView

     *

     * @param mapContext

     */

    void setMapContext(MapContext mapContext);

    /**

     * Validates compilation

     *

     * @param messages

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

     *            messages

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

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

     */

    boolean isValid(List<CompilationValidationMessage> messages);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

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

 * of the Valencian Government (CIT)

 *

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

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

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

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

 *

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

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

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

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

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

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

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

import java.io.File;

import org.gvsig.tools.task.TaskStatus;

/**

 * Status of a Compiler process

 *

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

 * @version $Id$

 */

public interface PortableViewCompilerStatus extends TaskStatus {

    /**

     * Available status of a {@link PortableViewCompilerStatus}

     *

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

     * @version $Rev$

     * @since {version}

     */

    enum Status {

        preparing, processing, canceled, finished_ok, finished_fail, finished_error

    };

    /**

     * Gets current status

     *

     * @return

     */

    Status getStatus();

    /**

     * Current step

     *

     * @return

     */

    int getCurrentStep();

    /**

     * Total steps

     *

     * @return

     */

    int getTotalSteps();

    /**

     * Current step i18n description key

     *

     * @return

     */

    String getCurrentStepKey();

    /**

     * Gets message from current step

     */

    String getCurrentStepMessage();

    /**

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

     *

     * @return

     */

    File getGeneratedPortableViewFile();

    /**

     * Gets generated folder of installed portableView for gvSIG installer

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

     *

     * @return

     */

    File getGeneratedInstalationPortableViewFolder();

    /**

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

     * {@link Status#finished_error})

     *

     * @return

     */

    String getFailMessage();

    /**

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

     *

     * @return

     */

    Throwable getException();

    /**

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

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

     *

     * @return

     */

    PortableViewCompilation getResultCompilation();

}

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

/**

 * Interface for a Listener of {@link PortableViewCompiler} process

 * 

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

 * @version $Id$

 */

public interface PortableViewCompilerListener {

    /**

     * Called when process status changes: next step, process percentage

     * changes, etc

     * 

     * @param currentStatus

     */

    void updatedStatus(PortableViewCompilerStatus currentStatus);

    /**

     * Called when process notify a warning

     * 

     * @param message

     *            of the warning

     * @param currentStatus

     */

    void notifyWarning(String message, PortableViewCompilerStatus currentStatus);

    /**

     * Called when process found an exception

     * 

     * @param currentStatus

     */

    void notifyException(PortableViewCompilerStatus currentStatus);

}

/* 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.map.PortableViewInformation;

/**

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface PortableViewCompilationInformation extends

    PortableViewInformation {

    /**

     * Sets <i>Portable View</i> id

     *

     * @param Name

     */

    void setId(String id);

    /**

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

     *

     * @param Name

     */

    void setName(String Name);

    /**

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

     *

     * @param description

     */

    void setDescription(String description);

    /**

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

     *

     * @param version

     */

    void setVersion(int version);

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.educa.portableview package documentation</title>

</head>

<body>

	<p>PortableView library API.</p>

	<p>

	It allows to get new PortableView and get their text.

	</p>

</body>

</html>

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