Application: gvSIG desktop » gvSIG tools: ToolBox

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<groupId>org.gvsig</groupId>

	<artifactId>org.gvsig.toolbox</artifactId>

	<packaging>pom</packaging>

	<name>Algorithms</name>

	<version>1.0.3-SNAPSHOT</version>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.desktop</artifactId>

		<version>2.0.25</version>

	</parent>

	<scm>

        <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-toolbox/org.gvsig.toolbox/trunk/org.gvsig.toolbox</connection>

        <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-toolbox/org.gvsig.toolbox/trunk/org.gvsig.toolbox</developerConnection>

        <url>https://devel.gvsig.org/redmine/projects/gvsig-toolbox/repository/show/org.gvsig.toolbox/trunk/org.gvsig.toolbox</url>

    </scm>

	<repositories>

      <repository>

        <id>gvsig-public-http-repository</id>

        <name>gvSIG maven public HTTP repository</name>

        <url>http://devel.gvsig.org/m2repo/j2se</url>

        <releases>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </releases>

        <snapshots>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </snapshots>

      </repository>

    </repositories> 

	<properties>

    	<maven.compiler.source>1.6</maven.compiler.source>

    	<maven.compiler.target>1.6</maven.compiler.target>

	</properties>

	 <build>

	    <pluginManagement>

	       <plugins>

	          <plugin>

                <groupId>org.codehaus.mojo</groupId>

                <artifactId>animal-sniffer-maven-plugin</artifactId>

                <version>1.7</version>

              </plugin>

	       </plugins>

	    </pluginManagement>

	   <sourceDirectory>src</sourceDirectory>

	    <resources>

			<resource>

				<directory>resources</directory>

				<includes>

					<include>**/*</include>

				</includes>

			</resource>

		</resources>

	    <plugins>

        	<plugin>

            	<groupId>org.apache.maven.plugins</groupId>

            	<artifactId>maven-compiler-plugin</artifactId>

            	<version>2.0.2</version>

            	<configuration>

                	<source>1.6</source>

                	<target>1.6</target>

                	<encoding>ISO-8859-1</encoding>

            	</configuration>

        	</plugin>

        	<plugin>

              <groupId>org.codehaus.mojo</groupId>

              <artifactId>animal-sniffer-maven-plugin</artifactId>

              <executions>

                <execution>

                    <id>check-java-api</id>

                    <phase>test</phase>

                    <goals>

                        <goal>check</goal>

                    </goals>

                    <configuration>

                        <signature>

                            <groupId>org.codehaus.mojo.signature

                            </groupId>

                            <artifactId>java16</artifactId>

                            <version>1.0</version>

                        </signature>

                    </configuration>

                </execution>

              </executions>

             </plugin>

             <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-release-plugin</artifactId>

                <configuration>

                    <tagBase>https://devel.gvsig.org/svn/gvsig-toolbox/org.gvsig.toolbox/tags/</tagBase>

                    <goals>deploy</goals>

                </configuration>

            </plugin>

    	  </plugins>

    </build>

	<dependencyManagement>

      <dependencies>

		<dependency>

			<groupId>gishur</groupId>

			<artifactId>gishur_x</artifactId>

			<version>unknown</version>

		</dependency>

		<dependency>

			<groupId>gishur</groupId>

			<artifactId>gishur_core</artifactId>

			<version>unknown</version>

		</dependency>

		<dependency>

			<groupId>com.vividsolutions</groupId>

			<artifactId>jts</artifactId>

			<version>1.13</version>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.toolbox.core</artifactId>

			<version>1.0.3-SNAPSHOT</version>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.toolbox.gui</artifactId>

			<version>1.0.3-SNAPSHOT</version>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.toolbox.math</artifactId>

			<version>1.0.3-SNAPSHOT</version>

		</dependency>

		<dependency>

			<groupId>gnu.trove</groupId>

			<artifactId>trove</artifactId>

			<version>0.1.8</version>

		</dependency>

		<dependency>

			  <groupId>org.gvsig.legacy</groupId>

			  <artifactId>jama</artifactId>

			  <version>1.0.2</version>

		</dependency>

        <dependency>

			<groupId>org.nfunk</groupId>

			<artifactId>jep</artifactId>

			<version>2.4.0</version>

		</dependency>

		<dependency>

			<groupId>commons-codec</groupId>

			<artifactId>commons-codec</artifactId>

			<version>1.8</version>

		</dependency>

		<dependency>

            <groupId>es.unex</groupId>

            <artifactId>sextante_wps</artifactId>

            <version>0.6.0</version>

        </dependency>

        <dependency>

			<groupId>es.unex</groupId>

			<artifactId>libDocEngines</artifactId>

			<version>0.6.0</version>

		</dependency>

		<dependency>

			<groupId>org.beanshell</groupId>

			<artifactId>bsh</artifactId>

			<version>2.0b4</version>

		</dependency>

        <dependency>

            <groupId>org.japura</groupId>

            <artifactId>org.japura</artifactId>

            <version>1.14.0</version>

        </dependency>

		<dependency>

			<groupId>commons-codec</groupId>

			<artifactId>commons-codec</artifactId>

			<version>1.8</version>

		</dependency>

	  </dependencies>

	</dependencyManagement>

	 <modules>

		<module>org.gvsig.toolbox.math</module>

		<module>org.gvsig.toolbox.gui</module>

		<module>org.gvsig.toolbox.core</module>

		<module>org.gvsig.toolbox.algorithm</module>

	</modules>

</project>

Manifest-Version: 1.0

Ant-Version: Apache Ant 1.7.1

Created-By: 20.1-b02 (Sun Microsystems Inc.)

Implementation-Version: 0.7

Built-Date: 2013-03-04 16:06:37

/*

 * 20:25:20 20/05/99

 *

 * The Java Shell: Utilities.

 * (C)1999 Romain Guy, Osvaldo Pinali Doederlein.

 *

 * LICENSE

 * =======

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

 *

 * CHANGES

 * =======

 * 1.0.8 - Filled the listRoots method                   (Romain & Osvaldo)

 * 1.0.7 - Several bug fixes in constructPath            (Romain)

 * 1.0.6 - Split JDK1.1/1.2                              (Osvaldo)

 * 1.0.5 - Important bug fix in constructPath(String)    (Romain)

 * 1.0.4 - Added getSize(Enumeration)                    (Osvaldo)

 * 1.0.3 - Changed sortStrings bubble-sort algorithm to  (Romain)

 *         quick-sort (James Gosling)

 * 1.0.2 - Fixed two little bug in constructPath(String) (Romain)

 * 1.0.1 - Added listFiles(String[], boolean)            (Romain)

 *       - Removed unecessary createWhiteSpace(int)      (Romain)

 *       - Modified getWildCardMatches(String, boolean)  (Romain)

 *       - Slighty improved javadoc comments             (Romain)

 * 1.0.0 - Initial release.                              (Romain & Osvaldo)

 *

 * LINKS

 * =====

 * Contact: mailto@osvaldo.visionnaire.com.br

 * Site #1: http://www.geocities.com/ResearchTriangle/Node/2005/

 * Site #2: http://student.vub.ac.be/~opinalid/

 */

package jsh.shell;

import java.io.File;

import java.util.Enumeration;

import java.util.Vector;

import es.unex.sextante.gui.core.SextanteGUI;

/**

 * The Java Shell: Utility pack.

 *

 * @author Romain Guy.

 * @author Osvaldo Pinali Doederlein.

 */

public class Utils {

   /**

    * Removes some elements from a String array.

    *

    * @param arr

    *                The array.

    * @param first

    *                First element to keep (new 0-index).

    * @param last

    *                Last element to keep.

    * @return Copy of arr[first..]

    */

   public static String[] subarray(final String[] arr,

                                   int first,

                                   final int last) {

      final String[] newArr = new String[last - first + 1];

      for (int i = 0; i < newArr.length; ++i, ++first) {

         newArr[i] = arr[first];

      }

      return newArr;

   }

   /**

    * Removes some leading elements from a String array.

    *

    * @param arr

    *                The array.

    * @param first

    *                First element to keep (new 0-index).

    * @return Copy of arr[first..]

    */

   public static String[] subarray(final String[] arr,

                                   final int first) {

      return subarray(arr, first, arr.length - 1);

   }

   /**

    * Formats a number of bytes for output.

    *

    * @param bytes

    *                Number of bytes.

    * @return "xxxxK" form.

    */

   public static String fmtBytes(final long bytes) {

      return Long.toString(bytes / 1024) + "K";

   }

   /**

    * Formats time for output.

    *

    * @param bytes

    *                Number of milliseconds.

    * @return "x,yyys" form.

    */

   public static String fmtTime(final long ms) {

      return Float.toString(ms / 1000.0f) + "s";

   }

   /**

    * Return a String made of spaces.

    *

    * @param len

    *                Number of spaces

    */

   public static String getSpaces(final int len) {

      final StringBuffer buf = new StringBuffer();

      for (int i = 0; i < len; i++) {

         buf.append(' ');

      }

      return buf.toString();

   }

   public static String[] toArray(final Vector strings) {

      final String[] arr = new String[strings.size()];

      for (int i = 0; i < strings.size(); ++i) {

         arr[i] = (String) strings.elementAt(i);

      }

      return arr;

   }

   /**

    * When the user has to specify file names, he can use wildcards (*, ?). This methods handles the usage of these wildcards.

    *

    * @param s

    *                Wilcards

    * @param sort

    *                Set to true will sort file names

    * @return An array of String which contains all files matching <code>s</code> in current directory.

    * @see Utils#match(String, String)

    */

   public static String[] getWildCardMatches(final String s,

                                             final boolean sort) {

      final String args = new String(s.trim());

      String files[];

      final Vector filesThatMatchVector = new Vector();

      String filesThatMatch[];

      files = (new File(getUserDirectory())).list();

      for (int i = 0; i < files.length; i++) {

         if (match(args, files[i])) {

            final File temp = new File(getUserDirectory(), files[i]);

            filesThatMatchVector.addElement(new String(temp.getName()));

         }

      }

      filesThatMatch = new String[filesThatMatchVector.size()];

      filesThatMatchVector.copyInto(filesThatMatch);

      if (sort) {

         sortStrings(filesThatMatch);

      }

      return filesThatMatch;

   }

   /**

    * This method can determine if a String matches a pattern of wildcards

    *

    * @param pattern

    *                The pattern used for comparison

    * @param string

    *                The String to be checked

    * @return true if <code>string</code> matches <code>pattern</code>

    * @see Utils#getWildCardMatches(String)

    */

   public static boolean match(final String pattern,

                               final String string) {

      for (int p = 0;; p++) {

         for (int s = 0;; p++, s++) {

            final boolean sEnd = (s >= string.length());

            final boolean pEnd = (p >= pattern.length() || pattern.charAt(p) == '|');

            if (sEnd && pEnd) {

               return true;

            }

            if (sEnd || pEnd) {

               break;

            }

            if (pattern.charAt(p) == '?') {

               continue;

            }

            if (pattern.charAt(p) == '*') {

               int i;

               p++;

               for (i = string.length(); i >= s; --i) {

                  if (match(pattern.substring(p), string.substring(i))) {

                     return true;

                  }

               }

               break;

            }

            if (pattern.charAt(p) != string.charAt(s)) {

               break;

            }

         }

         p = pattern.indexOf('|', p);

         if (p == -1) {

            return false;

         }

      }

   }

   /**

    * Quick sort an array of Strings.

    *

    * @param string

    *                Strings to be sorted

    */

   public static void sortStrings(final String[] strings) {

      sortStrings(strings, 0, strings.length - 1);

   }

   /**

    * Quick sort an array of Strings.

    *

    * @param a

    *                Strings to be sorted

    * @param lo0

    *                Lower bound

    * @param hi0

    *                Higher bound

    */

   public static void sortStrings(final String a[],

                                  final int lo0,

                                  final int hi0) {

      int lo = lo0;

      int hi = hi0;

      String mid;

      if (hi0 > lo0) {

         mid = a[(lo0 + hi0) / 2];

         while (lo <= hi) {

            while (lo < hi0 && a[lo].compareTo(mid) < 0) {

               ++lo;

            }

            while (hi > lo0 && a[hi].compareTo(mid) > 0) {

               --hi;

            }

            if (lo <= hi) {

               swap(a, lo, hi);

               ++lo;

               --hi;

            }

         }

         if (lo0 < hi) {

            sortStrings(a, lo0, hi);

         }

         if (lo < hi0) {

            sortStrings(a, lo, hi0);

         }

      }

   }

   /**

    * Swaps two Strings.

    *

    * @param a

    *                The array to be swapped

    * @param i

    *                First String index

    * @param j

    *                Second String index

    */

   public static void swap(final String a[],

                           final int i,

                           final int j) {

      String T;

      T = a[i];

      a[i] = a[j];

      a[j] = T;

   }

   /**

    * Returns the user current directory.

    */

   public static String getUserDirectory() {

      String folder = SextanteGUI.getOutputFolder();

      if (folder == null) {

         folder = System.getProperty("user.home");

      }

      return folder;

   }

   /**

    * Sometimes, Strings are too long to be correctly displayed. This method will reduce a String, keeping first and last

    * characters.

    *

    * @param longString

    *                The String to be modified

    * @param maxLength

    *                The maximum length of the String

    * @return A shorter String

    */

   public static String getShortStringOf(final String longString,

                                         final int maxLength) {

      final int len = longString.length();

      if (len < maxLength) {

         return longString;

      }

      else {

         return longString.substring(0, maxLength / 2) + "..." + longString.substring(len - (maxLength / 2));

      }

   }

   /**

    * Because a lot of people still use JDK 1.1, we need this method to create an array of Files from an array of String.

    *

    * @param names

    *                Names of the files

    * @param construct

    *                Set it to true if names does not contain full paths

    * @return An array of Files

    */

   public static File[] listFiles(final String[] names,

                                  final boolean construct) {

      final File[] files = new File[names.length];

      String path = Utils.getUserDirectory();

      if (construct) {

         if (!path.endsWith(File.separator)) {

            path += File.separator;

         }

      }

      for (int i = 0; i < files.length; i++) {

         if (construct) {

            files[i] = new File(path + names[i]);

         }

         else {

            files[i] = new File(names[i]);

         }

      }

      return files;

   }

   /**

    * Counts things in an Enumeration (and destroys it as a side effect).

    *

    * @param enum

    *                The enumeration, in the start position.

    * @return Elements found.

    */

   public static int getSize(final Enumeration enu) {

      int size = 0;

      while (enu.hasMoreElements()) {

         ++size;

         enu.nextElement();

      }

      return size;

   }

   /**

    * Constructs a new path from current user path. This is an easy way to get a path if the user specified, for example,

    * "..\Java" as new path. This method will return the argument if this one is a path to a root (i.e, if <code>change</code>

    * is equal to C:\Jdk, constructPath will return C:\Jdk).

    *

    * @param change

    *                The modification to apply to the path

    * @see Utils#beginsWithRoot(String), Utils#getRoot(String)

    */

   public static String constructPath(final String change) {

      if (change == null || beginsWithRoot(change)) {

         return change;

      }

      String newPath = getUserDirectory();

      char current;

      char lastChar = '\0';

      boolean toAdd = false;

      StringBuffer buf = new StringBuffer(change.length());

      for (int i = 0; i < change.length(); i++) {

         switch ((current = change.charAt(i))) {

            case '.':

               if (lastChar == '.') {

                  final String parent = (new File(newPath)).getParent();

                  if (parent != null) {

                     newPath = parent;

                  }

               }

               else if (lastChar != '\0' && lastChar != '\\' && lastChar != '/') {

                  buf.append('.');

               }

               lastChar = '.';

               break;

            case '\\':

            case '/':

               if (lastChar == '\0') {

                  newPath = getRoot(newPath);

               }

               else {

                  if (!newPath.endsWith("\\")) {

                     newPath += File.separator + buf.toString();

                  }

                  else {

                     newPath += buf.toString();

                  }

                  buf = new StringBuffer();

                  toAdd = false;

               }

               lastChar = '\\';

               break;

            case '~':

               if (i < change.length() - 1) {

                  if (change.charAt(i + 1) == '\\' || change.charAt(i + 1) == '/') {

                     newPath = System.getProperties().getProperty("user.home");

                  }

                  else {

                     buf.append('~');

                  }

               }

               else if (i == 0) {

                  newPath = System.getProperties().getProperty("user.home");

               }

               else {

                  buf.append('~');

               }

               lastChar = '~';

               break;

            default:

               lastChar = current;

               buf.append(current);

               toAdd = true;

               break;

         }

      }

      if (toAdd) {

         if (!newPath.endsWith(File.separator)) {

            newPath += File.separator + buf.toString();

         }

         else {

            newPath += buf.toString();

         }

      }

      return newPath;

   }

   /**

    * It can be necessary to determine which is the root of a path. For example, the root of D:\Projects\Java is D:\.

    *

    * @param path

    *                The path used to get a root

    * @return The root which contais the specified path

    */

   public static String getRoot(final String path) {

      final File roots[] = listRoots(new File(path));

      for (int i = 0; i < roots.length; i++) {

         if (path.startsWith(roots[i].getPath())) {

            return roots[i].getPath();

         }

      }

      return path;

   }

   /**

    * It can be necessary to determine if a path begins with a root.

    *

    * @param path

    *                The path to check

    * @return True if path begins with a root, false otherwise

    */

   public static boolean beginsWithRoot(final String path) {

      final File roots[] = listRoots(new File(path));

      for (int i = 0; i < roots.length; i++) {

         if (path.regionMatches(true, 0, roots[i].getPath(), 0, roots[i].getPath().length())) {

            return true;

         }

      }

      return false;

   }

   /**

    * We override a Java2 specific method.

    *

    * @param f

    *                A File

    * @return A list of standards roots

    */

   public static File[] listRoots(final File f) {

      if (System.getProperty("os.name").startsWith("Windows")) {

         return new File[] { new File("A:\\"), new File("B:\\"), new File("C:\\"), new File("D:\\"), new File("E:\\"),

                  new File("F:\\"), new File("G:\\"), new File("H:\\"), new File("I:\\") };

         //return new File[]{new File(System.getProperty("java.home").substring(0, 3))};

      }

      else {

         return new File[] { new File("/") };

      }

   }

   /**

    * We override a Java2 spcific method.

    *

    * @param file

    *                Determine if this file is hidden or not

    * @return Always false

    */

   public boolean isHidden(final File file) {

      return false;

   }

}

// End of Utils.java

package es.unex.sextante.gui.core;

public class RenderingData {

   public String algName;

   public String outputName;

   public Object rendering;

}

package es.unex.sextante.gui.core;

import java.awt.BorderLayout;

import java.awt.Component;

import java.awt.Frame;

import javax.swing.JDialog;

import javax.swing.JPanel;

/**

 * A simple dialog to show a java component

 * 

 * @author volaya

 * 

 */

public class GenericInfoDialog

         extends

            JDialog {

   /**

    * constructor

    * 

    * @param component

    *                the component to show in the dialog

    * @param sTitle

    *                the title of the dialog

    * @param parent

    *                the parent frame

    */

   public GenericInfoDialog(final Component component,

                            final String sTitle,

                            final Frame parent) {

      super(parent, sTitle, true);

      initGUI(component);

      pack();

      setLocationRelativeTo(null);

   }

   protected void initGUI(final Component component) {

      setPreferredSize(component.getPreferredSize());

      setSize(component.getPreferredSize());

      final BorderLayout thisLayout = new BorderLayout();

      final JPanel pane = new JPanel();

      pane.setLayout(thisLayout);

      setContentPane(pane);

      pane.add(component, BorderLayout.CENTER);

   }

}

package es.unex.sextante.gui.core;

import es.unex.sextante.core.GeoAlgorithm;

import es.unex.sextante.gui.additionalResults.AdditionalResults;

/**

 * Interface to be implemented by post process factories. A post process factory is used to define the task that should be

 * performed with algorithm results, once a SEXTANTE geoalgorithm has been executed from the SEXTANTE GUI

 * 

 * @author volaya

 * 

 */

public interface IPostProcessTaskFactory {

   /**

    * Returns a task to post-process the given algorithm. This task should take the outputs generated by the algorithm, adding

    * them to the GUI or doing with them whatever is needed.

    * 

    * To be compatible with the {@link AdditionalResults} class, charts and text result has to be added as java Components. Check

    * the documentation of that class for more information.

    * 

    * @param alg

    *                the algorithm to post-process

    * @param bShowResultsDialog

    *                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 post-process the given algorithm

    */

   public Runnable getPostProcessTask(GeoAlgorithm alg,

                                      boolean bShowResultsDialog);

}

package es.unex.sextante.gui.core;

import java.util.HashMap;

import es.unex.sextante.dataObjects.ILayer;

/**

 * A class containing information needed to set rendering styles for layers generated by SEXTANTE geoalgorithms

 * 

 * @author volaya

 * 

 */

public interface IDataRenderer {

   public Object getRenderingForLayer(String sAlgCmdName,

                                      String sOutputName);

   public void setRenderingForAlgorithm(String sAlgCmdName,

                                        HashMap<String, Object> renderer);

   public void save();

   public void open();

   public Object getRenderingDataFromLayer(ILayer layer);

}

package es.unex.sextante.gui.core;

import java.util.ArrayList;

import java.util.HashMap;

import javax.swing.ImageIcon;

import es.unex.sextante.core.GeoAlgorithm;

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

public interface IAlgorithmProvider {

   /**

    * Performs the initialization needed to load the corresponding algorithm into the algorithm provider

    */

   public void initialize();

   /**

    * Returns the name of the algorithm provider. This will be used as the group name in the toolbox

    * 

    * @return

    */

   public String getName();

   /**

    * Returns a map with algorithm command-line names as keys and geoalgorithms as values

    * 

    * @return a map with algorithm command-line names as keys and geoalgorithms as values

    */

   public HashMap<String, GeoAlgorithm> getAlgorithms();

   /**

    * Returns a map of custom parameter panels. Keys are algorithm command-line names, and values are the corresponding panel

    * classes

    * 

    * @return a map of custom parameter panels.

    */

   public HashMap<String, Class> getCustomModelerParameterPanels();

   /**

    * Returns a map of custom modeler parameter panels. Keys are algorithm command-line names, and values are the corresponding

    * panel classes

    * 

    * @return a map of custom modeler parameter panels.

    */

   public HashMap<String, Class> getCustomParameterPanels();

   /**

    * Returns the icon to use for the algorithms provided by this provider

    * 

    * @return the icon to use for the algorithms provided by this provider

    */

   public ImageIcon getIcon();

   /**

    * Returns the settings object corresponding to this provider

    * 

    * @return the settings object corresponding to this provider

    */

   public Setting getSettings();

   /**

    * Updates the list of algorithms in this provider

    */

   public void update();

   /**

    * 

    * Returns the help associated with the passed algorithm as a HTML string or a URL

    * 

    * @param alg

    *                the algorithm

    * @return the help associated with the passed algorithm as a HTML string or a URL

    */

   public Object getAlgorithmHelp(GeoAlgorithm alg);

   /**

    * Returns the filename where the help for a given algorithm is stored

    * 

    * @param alg

    *                the algorithm

    * @param bForceCurrentLocale

    *                if true it will return the current locale folder, even if the help file does not exists

    * @return

    */

   public String getAlgorithmHelpFilename(GeoAlgorithm alg,

                                          boolean bForceCurrentLocale);

   /**

    * Returns true if the help files associated with the algorithms from this provider can be edited by the user

    * 

    * @return true if the help files associated with the algorithms from this provider can be edited by the user

    */

   public boolean canEditHelp();

   /**

    * Returns the toolbox actions to be added to the toolbox by this algorithm provider.

    * 

    * @return A Map containing toolbox actions to be added to the toolbox by this algorithm provider

    */

   public HashMap<NameAndIcon, ArrayList<ToolboxAction>> getToolboxActions();

   /**

    * Return the right button actions to be added to the toolbox by this algorithm provider. These actions should work on the

    * particular type of algorithms provided by the provider

    * 

    * @return the right button actions to be added to the toolbox by this algorithm provider.

    */

   public IToolboxRightButtonAction[] getToolboxRightButtonActions();

}

package es.unex.sextante.gui.core;

import info.clearthought.layout.TableLayout;

import info.clearthought.layout.TableLayoutConstants;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.JButton;

import javax.swing.JDialog;

import javax.swing.JLabel;

import javax.swing.JProgressBar;

import javax.swing.SwingUtilities;

import javax.swing.WindowConstants;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.gui.grass.GrassUtils;

/**

 * A progress monitor showing a progress bar and a cancel button

 * 

 * @author volaya

 * 

 */

public class ProgressMonitor

         extends

            JDialog {

   private JLabel       jTitle;

   private JButton      jButtonCancel;

   private JProgressBar jProgressBar;

   private JLabel       jProgressText;

   private boolean      m_bCanceled;

   private String       m_sPrefix      = "";

   private String       m_sDescription = "";

   /**

    * Constructor

    * 

    * @param sText

    *                The title text to show

    * @param bDeterminate

    *                true if the process to monitor is determinate

    * @param parent

    *                the parent dialog

    */

   public ProgressMonitor(final String sText,

                          final boolean bDeterminate,

                          final JDialog parent) {

      super(parent, "", false);

      setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);

      setLocationRelativeTo(null);

      m_bCanceled = false;

      m_sDescription = sText;

      initGUI(bDeterminate);

   }

   /**

    * Constructor. Uses the main frame as the parent component

    * 

    * @param sText

    *                The title text to show

    * @param bDeterminate

    *                true if the process to monitor is determinate

    */

   public ProgressMonitor(final String sText,

                          final boolean bDeterminate) {

      super(SextanteGUI.getMainFrame(), "", false);

      setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);

      setLocationRelativeTo(null);

      m_bCanceled = false;

      m_sDescription = sText;

      initGUI(bDeterminate);

   }

   private void initGUI(boolean bDeterminate) {

      final TableLayout thisLayout = new TableLayout(new double[][] {

               { 6.0, TableLayoutConstants.FILL, TableLayoutConstants.FILL, 6.0 },

               { 1.0, TableLayoutConstants.FILL, TableLayoutConstants.FILL, 1, 15.0, 1.0, 25.0, 1.0 } });

      thisLayout.setHGap(5);

      thisLayout.setVGap(5);

      setPreferredSize(new Dimension(350, 150));

      setSize(new Dimension(350, 150));

      getContentPane().setLayout(thisLayout);

      {

         jTitle = new JLabel(m_sDescription);

         getContentPane().add(jTitle, "1, 1, 2, 1");

      }

      {

         jButtonCancel = new JButton();

         getContentPane().add(jButtonCancel, "2, 6");

         jButtonCancel.setText(Sextante.getText("Cancel"));

         jButtonCancel.addActionListener(new ActionListener() {

            public void actionPerformed(final ActionEvent evt) {

               cancel();

            }

         });

      }

      {

         jProgressBar = new JProgressBar();

         jProgressBar.setIndeterminate(!bDeterminate);

         if (bDeterminate) {

            jProgressBar.setMinimum(0);

            jProgressBar.setMaximum(100);

            jProgressBar.setValue(0);

         }

         getContentPane().add(jProgressBar, "1, 4, 2, 4");

      }

      {

         jProgressText = new JLabel();

         getContentPane().add(jProgressText, "1, 2");

      }

   }

   private void cancel() {

      //If this is a running GRASS process: kill it

      GrassUtils.cancelProcess();

      m_bCanceled = true;

   }

   /**

    * Returns true if the process has been canceled using the cancel button

    * 

    * @return true if the process has been canceled

    */

   public boolean isCanceled() {

      return m_bCanceled;

   }

   /**

    * Sets the text describing the current phase of the process being monitored

    * 

    * @param sText

    *                the description

    */

   public void setProgressText(final String sText) {

      try {

         final Runnable runnable = new Runnable() {

            public void run() {

               jProgressText.setText(sText);

            }

         };

         if (SwingUtilities.isEventDispatchThread()) {

            runnable.run();

         }

         else {

            SwingUtilities.invokeAndWait(runnable);

         }

      }

      catch (final Exception e) {}

   }

   /**

    * Sets the description to show at the top of the progress monitor

    * 

    * @param sDescription

    *                the description

    */

   public void setDescription(final String sDescription) {

      m_sDescription = sDescription;

      updateTitle();

   }

   private void updateTitle() {

      try {

         final Runnable runnable = new Runnable() {

            public void run() {

               jTitle.setText(m_sPrefix + m_sDescription);

            }

         };

         if (SwingUtilities.isEventDispatchThread()) {

            runnable.run();

         }

         else {

            SwingUtilities.invokeAndWait(runnable);

         }

      }

      catch (final Exception e) {}

   }

   /**

    * Sets the current progress value (in the range 1-100)

    * 

    * @param iValue

    */

   public void setProgress(final int iValue) {

      try {

         final Runnable runnable = new Runnable() {

            public void run() {

               jProgressBar.setValue(iValue);

            }

         };

         if (SwingUtilities.isEventDispatchThread()) {

            runnable.run();

         }

         else {

            SwingUtilities.invokeAndWait(runnable);

         }

      }

      catch (final Exception e) {}

   }

   /**

    * Sets whether the process being monitored is determinate or not

    * 

    * @param bDeterminate

    */

   public void setDeterminate(final boolean bDeterminate) {

      try {

         final Runnable runnable = new Runnable() {

            public void run() {

               jProgressBar.setIndeterminate(!bDeterminate);

            }

         };

         if (SwingUtilities.isEventDispatchThread()) {

            runnable.run();

         }

         else {

            SwingUtilities.invokeAndWait(runnable);

         }

      }

      catch (final Exception e) {}

   }

   /**

    * this method sets a prefix to be prepended to the description title. This can be used for processes that include several

    * algorithms, so when each algorithm sets its owns description, it will also contain a string indicating the part of the

    * global process that it represents. This method should, therefore, not be called by simple algorithms, but just from complex

    * processes

    * 

    * @param sPrefix

    *                the prefix to prepend to the description title.

    */

   public void setDescriptionPrefix(final String sPrefix) {

      m_sPrefix = sPrefix;

      updateTitle();

   }

}

package es.unex.sextante.gui.core;

import javax.swing.ImageIcon;

public class NameAndIcon {

   private String    m_sName;

   private ImageIcon m_Icon;

   public NameAndIcon(final String sName,

                      final ImageIcon icon) {

      m_sName = sName;

      m_Icon = icon;