Aplicación gvSIG con fines educativos

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

    /**

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

}