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

Splitting the Input Features creates a subset of multiple output feature classes. The Split tool is contained in the Analysis Tools tool box.

Usage tips:

• The Split Features dataset must be polygons.
• The Split Field data type must be character. Its unique values form the names of output feature classes.
• The split field's unique values must start with a valid character. If the target workspace is a file, personal, or ArcSDE geodatabase, the field's values must begin with a letter. Field values that begin with a number as in "350 degrees" cause an error. Exception: Shapefile names can begin with a number, and a folder target workspace allows field values that begin with a number.
• The target workspace must already exist.
• The total number of output feature classes equals the number of unique Split Field values and the extent of overlay of the Input Features with the Split Features.
• The feature attribute table of each output feature class contains the same fields as the Input Features attribute table.
• 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.
• Attribute values from the input feature class(es) will be copied to the output feature class. However, if the input is a layer(s) created by the tool and a field's "Use Ratio Policy" is checked, then a ratio of the input attribute value is calculated for the output attribute value. When "Use Ratio Policy" is enabled, whenever a feature in an overlay operation is split, the attributes of the resulting features are a ratio of the attribute value of the input feature. The output value is based on the ratio in which the input feature geometry was divided. For example, If the input geometry was divided equally, each new feature's attribute value is assigned one-half of the value of the input feature's attribute value. "Use Ratio Policy" only applies to numeric field types.Geoprocessing tools do not honor geodatabase feature class or table field split policies.
• 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

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

splitFeatures - the features containing a tabular field whose unique values are used to split the Input Features and provide the output feature classes' names.

splitField - the character field used to split the Input Features. This field's values identify the Split Features used to create each output feature class. The Split Field's unique values provide the output feature classes' names.

outWorkspace - the workspace where the output feature classes are stored.

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

inFeatures - the features to be split.

getSplitFeatures

public Object getSplitFeatures()

Returns the Split Features parameter of this tool . This parameter is the features containing a tabular field whose unique values are used to split the Input Features and provide the output feature classes' 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 the features containing a tabular field whose unique values are used to split the Input Features and provide the output feature classes' names. This is a required parameter.

Parameters:

splitFeatures - the features containing a tabular field whose unique values are used to split the Input Features and provide the output feature classes' names.

getSplitField

public Object getSplitField()

Returns the Split Field parameter of this tool . This parameter is the character field used to split the Input Features. This field's values identify the Split Features used to create each output feature class. The Split Field's unique values provide 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 the character field used to split the Input Features. This field's values identify the Split Features used to create each output feature class. The Split Field's unique values provide the output feature classes' names. This is a required parameter.

Parameters:

splitField - the character field used to split the Input Features. This field's values identify the Split Features used to create each output feature class. The Split Field's unique values provide the output feature classes' names.

getOutWorkspace

public Object getOutWorkspace()

Returns the Target Workspace parameter of this tool . This parameter is the workspace where the output feature classes are stored. 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 the workspace where the output feature classes are stored. This is a required parameter.

Parameters:

outWorkspace - the workspace where the output feature classes are stored.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). 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 the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). 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 - the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). 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