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

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

public class Buffer
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Creates buffer polygons around specified input coverage features. The Buffer tool is contained in the Coverage Tools tool box.
Learn more about how Buffer works

Software restrictions: ArcInfo only

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 inCover, Object outCover)
          Creates the Buffer tool with the required parameters.
 
Method Summary
 double getBufferDistance()
          Returns the Buffer Distance parameter of this tool .
 String getBufferItem()
          Returns the Buffer Item parameter of this tool .
 String getBufferShape()
          Returns the Buffer Shape parameter of this tool .
 String getBufferSide()
          Returns the Buffer Side parameter of this tool .
 Object getBufferTable()
          Returns the Buffer Table parameter of this tool .
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 double getFuzzyTolerance()
          Returns the Fuzzy Tolerance parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setBufferDistance(double bufferDistance)
          Sets the Buffer Distance parameter of this tool .
 void setBufferItem(String bufferItem)
          Sets the Buffer Item parameter of this tool .
 void setBufferShape(String bufferShape)
          Sets the Buffer Shape parameter of this tool .
 void setBufferSide(String bufferSide)
          Sets the Buffer Side parameter of this tool .
 void setBufferTable(Object bufferTable)
          Sets the Buffer Table parameter of this tool .
 void setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setFuzzyTolerance(double fuzzyTolerance)
          Sets the Fuzzy Tolerance parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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 inCover,
              Object outCover)
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:
inCover - Coverage, the coverage containing features to be buffered.
outCover - Coverage, the polygon buffer coverage to be created.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing features to be buffered. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing features to be buffered. This is a required parameter.

Parameters:
inCover - Coverage, the coverage containing features to be buffered.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the polygon buffer coverage to be created. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the polygon buffer coverage to be created. This is a required parameter.

Parameters:
outCover - Coverage, the polygon buffer coverage to be created.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is String, the feature class to be buffered: This is an optional parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is String, the feature class to be buffered: This is an optional parameter.

Parameters:
featureType - String, the feature class to be buffered:

getBufferItem

public String getBufferItem()
Returns the Buffer Item parameter of this tool . This parameter is String, an item in the feature attribute table of input coverage whose value is used as the feature's buffer distance. If a buffer table is used, the buffer item functions as a lookup item in the buffer table. This is an optional parameter.

Returns:
the Buffer Item

setBufferItem

public void setBufferItem(String bufferItem)
Sets the Buffer Item parameter of this tool . This parameter is String, an item in the feature attribute table of input coverage whose value is used as the feature's buffer distance. If a buffer table is used, the buffer item functions as a lookup item in the buffer table. This is an optional parameter.

Parameters:
bufferItem - String, an item in the feature attribute table of input coverage whose value is used as the feature's buffer distance. If a buffer table is used, the buffer item functions as a lookup item in the buffer table.

getBufferTable

public Object getBufferTable()
Returns the Buffer Table parameter of this tool . This parameter is ArcInfo Table, an INFO lookup table that lists a buffer distance for each buffer item. A buffer table can be specified only if the buffer item is specified. The buffer table contains at least two items: This is an optional parameter.

Returns:
the Buffer Table

setBufferTable

public void setBufferTable(Object bufferTable)
Sets the Buffer Table parameter of this tool . This parameter is ArcInfo Table, an INFO lookup table that lists a buffer distance for each buffer item. A buffer table can be specified only if the buffer item is specified. The buffer table contains at least two items: This is an optional parameter.

Parameters:
bufferTable - ArcInfo Table, an INFO lookup table that lists a buffer distance for each buffer item. A buffer table can be specified only if the buffer item is specified. The buffer table contains at least two items:

getBufferDistance

public double getBufferDistance()
Returns the Buffer Distance parameter of this tool . This parameter is Double, the distance used to create buffer zones around input coverage features when buffer item and buffer table are not specified. The default buffer distance is 0.125 coverage units. This default buffer distance will be applied whenever a value for this parameter is not specified. The smallest buffer distance that can be computed is 0.00000005 coverage units. Specifying a buffer distance below this threshold will result in an empty output coverage. For polygon features, if a negative buffer distance is used, buffers will be generated on the insides of polygons. This is an optional parameter.

Returns:
the Buffer Distance

setBufferDistance

public void setBufferDistance(double bufferDistance)
Sets the Buffer Distance parameter of this tool . This parameter is Double, the distance used to create buffer zones around input coverage features when buffer item and buffer table are not specified. The default buffer distance is 0.125 coverage units. This default buffer distance will be applied whenever a value for this parameter is not specified. The smallest buffer distance that can be computed is 0.00000005 coverage units. Specifying a buffer distance below this threshold will result in an empty output coverage. For polygon features, if a negative buffer distance is used, buffers will be generated on the insides of polygons. This is an optional parameter.

Parameters:
bufferDistance - Double, the distance used to create buffer zones around input coverage features when buffer item and buffer table are not specified. The default buffer distance is 0.125 coverage units. This default buffer distance will be applied whenever a value for this parameter is not specified. The smallest buffer distance that can be computed is 0.00000005 coverage units. Specifying a buffer distance below this threshold will result in an empty output coverage. For polygon features, if a negative buffer distance is used, buffers will be generated on the insides of polygons.

getFuzzyTolerance

public double getFuzzyTolerance()
Returns the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. This is an optional parameter.

Returns:
the Fuzzy Tolerance

setFuzzyTolerance

public void setFuzzyTolerance(double fuzzyTolerance)
Sets the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. This is an optional parameter.

Parameters:
fuzzyTolerance - Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used.

getBufferShape

public String getBufferShape()
Returns the Buffer Shape parameter of this tool . This parameter is String, for lines, the shape of the buffer at the line endpoints. This is an optional parameter.

Returns:
the Buffer Shape

setBufferShape

public void setBufferShape(String bufferShape)
Sets the Buffer Shape parameter of this tool . This parameter is String, for lines, the shape of the buffer at the line endpoints. This is an optional parameter.

Parameters:
bufferShape - String, for lines, the shape of the buffer at the line endpoints.

getBufferSide

public String getBufferSide()
Returns the Buffer Side parameter of this tool . This parameter is String, for lines, the topological side on which the buffer may be generated. This is an optional parameter.

Returns:
the Buffer Side

setBufferSide

public void setBufferSide(String bufferSide)
Sets the Buffer Side parameter of this tool . This parameter is String, for lines, the topological side on which the buffer may be generated. This is an optional parameter.

Parameters:
bufferSide - String, for lines, the topological side on which the buffer may be generated.

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