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 around input features to a specified distance. An optional dissolve can be performed to combine overlapping buffers. The Buffer tool is contained in the Analysis Tools tool box.

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 - the input point, line, or polygon features to be buffered.
outFeatureClass - the feature class containing the output feature buffers.
bufferDistanceOrField - the distance around the input features in which buffer zones are created. Distances can be provided as either a value representing a linear distance or as a numeric field from the input features that contains the linear distances to buffer each feature. if the Distance linear units are not specified or are entered as Unknown, the linear unit of the input features' spatial reference is used.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the input point, line, or polygon features 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 the input point, line, or polygon features to be buffered. This is a required parameter.

Parameters:
inFeatures - the input point, line, or polygon features to be buffered.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the feature class containing the output feature buffers. 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 the feature class containing the output feature buffers. This is a required parameter.

Parameters:
outFeatureClass - the feature class containing the output feature buffers.

getBufferDistanceOrField

public Object getBufferDistanceOrField()
Returns the Distance [value or field] parameter of this tool . This parameter is the distance around the input features in which buffer zones are created. Distances can be provided as either a value representing a linear distance or as a numeric field from the input features that contains the linear distances to buffer each feature. if the Distance linear units are not specified or are entered as Unknown, the linear unit of the input features' spatial reference is 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 the distance around the input features in which buffer zones are created. Distances can be provided as either a value representing a linear distance or as a numeric field from the input features that contains the linear distances to buffer each feature. if the Distance linear units are not specified or are entered as Unknown, the linear unit of the input features' spatial reference is used. This is a required parameter.

Parameters:
bufferDistanceOrField - the distance around the input features in which buffer zones are created. Distances can be provided as either a value representing a linear distance or as a numeric field from the input features that contains the linear distances to buffer each feature. if the Distance linear units are not specified or are entered as Unknown, the linear unit of the input features' spatial reference is used.

getLineSide

public String getLineSide()
Returns the Side Type parameter of this tool . This parameter is the side(s) of the input features that will be buffered. this optional parameter is not available with a Basic or Standard 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 the side(s) of the input features that will be buffered. this optional parameter is not available with a Basic or Standard license. This is an optional parameter.

Parameters:
lineSide - the side(s) of the input features that will be buffered. this optional parameter is not available with a Basic or Standard license.

getLineEndType

public String getLineEndType()
Returns the End Type parameter of this tool . This parameter is the shape of the buffer at the end of line input features. This parameter is not valid for polygon input features. this optional parameter is not available with a Basic or Standard license. 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 the shape of the buffer at the end of line input features. This parameter is not valid for polygon input features. this optional parameter is not available with a Basic or Standard license. This is an optional parameter.

Parameters:
lineEndType - the shape of the buffer at the end of line input features. This parameter is not valid for polygon input features. this optional parameter is not available with a Basic or Standard license.

getDissolveOption

public String getDissolveOption()
Returns the Dissolve Type parameter of this tool . This parameter is specifies the dissolve to be performed to remove output buffer 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 specifies the dissolve to be performed to remove output buffer overlap. This is an optional parameter.

Parameters:
dissolveOption - specifies the dissolve to be performed to remove output buffer overlap.

getDissolveField

public Object getDissolveField()
Returns the Dissolve Field(s) parameter of this tool . This parameter is the list of field(s) from the input features on which to dissolve the output buffers. Any buffers sharing attribute values in the listed fields (carried over from the input features) are dissolved. 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 the list of field(s) from the input features on which to dissolve the output buffers. Any buffers sharing attribute values in the listed fields (carried over from the input features) are dissolved. This is an optional parameter.

Parameters:
dissolveField - the list of field(s) from the input features on which to dissolve the output buffers. Any buffers sharing attribute values in the listed fields (carried over from the input features) are dissolved.

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