org.gvsig.geoprocess.algorithm.fusespatially

Class FuseSpatiallyAlgorithm

java.lang.Object

es.unex.sextante.core.GeoAlgorithm

org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess

org.gvsig.geoprocess.algorithm.fusespatially.FuseSpatiallyAlgorithm

All Implemented Interfaces:

GeoProcess

public class FuseSpatiallyAlgorithm
extends AbstractSextanteGeoProcess

Fuse spatially algorithm

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LAYER
static java.lang.String	RESULT
static java.lang.String	RESULT_TABLE
static java.lang.String	SELECTED_GEOM

Fields inherited from class org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess

attrNames, geomManager

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

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

Constructor Summary

Constructors

Constructor and Description
FuseSpatiallyAlgorithm()

Method Summary

Modifier and Type	Method and Description
protected FeatureStore	buildFuseSpatiallyOutPutStore(java.lang.String[] attrNames, java.lang.Class[] types, int shapeType, java.lang.String sextanteLayerName, java.lang.String sextanteLayerLabel) Builds the output FeatureStore
java.lang.String[]	checkFields(java.lang.String[] names) Removes duplicate fields
void	computesGeometryOperation(FeatureStore inFeatStore, FeatureStore outFeatStore, FeatureStore outFeatStoreTable, java.lang.String[] attrNames, java.lang.String[] attrNamesTable, boolean selectedGeom, SimpleTaskStatus status, java.lang.String idField) Deprecated. This method uses FuseSpatiallyOperation which is deprecated
void	defineCharacteristics() This method should be overridden and used to specify the parameters needed by the GeoAlgorithm, using the corresponding methods of the ParametersSet object.
boolean	execute(FeatureStore inputStoreLayer, FeatureStore outFeatStore, int shapeType, boolean selectedGeom, SimpleTaskStatus status, java.lang.String idField, boolean createTable)
boolean	processAlgorithm() This method should implement the algorithm itself, using the values of the parameters and processing them.
void	setParentProcess(AbstractSextanteGeoProcess process)
boolean	setProgress(int step, int size) 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

Methods inherited from class org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess

buildOutPutStore, buildOutPutStoreFromUnion, buildOutPutStoreFromUnion, checkAttrName, execute, existsOutPutFile, getCommandLineName, getCustomParametersPanelClass, getGeoProcessManager, getGeoProcessName, getNamesTranslator, getNewRORasterLayer, getOutPutFile, getQueryFromAnalysisExtent, getShapeType, getStatus, getTaskMonitor, getTranslation, isLine, isPoint, isPolygon, isUndefined, setProgressText, setTaskMonitor

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, execute, generatesLayers, generatesLayersOrTables, getAlgorithmAsCommandLineSentences, getAnalysisExtent, getColorAlpha, getColorB, getColorG, getColorR, getCommandLineHelp, getCommandLineParametersHelp, getDescription, getGroup, getHelpFile, getName, getNew3DRasterLayer, getNew3DRasterLayer, getNewInstance, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewRasterLayer, getNewTable, getNewVectorLayer, getNewVectorLayer, getNewVectorLayer, getNewVectorLayer, getNumberOfBandsParameters, getNumberOfLineVectorLayers, getNumberOfNoDataParameters, getNumberOfOutputObjects, getNumberOfParameters, getNumberOfPointVectorLayers, getNumberOfPolygonLayers, getNumberOfRasterLayers, getNumberOfTableFieldsParameters, getNumberOfTableFilterParameters, getNumberOfTables, getNumberOfVectorLayers, getOutputChannel, getOutputCRS, getOutputFilename, getOutputObjects, getParameters, getProcessMetadata, getRecalculateForCell, getTempRasterLayer, getTempRasterLayer, getTempVectorLayer, getUserCanDefineAnalysisExtent, hasCorrectParameterValues, initializeDefaultValues, is3D, isActive, isAutoExtent, isDeterminatedProcess, isSuitableForModelling, meets3DRasterRequirements, meetsDataRequirements, meetsRasterRequirements, meetsTableRequirements, meetsVectorRequirements, preprocessForModeller, 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, setRecalculateForCell, setUserCanDefineAnalysisExtent, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESULT

public static final java.lang.String RESULT

See Also:

Constant Field Values

RESULT_TABLE

public static final java.lang.String RESULT_TABLE

See Also:

Constant Field Values

LAYER

public static final java.lang.String LAYER

See Also:

Constant Field Values

SELECTED_GEOM

public static final java.lang.String SELECTED_GEOM

See Also:

Constant Field Values

Constructor Detail

FuseSpatiallyAlgorithm

public FuseSpatiallyAlgorithm()

Method Detail

defineCharacteristics

public void defineCharacteristics()

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

This method should be overridden and used to specify the parameters needed by the GeoAlgorithm, using the corresponding methods of the ParametersSet object. Also, output objects must be added, so SEXTANTE knows in advance which outputs will be generated by the algorithm. See the addOutputXXXX family of methods (GeoAlgorithm.addOutputRasterLayer(java.lang.String, java.lang.String, int, es.unex.sextante.outputs.IOutputChannel, es.unex.sextante.dataObjects.IRasterLayer), GeoAlgorithm.addOutputVectorLayer(java.lang.String, java.lang.String, int, es.unex.sextante.outputs.IOutputChannel, es.unex.sextante.dataObjects.IVectorLayer, java.lang.String, int), etc.)

Specified by:

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

setParentProcess

public void setParentProcess(AbstractSextanteGeoProcess process)

processAlgorithm

public boolean processAlgorithm()
                         throws es.unex.sextante.exceptions.GeoAlgorithmExecutionException

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

This method should implement the algorithm itself, using the values of the parameters and processing them.

Specified by:

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

Returns:

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

Throws:

es.unex.sextante.exceptions.GeoAlgorithmExecutionException - if there were problems during algorithm execution

execute

public boolean execute(FeatureStore inputStoreLayer,
                       FeatureStore outFeatStore,
                       int shapeType,
                       boolean selectedGeom,
                       SimpleTaskStatus status,
                       java.lang.String idField,
                       boolean createTable)
                throws DataException

Parameters:

inputStoreLayer -

outFeatStore -

shapeType -

selectedGeom -

status -

idField -

createTable -

Returns:

boolean

Throws:

DataException

checkFields

public java.lang.String[] checkFields(java.lang.String[] names)

Removes duplicate fields

Parameters:

names -

Returns:

computesGeometryOperation

public void computesGeometryOperation(FeatureStore inFeatStore,
                                      FeatureStore outFeatStore,
                                      FeatureStore outFeatStoreTable,
                                      java.lang.String[] attrNames,
                                      java.lang.String[] attrNamesTable,
                                      boolean selectedGeom,
                                      SimpleTaskStatus status,
                                      java.lang.String idField)
                               throws DataException

Deprecated. This method uses FuseSpatiallyOperation which is deprecated

Computes a complete operation over the input FeatureStore. The result of this operation is stored in the output FeatureStore. This method will call once for each geometry.

Parameters:

inFeatStore - Input FeatureStore

outFeatStore - Output FeatureStore

attrNames - List of attributes to build the output feature store

selectedGeom - If it is true only the selected geometries will be processed

Throws:

DataException

setProgress

public boolean setProgress(int step,
                           int size)

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 AbstractSextanteGeoProcess

Parameters:

step - the current step

size - the total number of steps

Returns:

true if the task hasn't been canceled

buildFuseSpatiallyOutPutStore

protected FeatureStore buildFuseSpatiallyOutPutStore(java.lang.String[] attrNames,
                                                     java.lang.Class[] types,
                                                     int shapeType,
                                                     java.lang.String sextanteLayerName,
                                                     java.lang.String sextanteLayerLabel)

Builds the output FeatureStore

Parameters:

featureType -

Returns:

FeatureStore