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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• When the input is point (or multipoint) features, and the features are stored in a geographic coordinate system (that is, longitude and latitude coordinates), the result will be geodesic buffers. For further details see How Buffer works;
• Features will be excluded from the buffer process if their buffer distance is zero.
• Negative distances can be used when buffering polygon features, to create buffers on the inside of the polygon features. Using a negative value will shrink the output polygon feature by the distance specified. If the negative distance is large enough this could result in a null geometry being generated. These null geometry features will not be written to the output feature class and a warning message will be printed.
• Side Type's LEFT and RIGHT options and End Type's FLAT as well as the OUTSIDE_ONLY option are only available with an ArcInfo licence.
• Using the Dissolve Type parameter's NONE option will cause a 'BUFF_DIST' field to be added to the Output Feature Class. This field will contain the buffer distance used to buffer each feature.
• The buffered edges of a LEFT or RIGHT side buffer are different from those created by a FULL buffer due to differences in the algorithms used to create the buffers. When using the LEFT or RIGHT option, a vertex is placed at every degree along the point of rotation, the value is smaller using the FULL option, which creates a smoother line. The difference between the two is within the precision of the Input Features.
• Buffer can create very large multipart polygon features when using the Dissolve option. This is especially true when using a small number of Dissolve Field(s) or when dissolving all polygons into a single polygon. Very large polygon features may cause display problems and/or have poor performance when drawn on a map or when edited. To avoid these potential problems, use Multipart To Singlepart; on Buffer's output to split larger multipart features into many smaller features.
• When using the results of Buffer as input to an overlay operation such as Union; or Intersect; , it is recommended that Buffer output be dissolved in order to reduce the number of features and overlap. This can be done when only a subset of the Input Feature's attributes are necessary for the analysis being performed. This will reduce the number of spatial relationships between the input features being processed, thereby reducing the amount of memory the tool requires and the amount of time required for processing.
• The Dissolve Fields parameter Add Field button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or it's derived data does not exist, the Dissolve Fields parameter may not be populated with field names. The Add Field button allows you to add expected fields so you can complete the Buffer dialog and continue to build your model.
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

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