org.gvsig.geoprocess.lib.sextante

Class AbstractSextanteGeoProcess

java.lang.Object

es.unex.sextante.core.GeoAlgorithm

org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess

All Implemented Interfaces:

GeoProcess

Direct Known Subclasses:

BufferAlgorithm, ClipAlgorithm, ConvexHullAlgorithm, ConvexHullAlgorithm, DifferenceAlgorithm, DissolveAlgorithm, FuseSpatiallyAlgorithm, GroupByAlgorithm, gvGeoAlgorithm, IntersectionAlgorithm, LayerDatatypeSextanteAlgorithm, MergeAlgorithm, PointToLineAlgorithm, PrincipalComponentsSextanteAlgorithm, ReprojectAlgorithm, ROIMaskSextanteAlgorithm, SpatialJoinAlgorithm, SplitLinesAlgorithm, TasseledCapSextanteAlgorithm, UnionAlgorithm, XYShiftAlgorithm

public abstract class AbstractSextanteGeoProcess
extends es.unex.sextante.core.GeoAlgorithm
implements GeoProcess

Base implementation for Sextante based GeoProcess objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	attrNames
protected GeometryManager	geomManager

Fields inherited from class es.unex.sextante.core.GeoAlgorithm

m_AnalysisExtent, m_bIsAutoExtent, m_bIsDeterminatedProcess, m_bUserCanDefineAnalysisExtent, m_CRS, m_OutputFactory, m_OutputObjects, m_Parameters, m_Task

Constructor Summary

Constructors

Constructor and Description
AbstractSextanteGeoProcess()

Method Summary

Methods

Modifier and Type	Method and Description
protected FeatureStore	buildOutPutStore(FeatureType featureType, int shapeType, String sextanteLayerName, String sextanteLayerLabel) Builds the output FeatureStore
protected FeatureStore	buildOutPutStoreFromUnion(FeatureType featureType1, FeatureType featureType2, int shapeType, String sextanteLayerName, String sextanteLayerLabel) Builds the output FeatureStore
protected FeatureStore	buildOutPutStoreFromUnion(FeatureType featureType1, FeatureType featureType2, int shapeType, String sextanteLayerName, String sextanteLayerLabel, String newField, Class<?> newFieldType) Builds the output FeatureStore
protected String	checkAttrName(String name, int size) Changes the attribute name if this name is in the list.
boolean	execute(es.unex.sextante.core.ITaskMonitor task, es.unex.sextante.core.OutputFactory outputFactory, HashMap<String,String> outputMap) This method should be used to execute the algorithm once the parameters have been assigned.
boolean	existsOutPutFile(String resultLabel, int type) Returns true if exists the output file and false i
String	getCommandLineName()
Class<? extends es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel>	getCustomParametersPanelClass()
GeoProcessManager	getGeoProcessManager() Returns the GeoProcessManager.
String	getGeoProcessName() Returns the name of the geoprocess.
protected es.unex.sextante.dataObjects.IRasterLayer	getNewRORasterLayer(String sName, String sDescription, int iDataType, int iBands) This method creates a new raster layer and adds it to the set of output objects of the algorithm.
String	getOutPutFile(String resultLabel)
FeatureQuery	getQueryFromAnalysisExtent(es.unex.sextante.core.AnalysisExtent e, FeatureStore store) Gets a feature query using the analysis bounding box
protected int	getShapeType(FeatureStore storeLayer1) Gets the shape type of the selected feature store
protected SimpleTaskStatusDelegated	getStatus()
es.unex.sextante.core.ITaskMonitor	getTaskMonitor()
protected String	getTranslation(String label) Returns the translation for a label depending on the current locale.
protected boolean	isLine(FeatureStore store) Returns true if it is a line layer
protected boolean	isPoint(FeatureStore store) Returns true if it is a point layer
protected boolean	isPolygon(FeatureStore store) Returns true if it is a polygon layer
protected boolean	isUndefined(FeatureStore store) Returns true if it is a line layer
boolean	setProgress(int iStep, int iTotalNumberOfSteps) Sets the current step in the progress bar, based on the ratio between the current task step and the total number of steps needed to complete the task
protected void	setProgressText(String sText) Sets the current progress text.
void	setTaskMonitor(es.unex.sextante.core.ITaskMonitor task)

Methods inherited from class es.unex.sextante.core.GeoAlgorithm

addOutput3DRasterLayer, addOutput3DRasterLayer, addOutputChart, addOutputChart, addOutputImage, addOutputNumericalValue, addOutputNumericalValue, addOutputObject, addOutputObject, addOutputRasterLayer, addOutputRasterLayer, addOutputRasterLayer, addOutputTable, addOutputTable, addOutputText, addOutputText, addOutputVectorLayer, addOutputVectorLayer, addOutputVectorLayer, addOutputVectorLayer, addOutputVectorLayer, adjustOutputExtent, canDefineOutputExtentFromInput, checkAttrName, defineCharacteristics, execute, generatesLayers, generatesLayersOrTables, getAlgorithmAsCommandLineSentences, getAnalysisExtent, getColorAlpha, getColorB, getColorG, getColorR, getCommandLineHelp, getCommandLineParametersHelp, getDescription, getGroup, getName, getNew3DRasterLayer, getNew3DRasterLayer, getNewInstance, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewTable, getNewVectorLayer, getNewVectorLayer, getNewVectorLayer, getNewVectorLayer, getNumberOfBandsParameters, getNumberOfLineVectorLayers, getNumberOfNoDataParameters, getNumberOfOutputObjects, getNumberOfParameters, getNumberOfPointVectorLayers, getNumberOfPolygonLayers, getNumberOfRasterLayers, getNumberOfTableFieldsParameters, getNumberOfTables, getNumberOfVectorLayers, getOutputChannel, getOutputCRS, getOutputFilename, getOutputObjects, getParameters, getProcessMetadata, getTempRasterLayer, getTempRasterLayer, getTempVectorLayer, getUserCanDefineAnalysisExtent, hasCorrectParameterValues, initializeDefaultValues, is3D, isActive, isAutoExtent, isDeterminatedProcess, isSuitableForModelling, meets3DRasterRequirements, meetsDataRequirements, meetsRasterRequirements, meetsTableRequirements, meetsVectorRequirements, preprocessForModeller, processAlgorithm, requires3DRasterLayers, requiresIndividualRasterLayers, requiresIndividualVectorLayers, requiresLineVectorLayers, requiresMultipleRasterBands, requiresMultipleRasterLayers, requiresMultipleTables, requiresMultipleVectorLayers, requiresNonDataObjects, requiresPoints, requiresPointVectorLayers, requiresPolygonVectorLayers, requiresRasterLayers, requiresTableFields, requiresTables, requiresVectorLayers, setAnalysisExtent, setColorAlpha, setColorB, setColorG, setColorR, setDescription, setGroup, setIsDeterminatedProcess, setName, setOutputObjects, setParameters, setUserCanDefineAnalysisExtent, toString

Methods inherited from class java.lang.Object

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

Field Detail

attrNames

protected String[] attrNames

geomManager

protected GeometryManager geomManager

Constructor Detail

AbstractSextanteGeoProcess

public AbstractSextanteGeoProcess()

Method Detail

execute

public boolean execute(es.unex.sextante.core.ITaskMonitor task,
              es.unex.sextante.core.OutputFactory outputFactory,
              HashMap<String,String> outputMap)
                throws es.unex.sextante.exceptions.GeoAlgorithmExecutionException

Description copied from class: es.unex.sextante.core.GeoAlgorithm

This method should be used to execute the algorithm once the parameters have been assigned.

Overrides:

execute in class es.unex.sextante.core.GeoAlgorithm

Parameters:

task - a ITaskMonitor to track the progress of the execution. If is null, a

outputFactory - The output factory to use to generate new data objects

outputMap - Maps IDataObject algorithm output names to the desired output name. At IDataObject output creation, OutputFactory implementations will receive the values in this map as names.

Returns:

true if the algorithm was correctly executed. False if it was canceled

Throws:

es.unex.sextante.exceptions.GeoAlgorithmExecutionException

See Also:

SilentTaskMonitor} will be used.

getNewRORasterLayer

protected es.unex.sextante.dataObjects.IRasterLayer getNewRORasterLayer(String sName,
                                                            String sDescription,
                                                            int iDataType,
                                                            int iBands)
                                                                 throws es.unex.sextante.exceptions.UnsupportedOutputChannelException

This method creates a new raster layer and adds it to the set of output objects of the algorithm. Use this when your algorithm generates a new raster layer and you have to create it. The grid extent is taken from the algorithm analysis extent (@see GeoAlgorithm.getAnalysisExtent()

Parameters:

sName - The name of the layer. Has to be the same that you used to define this output in the

sDescription - the long description of the output. This is the one usually used to describe the layer when added to a GIS GUI

iDataType - The data type. See

iBands - the number of bands of the new layer

Returns:

a new raster layer

Throws:

es.unex.sextante.exceptions.UnsupportedOutputChannelException

See Also:

#defineCharacteristics()} method., IRasterLayer} for more info about valid values

buildOutPutStore

protected FeatureStore buildOutPutStore(FeatureType featureType,
                            int shapeType,
                            String sextanteLayerName,
                            String sextanteLayerLabel)

Builds the output FeatureStore

Parameters:

featureType -

Returns:

FeatureStore

buildOutPutStoreFromUnion

protected FeatureStore buildOutPutStoreFromUnion(FeatureType featureType1,
                                     FeatureType featureType2,
                                     int shapeType,
                                     String sextanteLayerName,
                                     String sextanteLayerLabel)

Builds the output FeatureStore

Parameters:

featureType -

Returns:

FeatureStore

buildOutPutStoreFromUnion

protected FeatureStore buildOutPutStoreFromUnion(FeatureType featureType1,
                                     FeatureType featureType2,
                                     int shapeType,
                                     String sextanteLayerName,
                                     String sextanteLayerLabel,
                                     String newField,
                                     Class<?> newFieldType)

Builds the output FeatureStore

Parameters:

featureType -

Returns:

FeatureStore

checkAttrName

protected String checkAttrName(String name,
                   int size)

Changes the attribute name if this name is in the list.

Parameters:

name -

Returns:

getShapeType

protected int getShapeType(FeatureStore storeLayer1)
                    throws ReadException

Gets the shape type of the selected feature store

Parameters:

FeatureStore - source

Returns:

shape type

Throws:

ReadException

isPoint

protected boolean isPoint(FeatureStore store)
                   throws ReadException

Returns true if it is a point layer

Parameters:

store -

Returns:

Throws:

ReadException

isPolygon

protected boolean isPolygon(FeatureStore store)
                     throws ReadException

Returns true if it is a polygon layer

Parameters:

store -

Returns:

Throws:

ReadException

isLine

protected boolean isLine(FeatureStore store)
                  throws ReadException

Returns true if it is a line layer

Parameters:

store -

Returns:

Throws:

ReadException

isUndefined

protected boolean isUndefined(FeatureStore store)
                       throws ReadException

Returns true if it is a line layer

Parameters:

store -

Returns:

Throws:

ReadException

getGeoProcessName

public String getGeoProcessName()

Description copied from interface: GeoProcess

Returns the name of the geoprocess.

Specified by:

getGeoProcessName in interface GeoProcess

Returns:

the name of the geoprocess

setProgressText

protected void setProgressText(String sText)

Description copied from class: es.unex.sextante.core.GeoAlgorithm

Sets the current progress text. Use this to inform the user about the work that the algorithm is currently doing.

Overrides:

setProgressText in class es.unex.sextante.core.GeoAlgorithm

Parameters:

sText - the new progress text

setProgress

public boolean setProgress(int iStep,
                  int iTotalNumberOfSteps)

Description copied from class: es.unex.sextante.core.GeoAlgorithm

Sets the current step in the progress bar, based on the ratio between the current task step and the total number of steps needed to complete the task

Overrides:

setProgress in class es.unex.sextante.core.GeoAlgorithm

Parameters:

iStep - the current step

iTotalNumberOfSteps - the total number of steps

Returns:

true if the task hasn't been canceled

getStatus

protected SimpleTaskStatusDelegated getStatus()

getCommandLineName

public String getCommandLineName()

Overrides:

getCommandLineName in class es.unex.sextante.core.GeoAlgorithm

Returns:

the command line name of the algorithm

getGeoProcessManager

public GeoProcessManager getGeoProcessManager()

Returns the GeoProcessManager.

Returns:

the GeoProcessManager

getTranslation

protected String getTranslation(String label)

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

Parameters:

label - to translate

Returns:

text in the current locale

getCustomParametersPanelClass

public Class<? extends es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel> getCustomParametersPanelClass()

getQueryFromAnalysisExtent

public FeatureQuery getQueryFromAnalysisExtent(es.unex.sextante.core.AnalysisExtent e,
                                      FeatureStore store)
                                        throws CreateEnvelopeException,
                                               DataException

Gets a feature query using the analysis bounding box

Parameters:

e -

store -

Returns:

Throws:

CreateEnvelopeException

DataException

existsOutPutFile

public boolean existsOutPutFile(String resultLabel,
                       int type)

Returns true if exists the output file and false i

Parameters:

resultLabel -

type - zero shape and one tif

Returns:

getOutPutFile

public String getOutPutFile(String resultLabel)

getTaskMonitor

public es.unex.sextante.core.ITaskMonitor getTaskMonitor()

setTaskMonitor

public void setTaskMonitor(es.unex.sextante.core.ITaskMonitor task)