Application: gvSIG desktop » gvSIG tools: ToolBox

import es.unex.sextante.gui.cmd.ScriptAlgorithmProvider;

import es.unex.sextante.gui.help.HelpIO;

import es.unex.sextante.gui.modeler.ModelerAlgorithmProvider;

import es.unex.sextante.gui.settings.Setting;

import es.unex.sextante.gui.settings.SextanteGeneralSettings;

import es.unex.sextante.gui.settings.SextanteRSettings;

import es.unex.sextante.gui.settings.SextanteSagaSettings;

import es.unex.sextante.gui.settings.SextanteScriptsSettings;

 * used by GUI elements

 */

public class SextanteGUI {

   public static final int                            HISTORY                     = 0;

   public static final int                            COMMANDLINE                 = 1;

   private static boolean                             m_bShowOnlyActiveAlgorithms = false;

   private static String                              m_sOutputFolder;

   private static HashMap<String, String>             m_Settings                  = new HashMap<String, String>();

   private static HashMap<String, String>             m_DefaultSettings           = new HashMap<String, String>();

   private static IDataRenderer                       m_Renderer;

   private final static HashMap<String, Class>        m_ParametersPanel           = new HashMap<String, Class>();

   public final static Color COLOR_PURPLE = new Color(163, 71, 255, 255);

   public final static Color COLOR_BROWN_LIGHT = new Color(255, 168, 82, 255);

   public final static Color COLOR_BROWN_DARK = new Color(204, 102, 0, 255);

      m_AlgorithmProviders.add(new ScriptAlgorithmProvider());

      m_AlgorithmProviders.add(new ModelerAlgorithmProvider());

   /**

    * Sets a new main frame. This will be used as the parent frame by SEXTANTE GUI elements

    * @param frame

    *                The main frame

    */

   /**

    * Returns the current main frame

    * @return the current main frame

    */

   public static Frame getMainFrame() {

   /**

    * Returns the current input factory

    * @see IInputFactory.

    * @return the current input factory

    */

   /**

    * Sets a new input factory as the current one

    * @param inputFactory

    *                the new input factory

    */

   /**

    * Returns the current OutputFactory

    * @return the current OutputFactory

    */

   public static OutputFactory getOutputFactory() {

   /**

    * sets a new output factory

    * @param outputFactory

    *                the new output factory

    */

   /**

    * Returns the current GUIFactory

    * @return the current GUIFactory

    */

   public static IGUIFactory getGUIFactory() {

   /**

    * sets a new GUI factory

    * @param guiFactory

    *                the new GUI factory

    */

   /**

    * Returns the task to post-process the algorithm outputs, usually to add them to the GUI of the GIS app.

    * @param alg

    *                the algorithm to postprocess. Since this task will mainly deal with output results, the algorithm should have

    *                been previously executed, so it contains non-null output values

    *                if this parameter is true, the task will show the results dialog if the algorithm has produced some kind of

    *                output other than layers or tables. If it is false, those results will be added to the set of current

    *                results, but the results dialog will not be shown

    * @return a task to postprocess the given algorithm

    */

   public static Runnable getPostProcessTask(final GeoAlgorithm alg,

   /**

    * Sets the current post process task factory

    * @param factory

    *                the new post-process task factory

    */

   /**

    * Adds an algorithm provider. This has to be done before calling initialize(), so the providers can be initialized as well.

    * @param provider

    *                the algorithm provider to add

    */

   /**

    * Checks if a portable directory exists and has the required access privileges.

    * Non-existing directories will be created if possible.

    * @param dir String with name of folder/directory to be checked. Use only a relative path here.

    * @param read_only set to "true" if only read access is required

    * @param provider name of the algorithm provider for which this folder is being checked.

    * @return "0" if all is OK, "1" if directory does not exist and could not be created, "2" if access is forbidden, "3" if a _file_ with that name already exists

    */

   public static int checkDir ( String dir, boolean read_only, String provider ) {

	  if ( f.exists() ) {

		  if ( f.isFile() ) {

					  Sextante.getText("portable_dir_is_file") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

					  , "Inane warning", JOptionPane.WARNING_MESSAGE);

		  if ( read_only ) {

			  if ( f.canRead() ) {

				  return ( 0 );

		  }

		  if ( f.canWrite() ) {

			  return ( 0 );

		  }

		  if ( read_only ) {

					  Sextante.getText("portable_dir_error") + " " + f.getAbsolutePath() +

					  Sextante.getText("portable_dir_error_ro") + "\n" + ":" +

					  Sextante.getText("portable_dir_no_access") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

					  , "Inane warning", JOptionPane.WARNING_MESSAGE);

		  } else {

					  Sextante.getText("portable_dir_error") + " " + f.getAbsolutePath() +

					  Sextante.getText("portable_dir_error_rw") + "\n" + ":" +

					  Sextante.getText("portable_dir_no_access") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

		  }

	  }

	  /* directory does not exist: attempt to create it */

	  if ( f.mkdir() == false ) {

				  Sextante.getText("portable_dir_no_create") + "\n" +

				  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

		  return ( 1 );

	  }

	  return ( 0 );

   }

   /**

    * Checks if a file exists in one of the portable folders, and if it has the required access privileges.

    * @param file String with name of file to be checked. Use only a relative path here.

    * @param read_only set to "true" if only read access is required

    * @param provider name of the algorithm provider for which this file is being checked.

    * @return "0" if all is OK, "1" if file does not exist, "2" if access is forbidden, "3" if a _directory_ with that name already exists

    */

   public static int checkFile ( String file, boolean read_only, String provider ) {

	  if ( f.exists() ) {

		  if ( f.isDirectory() ) {

					  Sextante.getText("portable_file_is_dir") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

					  , "Inane warning", JOptionPane.WARNING_MESSAGE);

		  if ( read_only ) {

			  if ( f.canRead() ) {

				  return ( 0 );

		  }

		  if ( f.canWrite() ) {

			  return ( 0 );

		  }

		  if ( read_only ) {

					  Sextante.getText("portable_file_error") + " " + f.getAbsolutePath() +

					  Sextante.getText("portable_file_error_ro") + "\n" + ":" +

					  Sextante.getText("portable_file_no_access") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

					  , "Inane warning", JOptionPane.WARNING_MESSAGE);

		  } else {

					  Sextante.getText("portable_file_error") + " " + f.getAbsolutePath() +

					  Sextante.getText("portable_file_error_rw") + "\n" + ":" +

					  Sextante.getText("portable_file_no_access") + "\n" +

					  Sextante.getText("portable_provider_not_usable") + " <html></i>" + provider + "+</i>+</html>."

		  }

	  }

	  return ( 1 );

   /**

    * Portable SEXTANTE requires that external providers' (e.g. GRASS) algorithms

    * and user-editable scripts are stored in folders within the SEXTANTE extension

    * warning if anythign goes wrong.

    */

   public static void checkPortableFolders () {

	   String sPath;

	   int result;

	   sPath = new String ("");

	   if ( Boolean.parseBoolean(SextanteGUI.getSettingParameterValue(SextanteRSettings.R_PORTABLE)) == true ) {

		   /* set R binaries folder */

		   result = checkDir ( Sextante.PORTABLE_R_FOLDER, true, "R" );

		   /* set R user scripts folder */

		   result = checkDir ( Sextante.PORTABLE_R_SCRIPTS_FOLDER, false, "R user scripts" );

		   SextanteGUI.setSettingParameterValue(SextanteRSettings.R_SCRIPTS_FOLDER, sPath);

	   }

	   if ( Boolean.parseBoolean(SextanteGUI.getSettingParameterValue(SextanteGrassSettings.GRASS_PORTABLE)) == true ) {

		   /* set GRASS binaries folder */

		   result = checkDir ( Sextante.PORTABLE_GRASS_FOLDER, true, "GRASS GIS" );

		   SextanteGUI.setSettingParameterValue(SextanteGrassSettings.GRASS_FOLDER, sPath);

		   /* set GRASS shell support (MSYS) binaries folder (Windows only) */

		   if ( Sextante.isWindows() ) {

			   result = checkFile ( Sextante.PORTABLE_MSYS_FILE, true, "GRASS GIS shell scripts" );

			   SextanteGUI.setSettingParameterValue(SextanteGrassSettings.GRASS_WIN_SHELL, sPath);

		   }

	   }

	   if ( Boolean.parseBoolean(SextanteGUI.getSettingParameterValue(SextanteSagaSettings.SAGA_PORTABLE)) == true ) {

		   /* set SAGA binaries folder */

		   result = checkDir ( Sextante.PORTABLE_SAGA_FOLDER, true, "SAGA GIS" );

		   SextanteGUI.setSettingParameterValue(SextanteSagaSettings.SAGA_FOLDER, sPath);

	   }

	   if ( Boolean.parseBoolean(SextanteGUI.getSettingParameterValue(SextanteScriptsSettings.SCRIPTS_PORTABLE)) == true ) {

		   /* set user scripts folder */

		   SextanteGUI.setSettingParameterValue(SextanteScriptsSettings.SCRIPTS_FOLDER, sPath);

	   }

	   if ( Boolean.parseBoolean(SextanteGUI.getSettingParameterValue(SextanteModelerSettings.MODELS_PORTABLE)) == true ) {

		   /* set user models folder */

		   SextanteGUI.setSettingParameterValue(SextanteModelerSettings.MODELS_FOLDER, sPath);

   }

   /**

    * Initializes the GUI parameters and resources. It takes GUI resources (custom panels, etc.) from classpath jars. Should be

    * called before setting parameters using other methods from this class, except for the setSextantePath() and

   /**

    * Initializes the GUI parameters and resources. It takes GUI resources (custom panels, etc.) from the specified urls. Should

    * be called before setting parameters using other methods from this class, except for the setSextantePath() method.

    * @param jars

    *                the urls of the jar files with custom GUI resources

    */

   /**

    * Initializes the GUI parameters and resources. It takes GUI resources (custom panels, etc.) from the specified folder. Should

    * be called before setting parameters using other methods from this class, except for the setSextantePath() method.

    * @param sFolder

    *                the folder with jars with custom GUI resources

    */

      readConfigFile();

      checkPortableFolders();

      //this loads built-in SEXTANTE algorithms and resources

      loadResources();

            addCustomParametersPanel(provider.getCustomParameterPanels());

         }

      }

   }

   /**

    * This methods sets default setting values different from the hard-coded ones. It should be called right before initializing

    * this class

    * @param map

    *                the map with new default settings

    */

   /**

    * Returns the path to help files

    * @return the path to help files

    */

   public static String getHelpPath() {

   }

   /**

    * Sets the current path to sextante folder. This is the folder where help files and additional software should be located.

    * This should be done before initializing this class, since this folder is used by some algorithm providers

    * @param sPath

    *                the path to sextante help and additional programs

    */

   public static void setSextantePath(final String sPath) {

   }

   /**

    * Returns the path to sextante help and additional programs

    * @return the path to sextante help and additional programs

    */

   public static String getSextantePath() {

   }

   /**

    * Returns the default folder for output data.

    * @return the default folder for output data.

    */

   public static String getOutputFolder() {

   /**

    * Returns the default value to represent "No Data" (null) raster cells.

    * @return the current "No Data" value.

    */

   private static Double getDefaultNoDataValue() {

   /**

    * Returns the path to the SEXTANTE config file.

    * @return A string with the full the path and name of the SEXTANTE config file.

    */

   private static String getConfigFile() {

    * By default, this is the folder "sextante" in the user's home folder.

    * But it is also possible to set a different folder through the

    * Java property "SEXTANTE.confDir" when launching the VM:

    *   java -DSEXTANTE.confDir=<path>

    * @return A string with the full path and name of the config folder.

    */

   public static String getUserFolder() {

      String sPath;

      String sConfDir;

      // default is to use system's home folder setting

      // check if SEXTANTE.confDir has been set

      if ( sConfDir != null ) {

    	  sConfDir = sConfDir.trim();

    	  	if ( sConfDir.length() > 0 ) {

   /**

    * Returns the type of the last element from which a command-line command was executed

    * @return the type of the element from which a command-line command was executed. SextanteGUI.HISTORY if the last component

    *         was the history panel; SextanteGUI.COMMANDLINE if it was the regular SEXTANTE console

    */

   /**

    * Sets the type of the last element from which a command-line command was executed. This has to be called from any component

    * that allows execution of commands

    * @param iLast

    *                one of the following constants: SextanteGUI.HISTORY if the last component was the history panel;

    *                SextanteGUI.COMMANDLINE if it was the regular SEXTANTE console

   /**

    * Gets the dialog from which the last command--line command was executed. This will be used as the parent dialog for task

    * monitors or message dialogs generated by the execution of that command.

    * @return the dialog from which the last command--line command was executed

    */

   public static JDialog getLastCommandOriginParentDialog() {

   /**

    * Sets the dialog (if any) that contains the element from which the last command--line command was executed

    * @param parent

    *                the dialog (if any) that contains the element from which the last command--line command was executed

    */

   /**

    * Returns true if only active algorithms (those that can be executed with the current data objects) should be shown in the

    * toolbox

    * @return true if only active algorithms (those that can be executed with the current data objects) should be shown in the

    *         toolbox

    */

   /**

    * Sets whether only active algorithms (those that can be executed with the current data objects) should be shown in the

    * toolbox

    * @param showOnlyActiveAlgorithms

    *                must be true if only active algorithms (those that can be executed with the current data objects) should be

    *                shown in the toolbox

   /**

    * puts a collection of settings into the settings map

    * @param settings

    *                the map with settings values.

    */

   /**

    * Modifies the passed string, so it can be used as a safe data object name (without special characters)

    * @param sName

    *                the name to modify

    * @return the modified safe name (with no special characters)

   /**

    * Returns the renderer to use for layers created by SEXTANTE algorithms

    */

   public static IDataRenderer getDataRenderer() {