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

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

All Implemented Interfaces:

GPTool

public class Split
extends AbstractGPTool

Breaks the Input Features into multiple output feature classes. The boundary of each unique value in the Split Field is used to split the Input Features. The name of the output The Split tool is contained in the Analysis Tools tool box.
Learn more about how Split works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• The Split Field data type must be character. The output feature classes will be named for Split Field values; therefore, they must start with a valid character.
• The Split Features datase must contain polygons.
• The number of output feature classes is dictated by the Split Field of the Split Features. The number of output feature classes equals the total number of unique values in the Split Field.
• The target workspace must already exist.
• The feature attribute table for output feature classes contains the same items as the Input Features attribute table.
• The Split command will not produce an empty output feature class for Split Features' areas in which no Input Features' features are located.
• Annotation; features are split and saved in the output features based on the Split Features polygon in which the lower left starting point of the annotation string falls.
• In the ModelBuilder interactive window, Split will display what appears to be an additional input parameter "output workspace (2)". This is actual the Target Workspace parameter and it is being displayed because it's a required input parameter. Although it will contain the output features that result from the Split, the name of the pre-existing workspace must be stated as a required input parameter. The output workspace parameter that appeared when the Split tool was first introduced into the interactive window remains and is treated as an output parameter thereby allowing the Split tool to be a chained process.
• When processing datasets that contain any individual feature with a very large number of vertices (e.g., hundreds of thousands to millions of vertices within a single feature), some geometric processing operations may run out of memory. For more details, see Geoprocessing with large datasets;
• Learn more about the xy tolerance environment;
• Learn more about xy tolerance;
• 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

Split()
Creates the Split tool with defaults.

Split(Object inFeatures, Object splitFeatures, Object splitField, Object outWorkspace)
Creates the Split tool with the required parameters.

Method Summary

Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutWorkspace() Returns the Target Workspace parameter of this tool .
Object	getOutWorkspace2() Returns the Output Workspace parameter of this tool (Read only).
Object	getSplitFeatures() Returns the Split Features parameter of this tool .
Object	getSplitField() Returns the Split Field 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	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutWorkspace(Object outWorkspace) Sets the Target Workspace parameter of this tool .
void	setSplitFeatures(Object splitFeatures) Sets the Split Features parameter of this tool .
void	setSplitField(Object splitField) Sets the Split Field 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

Split

public Split()

Creates the Split tool with defaults.

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

Split

public Split(Object inFeatures,
             Object splitFeatures,
             Object splitField,
             Object outWorkspace)

Creates the Split 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 features to be split.

splitFeatures - Feature Layer, the features containing a tabular field whose unique values will be used to split the Input Features and provide the output feature class names.

splitField - Field, the field in the split feature class that will be used to split the Input Features. This field's values will be used to identify Split Features for clipping each output feature class. The Split Field's unique values will be used as the output feature classes' names.

outWorkspace - Workspace | Feature Dataset, the workspace where the output feature classes will be saved.

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

inFeatures - Feature Layer, the features to be split.

getSplitFeatures

public Object getSplitFeatures()

Returns the Split Features parameter of this tool . This parameter is Feature Layer, the features containing a tabular field whose unique values will be used to split the Input Features and provide the output feature class names. This is a required parameter.

Returns:

the Split Features

setSplitFeatures

public void setSplitFeatures(Object splitFeatures)

Sets the Split Features parameter of this tool . This parameter is Feature Layer, the features containing a tabular field whose unique values will be used to split the Input Features and provide the output feature class names. This is a required parameter.

Parameters:

splitFeatures - Feature Layer, the features containing a tabular field whose unique values will be used to split the Input Features and provide the output feature class names.

getSplitField

public Object getSplitField()

Returns the Split Field parameter of this tool . This parameter is Field, the field in the split feature class that will be used to split the Input Features. This field's values will be used to identify Split Features for clipping each output feature class. The Split Field's unique values will be used as the output feature classes' names. This is a required parameter.

Returns:

the Split Field

setSplitField

public void setSplitField(Object splitField)

Sets the Split Field parameter of this tool . This parameter is Field, the field in the split feature class that will be used to split the Input Features. This field's values will be used to identify Split Features for clipping each output feature class. The Split Field's unique values will be used as the output feature classes' names. This is a required parameter.

Parameters:

splitField - Field, the field in the split feature class that will be used to split the Input Features. This field's values will be used to identify Split Features for clipping each output feature class. The Split Field's unique values will be used as the output feature classes' names.

getOutWorkspace

public Object getOutWorkspace()

Returns the Target Workspace parameter of this tool . This parameter is Workspace | Feature Dataset, the workspace where the output feature classes will be saved. This is a required parameter.

Returns:

the Target Workspace

setOutWorkspace

public void setOutWorkspace(Object outWorkspace)

Sets the Target Workspace parameter of this tool . This parameter is Workspace | Feature Dataset, the workspace where the output feature classes will be saved. This is a required parameter.

Parameters:

outWorkspace - Workspace | Feature Dataset, the workspace where the output feature classes will be saved.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is Linear unit, you can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. This is an optional parameter.

Returns:

the XY Tolerance

setClusterTolerance

public void setClusterTolerance(Object clusterTolerance)

Sets the XY Tolerance parameter of this tool . This parameter is Linear unit, you can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. This is an optional parameter.

Parameters:

clusterTolerance - Linear unit, you can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy.

getOutWorkspace2

public Object getOutWorkspace2()

Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Workspace

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