org.gvsig.geoprocess.lib.sextante

Class SextanteGeoProcessManager

java.lang.Object

org.gvsig.geoprocess.lib.sextante.SextanteGeoProcessManager

All Implemented Interfaces:

es.unex.sextante.gui.core.IAlgorithmProvider, GeoProcessManager

public class SextanteGeoProcessManager
extends Object
implements GeoProcessManager, es.unex.sextante.gui.core.IAlgorithmProvider

Implementation for the GeoProcessManager interface based on the sextante library.

Constructor Summary

Constructors

Constructor and Description
SextanteGeoProcessManager() Manager constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canEditHelp() Returns true if the help files associated with the algorithms from this provider can be edited by the user
GeoProcessBuiler	createGeoProcessBuilder()
Object	getAlgorithmHelp(es.unex.sextante.core.GeoAlgorithm alg) Returns the help associated with the passed algorithm as a HTML string or a URL
String	getAlgorithmHelpFilename(es.unex.sextante.core.GeoAlgorithm alg, boolean bForceCurrentLocale) Returns the filename where the help for a given algorithm is stored
HashMap<String,es.unex.sextante.core.GeoAlgorithm>	getAlgorithms() Returns a map with algorithm command-line names as keys and geoalgorithms as values
HashMap<String,Class>	getCustomModelerParameterPanels() Returns a map of custom parameter panels.
HashMap<String,Class>	getCustomParameterPanels() Returns a map of custom modeler parameter panels.
ImageIcon	getIcon() Returns the icon to use for the algorithms provided by this provider
String	getName() Returns the name of the algorithm provider.
es.unex.sextante.gui.settings.Setting	getSettings() Returns the settings object corresponding to this provider
HashMap<es.unex.sextante.gui.core.NameAndIcon,ArrayList<es.unex.sextante.gui.core.ToolboxAction>>	getToolboxActions() Returns the toolbox actions to be added to the toolbox by this algorithm provider.
es.unex.sextante.gui.core.IToolboxRightButtonAction[]	getToolboxRightButtonActions() Return the right button actions to be added to the toolbox by this algorithm provider.
String	getTranslation(String label) Returns the translation for a label depending on the current locale.
void	initialize() Performs the initialization needed to load the corresponding algorithm into the algorithm provider
void	registerGeoProcess(Class<? extends GeoProcess> geoProcessClazz, Map<String,String> localeStrings) Registers a new GeoProcess.
void	registerGeoProcess(GeoProcess geoProcess) Registers a new GeoProcess.
void	update() Updates the list of algorithms in this provider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SextanteGeoProcessManager

public SextanteGeoProcessManager()

Manager constructor.

Method Detail

getTranslation

public String getTranslation(String label)

Description copied from interface: GeoProcessManager

Returns the translation for a label depending on the current locale.

Specified by:

getTranslation in interface GeoProcessManager

Parameters:

label - to translate

Returns:

text in the current locale

registerGeoProcess

public void registerGeoProcess(GeoProcess geoProcess)

Description copied from interface: GeoProcessManager

Registers a new GeoProcess.

Specified by:

registerGeoProcess in interface GeoProcessManager

Parameters:

geoProcess - the GeoProcess instance

registerGeoProcess

public void registerGeoProcess(Class<? extends GeoProcess> geoProcessClazz,
                               Map<String,String> localeStrings)

Description copied from interface: GeoProcessManager

Registers a new GeoProcess.

Specified by:

registerGeoProcess in interface GeoProcessManager

Parameters:

geoProcessClazz - the GeoProcess class

localeStrings - the i18n strings used by the geoprocess

initialize

public void initialize()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

initialize in interface es.unex.sextante.gui.core.IAlgorithmProvider

getName

public String getName()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getName in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

getAlgorithms

public HashMap<String,es.unex.sextante.core.GeoAlgorithm> getAlgorithms()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getAlgorithms in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

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

getCustomModelerParameterPanels

public HashMap<String,Class> getCustomModelerParameterPanels()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getCustomModelerParameterPanels in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

a map of custom parameter panels.

getCustomParameterPanels

public HashMap<String,Class> getCustomParameterPanels()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getCustomParameterPanels in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

a map of custom modeler parameter panels.

getIcon

public ImageIcon getIcon()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getIcon in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

the icon to use for the algorithms provided by this provider

getSettings

public es.unex.sextante.gui.settings.Setting getSettings()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

Returns the settings object corresponding to this provider

Specified by:

getSettings in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

the settings object corresponding to this provider

update

public void update()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

Updates the list of algorithms in this provider

Specified by:

update in interface es.unex.sextante.gui.core.IAlgorithmProvider

getAlgorithmHelp

public Object getAlgorithmHelp(es.unex.sextante.core.GeoAlgorithm alg)

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getAlgorithmHelp in interface es.unex.sextante.gui.core.IAlgorithmProvider

Parameters:

alg - the algorithm

Returns:

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

getAlgorithmHelpFilename

public String getAlgorithmHelpFilename(es.unex.sextante.core.GeoAlgorithm alg,
                                       boolean bForceCurrentLocale)

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getAlgorithmHelpFilename in interface es.unex.sextante.gui.core.IAlgorithmProvider

Parameters:

alg - the algorithm

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

Returns:

canEditHelp

public boolean canEditHelp()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

canEditHelp in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

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

getToolboxActions

public HashMap<es.unex.sextante.gui.core.NameAndIcon,ArrayList<es.unex.sextante.gui.core.ToolboxAction>> getToolboxActions()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getToolboxActions in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

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

getToolboxRightButtonActions

public es.unex.sextante.gui.core.IToolboxRightButtonAction[] getToolboxRightButtonActions()

Description copied from interface: es.unex.sextante.gui.core.IAlgorithmProvider

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

Specified by:

getToolboxRightButtonActions in interface es.unex.sextante.gui.core.IAlgorithmProvider

Returns:

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

createGeoProcessBuilder

public GeoProcessBuiler createGeoProcessBuilder()

Specified by:

createGeoProcessBuilder in interface GeoProcessManager