BufferAlgorithm

java.lang.Object
- es.unex.sextante.core.GeoAlgorithm
- - org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess
  - - org.gvsig.geoprocess.algorithm.buffer.BufferAlgorithm

All Implemented Interfaces:

GeoProcess

Direct Known Subclasses:

LateralBufferAlgorithm
```
public class BufferAlgorithm
extends AbstractSextanteGeoProcess
```
Geoprocess that computes a buffer area around each feature's geometry of the input layer.
All the points interior to this buffer area has to be at a distance inferior to "buffer distance" to the original geometry. This buffer distance could be constant, or it could be a function of the value of a feature attribute.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AREA`
`static byte`	`BUFFER_INSIDE_OUTSIDE_POLY` For polygonal buffers, compute interior and exterior buffers
`static byte`	`BUFFER_INSIDE_POLY` For polygonal buffers, only compute interior buffers
`static byte`	`BUFFER_OUTSIDE_POLY` For polygonal buffers, only compute exterior buffers (is the default operation, it applies to any geometry type)
`protected boolean`	`dissolve`
`static String`	`DISSOLVE`
`static String`	`DISTANCE`
`static byte`	`FID_DIST_FIELDS`
`static byte`	`FID_FROM_TO_FIELDS`
`static String`	`FIELD`
`protected FeatureStore`	`inputStore`
`static String`	`LAYER`
`protected FeatureStore`	`outputStore`
`static String`	`RESULT`
`static String`	`RING_NUMBER`
`protected int`	`rings`
`protected boolean`	`round_border`
`static String`	`ROUND_BORDER`
`static String`	`SELECTED_GEOM`
`protected boolean`	`selectedGeom`
`protected es.unex.sextante.dataObjects.IVectorLayer`	`sextanteInputLayer`
`static String[]`	`sOptions`
`static byte`	`SOURCE_FIELDS`
`protected byte`	`tableFields`

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

BufferAlgorithm()

Constructors
Constructor and Description
`BufferAlgorithm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected FeatureStore`	`buildOutPutStore(int shapeType, String sextanteLayerName, String sextanteLayerLabel)` Builds the output FeatureStore
`protected FeatureStore`	`buildTemporalStore(int shapeType, String file, IProjection crs)` Builds the output FeatureStore
`protected void`	`computesBufferAlgWithDissolve(BufferOperation operation)`
`protected void`	`computesBufferAlgWithoutDissolve(BufferOperation operation)`
`FeatureStore`	`create(String sFilename, int[] types, String[] attrNames, IProjection crs)`
`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()`
`protected byte`	`getTableFieldsStructure()` Gets the constant with the table structure
`boolean`	`processAlgorithm()` This method should implement the algorithm itself, using the values of the parameters and processing them.
`protected void`	`readParameters()`

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
  - RESULT
```
public static final String RESULT
```
    See Also:
    
    Constant Field Values
  - LAYER
```
public static final String LAYER
```
    See Also:
    
    Constant Field Values
  - SELECTED_GEOM
```
public static final String SELECTED_GEOM
```
    See Also:
    
    Constant Field Values
  - DISTANCE
```
public static final String DISTANCE
```
    See Also:
    
    Constant Field Values
  - FIELD
```
public static final String FIELD
```
    See Also:
    
    Constant Field Values
  - DISSOLVE
```
public static final String DISSOLVE
```
    See Also:
    
    Constant Field Values
  - ROUND_BORDER
```
public static final String ROUND_BORDER
```
    See Also:
    
    Constant Field Values
  - AREA
```
public static final String AREA
```
    See Also:
    
    Constant Field Values
  - RING_NUMBER
```
public static final String RING_NUMBER
```
    See Also:
    
    Constant Field Values
  - BUFFER_OUTSIDE_POLY
```
public static final byte BUFFER_OUTSIDE_POLY
```
    For polygonal buffers, only compute exterior buffers (is the default operation, it applies to any geometry type)
    
    See Also:
    
    Constant Field Values
  - BUFFER_INSIDE_POLY
```
public static final byte BUFFER_INSIDE_POLY
```
    For polygonal buffers, only compute interior buffers
    
    See Also:
    
    Constant Field Values
  - BUFFER_INSIDE_OUTSIDE_POLY
```
public static final byte BUFFER_INSIDE_OUTSIDE_POLY
```
    For polygonal buffers, compute interior and exterior buffers
    
    See Also:
    
    Constant Field Values
  - SOURCE_FIELDS
```
public static final byte SOURCE_FIELDS
```
    See Also:
    
    Constant Field Values
  - FID_DIST_FIELDS
```
public static final byte FID_DIST_FIELDS
```
    See Also:
    
    Constant Field Values
  - FID_FROM_TO_FIELDS
```
public static final byte FID_FROM_TO_FIELDS
```
    See Also:
    
    Constant Field Values
  - tableFields
```
protected byte tableFields
```
  - dissolve
```
protected boolean dissolve
```
  - rings
```
protected int rings
```
  - selectedGeom
```
protected boolean selectedGeom
```
  - inputStore
```
protected FeatureStore inputStore
```
  - outputStore
```
protected FeatureStore outputStore
```
  - sextanteInputLayer
```
protected es.unex.sextante.dataObjects.IVectorLayer sextanteInputLayer
```
  - round_border
```
protected boolean round_border
```
  - sOptions
```
public static String[] sOptions
```
- Constructor Detail
  - BufferAlgorithm
```
public BufferAlgorithm()
```
- 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
  - readParameters
```
protected void readParameters()
                       throws es.unex.sextante.exceptions.WrongParameterTypeException,
                              es.unex.sextante.exceptions.NullParameterValueException,
                              es.unex.sextante.exceptions.WrongParameterIDException
```
    Throws:
    
    es.unex.sextante.exceptions.WrongParameterTypeException
    
    es.unex.sextante.exceptions.NullParameterValueException
    
    es.unex.sextante.exceptions.WrongParameterIDException
  - 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
  - computesBufferAlgWithDissolve
```
protected void computesBufferAlgWithDissolve(BufferOperation operation)
                                      throws DataException
```
    Throws:
    
    DataException
  - computesBufferAlgWithoutDissolve
```
protected void computesBufferAlgWithoutDissolve(BufferOperation operation)
                                         throws DataException
```
    Throws:
    
    DataException
  - getTableFieldsStructure
```
protected byte getTableFieldsStructure()
```
    Gets the constant with the table structure
    
    Returns:
  - buildOutPutStore
```
protected FeatureStore buildOutPutStore(int shapeType,
                                        String sextanteLayerName,
                                        String sextanteLayerLabel)
                                 throws DataException
```
    Builds the output FeatureStore
    
    Parameters:
    
    featureType -
    
    Returns:
    
    FeatureStore
    
    Throws:
    
    DataException
  - buildTemporalStore
```
protected FeatureStore buildTemporalStore(int shapeType,
                                          String file,
                                          IProjection crs)
                                   throws DataException,
                                          ValidateDataParametersException
```
    Builds the output FeatureStore
    
    Parameters:
    
    featureType -
    
    Returns:
    
    FeatureStore
    
    Throws:
    
    DataException
    
    ValidateDataParametersException
  - create
```
public FeatureStore create(String sFilename,
                           int[] types,
                           String[] attrNames,
                           IProjection crs)
```
  - getCustomParametersPanelClass
```
public Class<? extends es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel> getCustomParametersPanelClass()
```
    Overrides:
    
    getCustomParametersPanelClass in class AbstractSextanteGeoProcess

Class BufferAlgorithm

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

RESULT

LAYER

SELECTED_GEOM

DISTANCE

FIELD

DISSOLVE

ROUND_BORDER

AREA

RING_NUMBER

BUFFER_OUTSIDE_POLY

BUFFER_INSIDE_POLY

BUFFER_INSIDE_OUTSIDE_POLY

SOURCE_FIELDS

FID_DIST_FIELDS

FID_FROM_TO_FIELDS

tableFields

dissolve

rings

selectedGeom

inputStore

outputStore

sextanteInputLayer

round_border

sOptions

Constructor Detail

BufferAlgorithm

Method Detail

defineCharacteristics

readParameters

processAlgorithm

computesBufferAlgWithDissolve

computesBufferAlgWithoutDissolve

getTableFieldsStructure

buildOutPutStore

buildTemporalStore

create

getCustomParametersPanelClass