com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class Dissolve

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.Dissolve

All Implemented Interfaces:

GPTool

public class Dissolve
extends AbstractGPTool

Aggregates features based on specified attributes. The Dissolve tool is contained in the Data Management Tools tool box.

Usage tips:

• The attributes of the features which become aggregated by dissolve can be summarized or described using a variety of statistics. The statistic used to summarize attributes is added to the output feature class as a single field with the following naming standard of statistic type + underscore + input field name. For example, if the SUM statistic is used on a field named 'POP', the output will have a field named 'SUM_POP'.
• Dissolve can create very large features in the output feature class. This is especially true when there is a small number of unique values in the Dissolve Field(s) or when dissolving all features into a single feature. Very large features may cause display problems and/or have poor performance when drawn on a map or when edited. To avoid these potential problems, use the Create multipart features parameter's MULTI_PART option to split potentially larger multipart features into many smaller features.
• Null values are excluded from all statistical calculations. For example, the AVERAGE of 10, 5, and NULL is 7.5 ((10+5)/2). The COUNT tool returns the number of values included in the statistical calculation, which in this case is 2.
• The availability of physical memory may limit the amount (and complexity) of input features that can be processed and dissolved into a single output feature. This limitation could cause an error to occur, as the dissolve process may require more memory than is available. To prevent this, input features may be cut and processed using an adaptive tiling algorithm. To determine the features that have been tiled, run the FREQUENCY tool on the result of this tool, specifying the same field(s) used in the dissolve process for the Frequency Field(s) parameter. Any record with a frequency value of 2 has been tiled. Tile boundaries are preserved in the output features to prevent the creation of features that are too large to be used by ArcGIS. These can be evaluated and removed using either a second dissolve operation or using the merge edit task in ArcMap (1. start editing; 2. select the two features; 3. click Editor\Merge...)
• The Dissolve Field(s) parameter's Add Field button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Dissolve Field(s) parameter may not be populated with field names. The Add Field button allows you to add expected fields so you can complete the tool's dialog and continue to build your model.
• The Unsplit lines parameter with two options, DISSOLVE_LINES and UNSPLIT_LINES, only applies to line input. When the default DISSOLVE_LINES option is specified, lines are dissolved into a single feature. When UNSPLIT_LINES is specified, only two lines that have a common endpoint (known as pseudonode) are merged into one continuous line.
• This tool will use a tiling process to handle very large datasets for better performance and scalability. For more details, see .

Field Summary

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

vals

Constructor Summary

Dissolve()
Creates the Dissolve tool with defaults.

Dissolve(Object inFeatures, Object outFeatureClass)
Creates the Dissolve tool with the required parameters.

Method Summary

Object	getDissolveField() Returns the Dissolve_Field(s) parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
String	getMultiPart() Returns the Create multipart features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getStatisticsFields() Returns the Statistics Field(s) 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.
String	getUnsplitLines() Returns the Unsplit lines parameter of this tool .
void	setDissolveField(Object dissolveField) Sets the Dissolve_Field(s) parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setMultiPart(String multiPart) Sets the Create multipart features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setStatisticsFields(Object statisticsFields) Sets the Statistics Field(s) parameter of this tool .
void	setUnsplitLines(String unsplitLines) Sets the Unsplit lines 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

Dissolve

public Dissolve()

Creates the Dissolve tool with defaults.

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

Dissolve

public Dissolve(Object inFeatures,
                Object outFeatureClass)

Creates the Dissolve 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 features to be aggregated.

outFeatureClass - the feature class to be created that will contain the aggregated features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the features to be aggregated. 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 features to be aggregated. This is a required parameter.

Parameters:

inFeatures - the features to be aggregated.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class to be created that will contain the aggregated features. 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 to be created that will contain the aggregated features. This is a required parameter.

Parameters:

outFeatureClass - the feature class to be created that will contain the aggregated features.

getDissolveField

public Object getDissolveField()

Returns the Dissolve_Field(s) parameter of this tool . This parameter is the field or fields on which to aggregate features. the Add Field button, which is used only in ModelBuilder, allows you to add expected fields 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 the field or fields on which to aggregate features. the Add Field button, which is used only in ModelBuilder, allows you to add expected fields so you can complete the dialog and continue to build your model. This is an optional parameter.

Parameters:

dissolveField - the field or fields on which to aggregate features. the Add Field button, which is used only in ModelBuilder, allows you to add expected fields so you can complete the dialog and continue to build your model.

getStatisticsFields

public Object getStatisticsFields()

Returns the Statistics Field(s) parameter of this tool . This parameter is the fields and statistics with which to summarize attributes. Text attribute fields may be summarized using the statistics FIRST or LAST. Numeric attribute fields may be summarized using any statistic. Nulls are excluded from all statistical calculations. This is an optional parameter.

Returns:

the Statistics Field(s)

setStatisticsFields

public void setStatisticsFields(Object statisticsFields)

Sets the Statistics Field(s) parameter of this tool . This parameter is the fields and statistics with which to summarize attributes. Text attribute fields may be summarized using the statistics FIRST or LAST. Numeric attribute fields may be summarized using any statistic. Nulls are excluded from all statistical calculations. This is an optional parameter.

Parameters:

statisticsFields - the fields and statistics with which to summarize attributes. Text attribute fields may be summarized using the statistics FIRST or LAST. Numeric attribute fields may be summarized using any statistic. Nulls are excluded from all statistical calculations.

getMultiPart

public String getMultiPart()

Returns the Create multipart features parameter of this tool . This parameter is specifies whether multipart features are allowed in the output feature class. This is an optional parameter.

Returns:

the Create multipart features

setMultiPart

public void setMultiPart(String multiPart)

Sets the Create multipart features parameter of this tool . This parameter is specifies whether multipart features are allowed in the output feature class. This is an optional parameter.

Parameters:

multiPart - specifies whether multipart features are allowed in the output feature class.

getUnsplitLines

public String getUnsplitLines()

Returns the Unsplit lines parameter of this tool . This parameter is controls how line features are dissolved. This is an optional parameter.

Returns:

the Unsplit lines

setUnsplitLines

public void setUnsplitLines(String unsplitLines)

Sets the Unsplit lines parameter of this tool . This parameter is controls how line features are dissolved. This is an optional parameter.

Parameters:

unsplitLines - controls how line 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