Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.andami;

import java.awt.Component;

import java.awt.event.ActionListener;

import java.util.Iterator;

import java.io.File;

import java.util.Locale;

import java.util.MissingResourceException;

import java.util.PropertyResourceBundle;

import java.util.ResourceBundle;

import org.apache.log4j.Logger;

import com.iver.andami.plugins.Extension;

import com.iver.andami.plugins.PluginClassLoader;

import com.iver.andami.ui.mdiFrame.MDIFrame;

import com.iver.andami.ui.mdiFrame.MainFrame;

import com.iver.andami.ui.mdiManager.MDIManager;

import com.iver.utiles.XMLEntity;

/**

 * DOCUMENT ME!

 *

 * @author $author$

 * @version $Revision: 1119 $

 */

public class PluginServices {

    private static Logger logger = Logger.getLogger(PluginServices.class.getName());

    private PluginClassLoader loader;

    private PropertyResourceBundle resourceBundle;

    private XMLEntity persistentXML;

    /**

     * Crea un nuevo PluginServices

     *

     * @param loader DOCUMENT ME!

     */

    public PluginServices(PluginClassLoader loader) {

        this.loader = loader;

    }

    /**

     * Devuelve el mensaje en el idioma del locale actual del texto

     * correspondiente a la clave que se pasa como par?metro

     *

     * @param key Clave del texto que se quiere obtener

     *

     * @return Texto en el idioma que toca o la propia clave si no se encuentra

     *         en el fichero

     */

    public String getText(String key) {

        if (resourceBundle == null) {

            return key;

        }

        if (key == null)

                return null;

        try {

            return resourceBundle.getString(key);

        } catch (MissingResourceException e) {

            logger.warn("No se encontr? la traducci?n para " + key);

            return key;

        }

    }

    /**

     * Obtiene el classloader del plugin

     *

     * @return Returns the loader.

     */

    public PluginClassLoader getClassLoader() {

        return loader;

    }

    /**

     * Obtiene el nombre del plugin

     *

     * @return DOCUMENT ME!

     */

    String getPluginName() {

        return loader.getPluginName();

    }

    /**

     * DOCUMENT ME!

     *

     * @param name

     * @param locale

     */

    void setResourceBundle(String name, Locale locale) {

            try{

            resourceBundle = (PropertyResourceBundle) ResourceBundle.getBundle(name, locale, loader);

            }catch (MissingResourceException e) {

                    logger.error("No se encontr? el recurso de traducciones " + name, e);

                }

    }

    /**

     * Obtienen una referencia al PluginServices del plugin cuyo nombre se pasa

     * como par?metro

     *

     * @param pluginClassInstance Instancia de una clase propia del plugin a cuyos

     * servicios se quiere acceder

     *

     * @return DOCUMENT ME!

     */

    public static PluginServices getPluginServices(Object pluginClassInstance) {

            try{

                    PluginClassLoader loader = (PluginClassLoader) pluginClassInstance.getClass().getClassLoader();

                    return Launcher.getPluginServices(loader.getPluginName());

            }catch (ClassCastException e) {

                    throw new RuntimeException("Parameter is not a plugin class instance");

                }

    }

    /**

     * Obtienen una referencia al PluginServices del plugin cuyo nombre se pasa

     * como par?metro

     *

     * @param pluginClassInstance Instancia de una clase propia del plugin a cuyos

     * servicios se quiere acceder

     *

     * @return DOCUMENT ME!

     */

    public static PluginServices getPluginServices(String pluginName) {

                   return Launcher.getPluginServices(pluginName);

    }

    /**

     * Obtiene una referencia al gestor de ventanas

     *

     * @return DOCUMENT ME!

     */

    public static MDIManager getMDIManager() {

        return Launcher.getFrame().getMDIManager();

    }

    public static MainFrame getMainFrame() {

            return Launcher.getFrame();

    }

    public static Extension getExtension(Class extensionClass){

            return (Extension) Launcher.getClassesExtensions().get(extensionClass);

    }

    public static Iterator getExtensions(){

            return Launcher.getClassesExtensions().values().iterator();

    }

    public static String getText(Object pluginObject, String key){

            try 

                {

                    PluginServices ps = getPluginServices(pluginObject);                

                    return ps.getText(key);

                }

            catch(RuntimeException e)

                {

                    logger.error("GetText: Clave = " + key + ". ", e);

                    return key;                    

                }

    }

    /**

     * Establece los datos del plugin que deber?n persistir entre ejecuciones

     * en formato xml

     *

     * @param entity DOCUMENT ME!

     */

    public void setPresistentXML(XMLEntity entity) {

        persistentXML = entity;

    }

    /**

     * Obtiene un objeto que representa la persistencia del plugin en formato

     * xml

     *

     * @return DOCUMENT ME!

     */

    public XMLEntity getPersistentXML() {

        return persistentXML;

    }

    /**

     * DOCUMENT ME!

     *

     * @param name DOCUMENT ME!

     * @param c DOCUMENT ME!

     * @param listener DOCUMENT ME!

     *

     * @throws RuntimeException DOCUMENT ME!

     */

    public void addPopupMenuListener(String name, Component c,

        ActionListener listener) {

        MDIFrame frame = Launcher.getFrame();

        if (frame == null) {

            throw new RuntimeException("MDIFrame not loaded yet");

        }

        frame.addPopupMenuListener(name, c, listener, loader);

    }

    public File getPluginDirectory(){

            return new File(Launcher.getPluginsDir() + File.separator + getPluginName());

    }

}