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.thematicmap;

import java.io.File;

import java.io.IOException;

import java.util.List;

import org.gvsig.educa.thematicmap.compilation.ThematicMapCompilation;

import org.gvsig.educa.thematicmap.compilation.ThematicMapCompiler;

import org.gvsig.educa.thematicmap.editor.ThematicMapAddLayerComponent;

import org.gvsig.educa.thematicmap.editor.ThematicMapCompilationEditor;

import org.gvsig.educa.thematicmap.editor.ThematicMapLayerPropertiesEditor;

import org.gvsig.educa.thematicmap.editor.ThematicMapLayersEditor;

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

import org.gvsig.educa.thematicmap.map.InvalidThematicMapFormatException;

import org.gvsig.educa.thematicmap.map.ThematicMap;

import org.gvsig.educa.thematicmap.map.ThematicMapInformation;

import org.gvsig.educa.thematicmap.viewer.MapControlToolRegistrant;

import org.gvsig.educa.thematicmap.viewer.ThematicMapInformationViewer;

import org.gvsig.educa.thematicmap.viewer.ThematicMapToc;

import org.gvsig.educa.thematicmap.viewer.ThematicMapTocImageProvider;

import org.gvsig.educa.thematicmap.viewer.ThematicMapViewer;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.ServiceException;

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

/**

 * Library Manager.

 * </p>

 * Expose main library's functionalities:

 * <ul>

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

 * <li>Get installed <i>Thematic Map</i></li>

 * <li>Identify and get a <i>Thematic Map</i> from a file</li>

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

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

 * </ul>

 * 

 * @author gvSIG team

 * @version $Id$

 */

public interface ThematicMapManager extends Disposable, Manager {

    /**

     * Gets default folder to locate installed <i>Thematic Map</i>

     * 

     * @return default installation folder

     */

    String getInstallationMapFolder();

    /**

     * Sets default folder to locate installed <i>Thematic Map</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>Thematic

     * Map</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>Thematic Map</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>Thematic Map</i> installed

     * </p>

     * Uses installation folder to locate them

     * 

     * @return All <i>Thematic Map></i> installed

     */

    List<ThematicMap> getInstalledMaps();

    /**

     * Returns all <i>Thematic Map</i> installed into the specified folder

     * </p>

     * Uses installation folder to locate them

     * 

     * @param folder

     *            to analyze

     * @return All <i>Thematic Map></i> installed

     * @throws IllegalArgumentException

     *             if folder is not valid (a readable folder)

     */

    List<ThematicMap> getInstalledMaps(String folder);

    /**

     * Gets a {@link ThematicMap} from a file

     * </p>

     * 

     * @param file

     * @return the <i>Thematic Map</i>

     * @throws InvalidThematicMapFormatException

     */

    ThematicMap getMapFromFile(File file)

        throws InvalidThematicMapFormatException;

    /**

     * Gets a {@link ThematicMap} from intalledMaps

     * by its id

     * </p>

     * 

     * @param mapid

     *            ThematicMap id

     * @return the <i>Thematic Map</i>

     */

    ThematicMap getMapById(String mapId);

    /**

     * Informs if a file is a valid <i>Thematic Map</i> file

     * 

     * @param file

     * @return

     */

    boolean isMap(File file);

    /**

     * Informs if a folder is a valid <i>Thematic Map</i> installed folder

     * 

     * @param file

     * @return

     */

    boolean isAThematicMapIntalledFolder(File folder);

    /**

     * Creates a new instance of a {@link ThematicMapCompilation} for a

     * game with the given name.

     * 

     * @return the compilation

     * @throws ServiceException

     *             if there is an error creating the compilation

     */

    ThematicMapCompilation createCompilationInstance(String gameName)

        throws ServiceException;

    /**

     * Creates a new instance of a {@link ThematicMapCompilation} without

     * any active game.

     * 

     * @return the compilation

     * @throws ServiceException

     *             if there is an error creating the compilation

     */

    ThematicMapCompilation createCompilationInstance() throws ServiceException;

    /**

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

     * values <code>map</code>

     * 

     * @param map

     *            to use as template

     * @return

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidThematicMapFormatException

     */

    ThematicMapCompilation createCompilationInstanceFromMap(ThematicMap map)

        throws InvalidThematicMapFormatException, CantLoadContextException,

        IOException;

    /**

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

     * 

     * @return

     */

    ThematicMapCompiler createCompilerInstance();

    /**

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

     * 

     * @param info

     * @return

     */

    String getBaseFileNameFromInfo(ThematicMapInformation info);

    /**

     * Generates the base name for a ThematicMap file

     * 

     * @param info

     * @return

     */

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

        int buildNumber);

    /**

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

     * 

     * @param mapId

     *            id of map to export

     * @param targetFolder

     *            where write package file

     * @return

     * @throws ThematicMapException

     * @throws IOException

     */

    File generatePackageFile(String mapId, File targetFolder)

        throws ThematicMapException, IOException;

    /**

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

     * 

     * @param thematicMapIntallFolder

     *            folder of a installed ThematicMap

     * @param targetFolder

     *            where write package file

     * @return

     * @throws ThematicMapException

     * @throws IOException

     */

    File generatePackageFile(File thematicMapIntallFolder, File targetFolder)

        throws ThematicMapException, 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);

    /**

     * Get a {@link ThematicMapViewer} to show the <code>thematicMap</code>

     * 

     * @param thematicMap

     * @return

     * @throws IOException

     * @throws CantLoadContextException

     * @throws InvalidThematicMapFormatException

     */

    public ThematicMapViewer getViewer(ThematicMap thematicMap)

        throws InvalidThematicMapFormatException, CantLoadContextException,

        IOException;

    /**

     * Get a {@link ThematicMapCompilationEditor} to modify the

     * <code>thematicMapCompilation</code>

     * 

     * @param thematicMapCompilation

     * @param editLayers

     * @return

     */

    public ThematicMapCompilationEditor getCompilationEditor(

        ThematicMapCompilation thematicMapCompilation, boolean editLayers);

    /**

     * Returns the {@link ThematicMapWindowManager}.

     * 

     * @return {@link ThematicMapWindowManager}

     * @see {@link ThematicMapWindowManager}

     */

    public ThematicMapWindowManager getWindowManager();

    /**

     * Registers a new instance of a WindowManager which provides services to

     * the management of the application windows.

     * 

     * @param manager

     *            {@link ThematicMapWindowManager} to register in the

     *            ScriptingUIManager.

     * @see ThematicMapWindowManager

     */

    public void registerWindowManager(ThematicMapWindowManager manager);

    /**

     * Returns a new instance of {@link ThematicMapToc}

     * 

     * @return

     */

    public ThematicMapToc newToc();

    /**

     * Register the class for {@link ThematicMapToc} components

     * 

     * @param tocComponentClass

     */

    public void registerTocComponent(

        Class<? extends ThematicMapToc> tocComponentClass);

    /**

     * Returns a new instance of {@link ThematicMapAddLayerComponent}

     * 

     * @return

     * @throws ThematicMapRuntimeException

     *             on a instance creation problem

     */

    public ThematicMapAddLayerComponent newAddLayerComponent();

    /**

     * Register the class for {@link ThematicMapAddLayerComponent} components

     * 

     * @param addLayerComponent

     */

    public void registerAddLayerComponent(

        Class<? extends ThematicMapAddLayerComponent> addLayerComponent);

    /**

     * Returns a new instance of {@link ThematicMapLayerPropertiesEditor}

     * 

     * @return

     * @throws ThematicMapRuntimeException

     *             on a instance creation problem

     */

    public ThematicMapLayerPropertiesEditor newLayerPropertiesEditor();

    /**

     * Register the class for {@link ThematicMapLayerPropertiesEditor}

     * components

     * 

     * @param addLayerComponent

     */

    public void registerLayerPropertiesEditor(

        Class<? extends ThematicMapLayerPropertiesEditor> layerPropertiesEditorClass);

    /**

     * Returns a new instance of {@link ThematicMapLayersEditor}

     * 

     * @return

     * @throws ThematicMapRuntimeException

     *             on a instance creation problem

     */

    public ThematicMapLayersEditor newLayersEditor();

    /**

     * Register the class for {@link ThematicMapLayersEditor} components

     * 

     * @param addLayerComponent

     * 

     */

    public void registerLayersEditor(

        Class<? extends ThematicMapLayersEditor> layersEditorClass);

    /**

     * Returns a new instance of {@link ThematicMapInformationViewer}

     * 

     * @return

     * @throws ThematicMapRuntimeException

     *             on a instance creation problem

     */

    public ThematicMapInformationViewer newInformationViewer();

    /**

     * Register the class for {@link ThematicMapInformationViewer} components

     * 

     * @param addLayerComponent

     * 

     */

    public void registerInformationViewer(

        Class<? extends ThematicMapInformationViewer> informationViewerClass);

    /**

     * Sets the default image icon provider to represents layers and preview

     * symbology in Thematic Maps TOC

     * 

     * @param imageProvider

     */

    public void setDefaultTocImageProvider(

        ThematicMapTocImageProvider imageProvider);

    /**

     * Gets the default image icon provider to represents layers and preview

     * symbology in Thematic Maps TOC

     * 

     * @param imageProvider

     */

    public ThematicMapTocImageProvider getDefaultTocImageProvider();

    /**

     * Register an instance of a {@link MapControlToolRegistrant} which

     * register

     * tools in all new {@link ThematicMapViewer} instances

     * 

     * @param registrant

     */

    public void addMapControlRegistrant(MapControlToolRegistrant registrant);

    /**

     * Returns a read-only list of all current {@link MapControlToolRegistrant}

     * 

     * @return

     */

    public List<MapControlToolRegistrant> getMapControlRegistrantList();

    public ProviderManager getProviderManager();

}