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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.MultipleRingBuffer

All Implemented Interfaces:

GPTool

public class MultipleRingBuffer
extends AbstractGPTool

Creates multiple buffers at specified distances around the input features. These buffers can optionally be merged and dissolved using the buffer distance values to create non-overlapping buffers. The Multiple Ring Buffer tool is contained in the Analysis Tools tool box.

Usage tips:

• The tool creates temporary data. This temporary data will be written to the location specified in the environment setting. If the Scratch workspace environment is not set, the temporary data is written to the location defined by the TEMP system variable.
• If the input features do not have a defined spatial reference, the distance units of the input feature class is unknown. Therefore, the Buffer Unit parameter (i.e., meters, feet) is ignored if the input features do not have a spatial reference.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MultipleRingBuffer()
Creates the Multiple Ring Buffer tool with defaults.

MultipleRingBuffer(Object inputFeatures, Object outputFeatureClass, Object distances)
Creates the Multiple Ring Buffer tool with the required parameters.

Method Summary

String	getBufferUnit() Returns the Buffer Unit parameter of this tool .
String	getDissolveOption() Returns the Dissolve Option parameter of this tool .
Object	getDistances() Returns the Distances parameter of this tool .
String	getFieldName() Returns the Field Name parameter of this tool .
Object	getInputFeatures() Returns the Input Features parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature class parameter of this tool .
String	getOutsidePolygonsOnly() Returns the Outside Polygons Only 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	setBufferUnit(String bufferUnit) Sets the Buffer Unit parameter of this tool .
void	setDissolveOption(String dissolveOption) Sets the Dissolve Option parameter of this tool .
void	setDistances(Object distances) Sets the Distances parameter of this tool .
void	setFieldName(String fieldName) Sets the Field Name parameter of this tool .
void	setInputFeatures(Object inputFeatures) Sets the Input Features parameter of this tool .
void	setOutputFeatureClass(Object outputFeatureClass) Sets the Output Feature class parameter of this tool .
void	setOutsidePolygonsOnly(String outsidePolygonsOnly) Sets the Outside Polygons Only 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

MultipleRingBuffer

public MultipleRingBuffer()

Creates the Multiple Ring Buffer tool with defaults.

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

MultipleRingBuffer

public MultipleRingBuffer(Object inputFeatures,
                          Object outputFeatureClass,
                          Object distances)

Creates the Multiple Ring 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:

inputFeatures - the input point, line, or polygon features to be buffered.

outputFeatureClass - the output feature class containing feature buffers.

distances - the list of buffer distances.

Method Detail

getInputFeatures

public Object getInputFeatures()

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

setInputFeatures

public void setInputFeatures(Object inputFeatures)

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:

inputFeatures - the input point, line, or polygon features to be buffered.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature class parameter of this tool . This parameter is the output feature class containing feature buffers. This is a required parameter.

Returns:

the Output Feature class

setOutputFeatureClass

public void setOutputFeatureClass(Object outputFeatureClass)

Sets the Output Feature class parameter of this tool . This parameter is the output feature class containing feature buffers. This is a required parameter.

Parameters:

outputFeatureClass - the output feature class containing feature buffers.

getDistances

public Object getDistances()

Returns the Distances parameter of this tool . This parameter is the list of buffer distances. This is a required parameter.

Returns:

the Distances

setDistances

public void setDistances(Object distances)

Sets the Distances parameter of this tool . This parameter is the list of buffer distances. This is a required parameter.

Parameters:

distances - the list of buffer distances.

getBufferUnit

public String getBufferUnit()

Returns the Buffer Unit parameter of this tool . This parameter is the linear unit to be used with the Distance values. If the units are not specified, or entered as 'Default', the linear unit of the input features' spatial reference is used. If the Buffer Unit is specified as 'Default' and the Output Coordinate System geoprocessing environment has been set, its linear unit will be used. This is an optional parameter.

Returns:

the Buffer Unit

setBufferUnit

public void setBufferUnit(String bufferUnit)

Sets the Buffer Unit parameter of this tool . This parameter is the linear unit to be used with the Distance values. If the units are not specified, or entered as 'Default', the linear unit of the input features' spatial reference is used. If the Buffer Unit is specified as 'Default' and the Output Coordinate System geoprocessing environment has been set, its linear unit will be used. This is an optional parameter.

Parameters:

bufferUnit - the linear unit to be used with the Distance values. If the units are not specified, or entered as 'Default', the linear unit of the input features' spatial reference is used. If the Buffer Unit is specified as 'Default' and the Output Coordinate System geoprocessing environment has been set, its linear unit will be used.

getFieldName

public String getFieldName()

Returns the Field Name parameter of this tool . This parameter is the name of the field in the output feature class that stores the buffer distance used to create each buffer feature. If no name is specified, the default field name is 'distance'. This field will be of type Double. This is an optional parameter.

Returns:

the Field Name

setFieldName

public void setFieldName(String fieldName)

Sets the Field Name parameter of this tool . This parameter is the name of the field in the output feature class that stores the buffer distance used to create each buffer feature. If no name is specified, the default field name is 'distance'. This field will be of type Double. This is an optional parameter.

Parameters:

fieldName - the name of the field in the output feature class that stores the buffer distance used to create each buffer feature. If no name is specified, the default field name is 'distance'. This field will be of type Double.

getDissolveOption

public String getDissolveOption()

Returns the Dissolve Option parameter of this tool . This parameter is determines if the output buffers will be rings or disks around the input features. This is an optional parameter.

Returns:

the Dissolve Option

setDissolveOption

public void setDissolveOption(String dissolveOption)

Sets the Dissolve Option parameter of this tool . This parameter is determines if the output buffers will be rings or disks around the input features. This is an optional parameter.

Parameters:

dissolveOption - determines if the output buffers will be rings or disks around the input features.

getOutsidePolygonsOnly

public String getOutsidePolygonsOnly()

Returns the Outside Polygons Only parameter of this tool . This parameter is valid only for polygon input features. This is an optional parameter.

Returns:

the Outside Polygons Only

setOutsidePolygonsOnly

public void setOutsidePolygonsOnly(String outsidePolygonsOnly)

Sets the Outside Polygons Only parameter of this tool . This parameter is valid only for polygon input features. This is an optional parameter.

Parameters:

outsidePolygonsOnly - valid only for polygon input features.

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