com.esri.arcgis.geoprocessing.tools.analysistools
Class Buffer

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analysistools.Buffer
All Implemented Interfaces:
GPTool

public class Buffer
extends AbstractGPTool

Creates buffer polygons to a specified distance around the Input Features. An optional dissolve can be performed to remove overlapping buffers. The Buffer tool is contained in the Analysis Tools tool box.
Learn more about how Buffer works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Buffer()
          Creates the Buffer tool with defaults.
Buffer(Object inFeatures, Object outFeatureClass, Object bufferDistanceOrField)
          Creates the Buffer tool with the required parameters.
 
Method Summary
 Object getBufferDistanceOrField()
          Returns the Distance [value or field] parameter of this tool .
 Object getDissolveField()
          Returns the Dissolve Field(s) parameter of this tool .
 String getDissolveOption()
          Returns the Dissolve Type parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 String getLineEndType()
          Returns the End Type parameter of this tool .
 String getLineSide()
          Returns the Side Type parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 void setBufferDistanceOrField(Object bufferDistanceOrField)
          Sets the Distance [value or field] parameter of this tool .
 void setDissolveField(Object dissolveField)
          Sets the Dissolve Field(s) parameter of this tool .
 void setDissolveOption(String dissolveOption)
          Sets the Dissolve Type parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setLineEndType(String lineEndType)
          Sets the End Type parameter of this tool .
 void setLineSide(String lineSide)
          Sets the Side Type parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Buffer

public Buffer()
Creates the Buffer tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


Buffer

public Buffer(Object inFeatures,
              Object outFeatureClass,
              Object bufferDistanceOrField)
Creates the Buffer tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inFeatures - Feature Layer, the feature layer or feature class to be buffered.
outFeatureClass - Feature Class, the feature class that will be created and to which the resulting features will be written.
bufferDistanceOrField - Linear unit | Field, if the distance units are not specified, or entered as 'Unknown', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used).
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the feature layer or feature class to be buffered. This is a required parameter.

Returns:
the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Features parameter of this tool . This parameter is Feature Layer, the feature layer or feature class to be buffered. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the feature layer or feature class to be buffered.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will be created and to which the resulting features will be written. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will be created and to which the resulting features will be written. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the feature class that will be created and to which the resulting features will be written.

getBufferDistanceOrField

public Object getBufferDistanceOrField()
Returns the Distance [value or field] parameter of this tool . This parameter is Linear unit | Field, if the distance units are not specified, or entered as 'Unknown', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used). This is a required parameter.

Returns:
the Distance [value or field]

setBufferDistanceOrField

public void setBufferDistanceOrField(Object bufferDistanceOrField)
Sets the Distance [value or field] parameter of this tool . This parameter is Linear unit | Field, if the distance units are not specified, or entered as 'Unknown', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used). This is a required parameter.

Parameters:
bufferDistanceOrField - Linear unit | Field, if the distance units are not specified, or entered as 'Unknown', the units of the Input Features are used (or if the Output Coordinate System environment has been set, its units will be used).

getLineSide

public String getLineSide()
Returns the Side Type parameter of this tool . This parameter is String, these options are not available with an ArcView or ArcEditor license. This is an optional parameter.

Returns:
the Side Type

setLineSide

public void setLineSide(String lineSide)
Sets the Side Type parameter of this tool . This parameter is String, these options are not available with an ArcView or ArcEditor license. This is an optional parameter.

Parameters:
lineSide - String, these options are not available with an ArcView or ArcEditor license.

getLineEndType

public String getLineEndType()
Returns the End Type parameter of this tool . This parameter is String, these options are not available with an ArcView or ArcEditor license. Line buffers will always have ROUND ends. This is an optional parameter.

Returns:
the End Type

setLineEndType

public void setLineEndType(String lineEndType)
Sets the End Type parameter of this tool . This parameter is String, these options are not available with an ArcView or ArcEditor license. Line buffers will always have ROUND ends. This is an optional parameter.

Parameters:
lineEndType - String, these options are not available with an ArcView or ArcEditor license. Line buffers will always have ROUND ends.

getDissolveOption

public String getDissolveOption()
Returns the Dissolve Type parameter of this tool . This parameter is String, specifies whether a dissolve will be performed to remove buffer feature overlap. This is an optional parameter.

Returns:
the Dissolve Type

setDissolveOption

public void setDissolveOption(String dissolveOption)
Sets the Dissolve Type parameter of this tool . This parameter is String, specifies whether a dissolve will be performed to remove buffer feature overlap. This is an optional parameter.

Parameters:
dissolveOption - String, specifies whether a dissolve will be performed to remove buffer feature overlap.

getDissolveField

public Object getDissolveField()
Returns the Dissolve Field(s) parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. This is an optional parameter.

Returns:
the Dissolve Field(s)

setDissolveField

public void setDissolveField(Object dissolveField)
Sets the Dissolve Field(s) parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. This is an optional parameter.

Parameters:
dissolveField - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model.

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias