Application: gvSIG desktop

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

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.installer.swing.api;

import java.io.File;

import javax.swing.JPanel;

import org.gvsig.installer.swing.api.creation.MakePluginPackageWizard;

import org.gvsig.installer.swing.api.creation.MakePluginPackageWizardException;

import org.gvsig.installer.swing.api.execution.InstallPackageWizard;

import org.gvsig.installer.swing.api.execution.InstallPackageWizardException;

/**

 * 

 * <p>

 * This manager is used to register and create the wizards that are used to

 * create and execute an installer. These wizards are classes that inherit of

 * {@link JPanel}.

 * </p>

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface SwingInstallerManager {

    /**

     * Registers a class that implements a wizard to create an installer

     * of a plugin from a gvSIG installation directory.

     * 

     * @param clazz

     *            Class that inherits of the {@link MakePluginPackageWizard}

     *            abstract class.

     */

    public void registerMakePluginPackageWizardInstallerCreationWizard(

        Class<? extends MakePluginPackageWizard> clazz);

    /**

     * This method returns a class that is used to create an

     * installer from a gvSIG installation directory.

     * 

     * @return

     *         The wizard to create an installer.

     * @throws MakePluginPackageWizardException

     *             If there is a problem creating the wizard.

     */

    public MakePluginPackageWizard createMakePluginPackageWizard(

        File applicationDirectory, File pluginsFolder, File installFolder)

        throws MakePluginPackageWizardException;

    /**

     * Registers a class that implements a wizard to execte an installer

     * to install a set of plugins in a gvSIG installation directory.

     * 

     * @param clazz

     *            Class that inherits of the {@link InstallPackageWizard}

     *            abstract class.

     */

    public void registerInstallPackageWizard(

        Class<? extends InstallPackageWizard> clazz);

    /**

     * This method returns a class that is used to execute an

     * installer to install a set of plugins in a gvSIG installation directory.

     * 

     * @return

     *         The wizard to execute an installer.

     * @throws InstallPackageWizardException

     *             If there is a problem creating the wizard.

     */

    public InstallPackageWizard createInstallPackageWizard(

        File applicationDirectory, File pluginsFolder, File installFolder)

        throws InstallPackageWizardException;

    /**

     * Returns the current application version.

     * 

     * @return the current application version

     */

    public String getApplicationVersion();

    /**

     * Sets the current application version.

     * 

     * @param gvSIGVersion

     *            the current application version

     */

    public void setApplicationVersion(String gvSIGVersion);

    /**

     * Translate a key in a text using the current application language

     * 

     * @param key

     *            The key to translate

     * @return

     *         The translated key

     */

    public String getText(String key);

}