org.gvsig.geoprocess.algorithm.spatialjoin

Class SpatialJoinAlgorithm

java.lang.Object

es.unex.sextante.core.GeoAlgorithm

org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess

org.gvsig.geoprocess.algorithm.spatialjoin.SpatialJoinAlgorithm

All Implemented Interfaces:

GeoProcess

public class SpatialJoinAlgorithm
extends AbstractSextanteGeoProcess

Spatial join algorithm

Field Summary

Fields

Modifier and Type	Field and Description
static String	FUNCTION_LIST
static String	LAYER1
static String	LAYER2
static String	NEAREST
static String	NEW_FIELD
static String	RESULT
static String	SELECTGEOM_INPUT
static String	SELECTGEOM_OVERLAY
static String[]	Summary

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

attrNames, 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
SpatialJoinAlgorithm()

Method Summary

Modifier and Type	Method and Description
protected FeatureStore	buildSpatialJoinOutPutStore(FeatureType featureType1, int shapeType, String sextanteLayerName, String sextanteLayerLabel) Builds the output FeatureStore
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.
Class<? extends es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel>	getCustomParametersPanelClass()
boolean	processAlgorithm() This method should implement the algorithm itself, using the values of the parameters and processing them.

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

buildOutPutStore, buildOutPutStoreFromUnion, buildOutPutStoreFromUnion, checkAttrName, execute, existsOutPutFile, getCommandLineName, getGeoProcessManager, getGeoProcessName, getNewRORasterLayer, getOutPutFile, getQueryFromAnalysisExtent, getShapeType, getStatus, getTaskMonitor, getTranslation, isLine, isPoint, isPolygon, isUndefined, setProgress, 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, 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, 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

NEW_FIELD

public static final String NEW_FIELD

See Also:

Constant Field Values

RESULT

public static final String RESULT

See Also:

Constant Field Values

LAYER1

public static final String LAYER1

See Also:

Constant Field Values

LAYER2

public static final String LAYER2

See Also:

Constant Field Values

SELECTGEOM_INPUT

public static final String SELECTGEOM_INPUT

See Also:

Constant Field Values

SELECTGEOM_OVERLAY

public static final String SELECTGEOM_OVERLAY

See Also:

Constant Field Values

NEAREST

public static final String NEAREST

See Also:

Constant Field Values

FUNCTION_LIST

public static final String FUNCTION_LIST

See Also:

Constant Field Values

Summary

public static final String[] Summary

Constructor Detail

SpatialJoinAlgorithm

public SpatialJoinAlgorithm()

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

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

buildSpatialJoinOutPutStore

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

Builds the output FeatureStore

Parameters:

featureType -

Returns:

FeatureStore

getCustomParametersPanelClass

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

Overrides:

getCustomParametersPanelClass in class AbstractSextanteGeoProcess