es.unex.sextante.gui.help
Class HelpIO

java.lang.Object
  extended by es.unex.sextante.gui.help.HelpIO

public class HelpIO
extends java.lang.Object


Constructor Summary
HelpIO()
           
 
Method Summary
static boolean containsStringInHelpFile(GeoAlgorithm alg, java.lang.String string)
          Returns true if the help file associated with an algorithm contains a given search string
static java.util.HashMap createMap(java.util.ArrayList list)
           
static java.lang.String getHelpAsHTMLCode(GeoAlgorithm alg)
          Returns the help associated with a given geoalgorithm as a html-formatted string
static java.lang.String getHelpFilename(GeoAlgorithm alg)
          Returns the help filename for a given algorithm
static java.lang.String getHelpPath(GeoAlgorithm alg, boolean bForceLocale)
          Returns the path where help files for a given algorithm are found
static java.util.ArrayList open(java.lang.String sFilename)
           
static void save(java.util.ArrayList elements, java.lang.String sFilename)
           
static void saveHelpToHTML(GeoAlgorithm alg, java.lang.String sBaseFolder)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpIO

public HelpIO()
Method Detail

save

public static void save(java.util.ArrayList elements,
                        java.lang.String sFilename)

open

public static java.util.ArrayList open(java.lang.String sFilename)

getHelpAsHTMLCode

public static java.lang.String getHelpAsHTMLCode(GeoAlgorithm alg)
Returns the help associated with a given geoalgorithm as a html-formatted string

Parameters:
alg - the geoalgorithm
Returns:
a html-formatted string with help for the given algorithm

createMap

public static java.util.HashMap createMap(java.util.ArrayList list)

containsStringInHelpFile

public static boolean containsStringInHelpFile(GeoAlgorithm alg,
                                               java.lang.String string)
Returns true if the help file associated with an algorithm contains a given search string

Parameters:
alg - the GeoAlgorithm
string - a string to search
Returns:
true if the help file associated with the algorithm contains the search string

getHelpFilename

public static java.lang.String getHelpFilename(GeoAlgorithm alg)
Returns the help filename for a given algorithm

Parameters:
alg - the GeoAlgorithm
Returns:
the help filename for a given algorithm

getHelpPath

public static java.lang.String getHelpPath(GeoAlgorithm alg,
                                           boolean bForceLocale)
Returns the path where help files for a given algorithm are found

Parameters:
alg - the GeoAlgorithm
bForceCurrentLocale - if true, returns the path to the current locale, even if it does not exist. If false, it will return the path corresponding to the default locale (english) in case the one corresponding to the current locale does not exist.
Returns:
the help path for this algorithm

saveHelpToHTML

public static void saveHelpToHTML(GeoAlgorithm alg,
                                  java.lang.String sBaseFolder)