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

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

All Implemented Interfaces:

GPTool

public class Split
extends AbstractGPTool

Clips portions of the input coverage into multiple coverages. The Split tool is contained in the Coverage Tools tool box.

Usage tips:

• Values in the Split Item must be unique.
• The Split Item data type must be character.
• The output coverages will be named for Split Item values; therefore, they must start with a valid character.
• Split Item values must be 13 characters or less.
• The split coverage must have polygon topology.
• Topology is maintained in the output coverages.
• The number of output coverages is dictated by the Split Item of the split coverage. The maximum number of output coverages equals the total number of unique values in the Split Item.
• The Output Workspace in which each output coverage is created must contain an INFO directory before running Split. Split will stop if it cannot find the INFO directory.
• Annotation is copied when its lower left starting point falls within a new output coverage.
• Polygon topology is rebuilt for each output coverage. Each polygon User-ID is set equal to the old input coverage polygon User-ID. New label point positions are only generated when the original input coverage label point position is clipped by the split coverage.
• Empty output coverages can be created by Split for split coverage areas in which no input coverage features are located.
• If the input coverage contains a node feature class with attributes, then each of the output coverages will contain nodes that fall within the appropriate split coverage. New NAT records will be created as required by the Split operation.
• Attributes for new nodes are set to zero.
• Region subclasses in the input coverage are maintained.
• Empty region subclasses are created if the regions that make up the subclass are not in the output coverage.
• Region subclasses are maintained as empty subclasses when all the regions are removed.
• Route systems will be maintained. Route systems will be duplicated for arcs split into multiple pieces. Each resultant coverage will have a complete set of route system subclasses containing only those route systems attached to arcs within that coverage (empty route system files will be created if necessary).
• Route systems are copied when their arcs are split into multiple pieces and dropped for arcs that are removed.
• Routes and sections on the arcs will be carried over and maintained. Route systems will be split at their intersections. Split maintains all route system subclasses.
• Split treats route systems as if it were performing repeated . Each output coverage from Split contains the route systems within that particular split polygon and the parts of those that pass though that polygon. Routes retain their User-IDs across split coverages so that can reassemble them. Split sections will have new section measures interpolated at their split ends.
• Four new tic locations are generated for each output coverage at the corners of the split coverage BND. No existing tics are retained.
• The feature attribute table for each output coverage contains the same items as the input coverage feature attribute table.
• Split will distribute all annotation subclasses present in the input coverage to all of the output coverages based on the split coverage polygon in which the lower left starting point falls for each annotation string. If a particular subclass has no actual annotation within a particular output coverage, it is still created.
• The input coverages projection file (PRJ) will be copied to each output coverage.
• The coordinate precision of each output coverage is determined by the current processing rule as set by the environment setting. If the processing rule has not been established during the current session, then the output coverages will be in the same precision as the input coverage.
• When the input coverage contains linear data belonging to different planar graphs, the data will be maintained in the output coverage. For example, with coincident or colinear arcs such as arcs representing utility cables at different levels or a road following a stream, the coincident and colinear line segments will be preserved. However, additional vertices may be inserted. In the case of intersecting arcs such as a road passing over a stream, nodes will not be inserted at the apparent intersection.

Field Summary

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

vals

Constructor Summary

Split()
Creates the Split tool with defaults.

Split(Object inCover, Object splitCover, Object splitItem)
Creates the Split tool with the required parameters.

Method Summary

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	getPath() Returns the Output Workspace parameter of this tool .
Object	getSplitCover() Returns the Split Coverage parameter of this tool .
Object	getSplitItem() Returns the Split Item 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	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	setPath(Object path) Sets the Output Workspace parameter of this tool .
void	setSplitCover(Object splitCover) Sets the Split Coverage parameter of this tool .
void	setSplitItem(Object splitItem) Sets the Split Item 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 inCover,
             Object splitCover,
             Object splitItem)

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:

inCover - the coverage to be split.

splitCover - the coverage used to split the input coverage.

splitItem - the item in the split coverage that will be used to split the input coverage. The unique values in the Split Item are used to name the output coverages. The number of output coverages is determined by the number of unique values in the Split Item.

Method Detail

getInCover

public Object getInCover()

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

Parameters:

inCover - the coverage to be split.

getSplitCover

public Object getSplitCover()

Returns the Split Coverage parameter of this tool . This parameter is the coverage used to split the input coverage. This is a required parameter.

Returns:

the Split Coverage

setSplitCover

public void setSplitCover(Object splitCover)

Sets the Split Coverage parameter of this tool . This parameter is the coverage used to split the input coverage. This is a required parameter.

Parameters:

splitCover - the coverage used to split the input coverage.

getSplitItem

public Object getSplitItem()

Returns the Split Item parameter of this tool . This parameter is the item in the split coverage that will be used to split the input coverage. The unique values in the Split Item are used to name the output coverages. The number of output coverages is determined by the number of unique values in the Split Item. This is a required parameter.

Returns:

the Split Item

setSplitItem

public void setSplitItem(Object splitItem)

Sets the Split Item parameter of this tool . This parameter is the item in the split coverage that will be used to split the input coverage. The unique values in the Split Item are used to name the output coverages. The number of output coverages is determined by the number of unique values in the Split Item. This is a required parameter.

Parameters:

splitItem - the item in the split coverage that will be used to split the input coverage. The unique values in the Split Item are used to name the output coverages. The number of output coverages is determined by the number of unique values in the Split Item.

getPath

public Object getPath()

Returns the Output Workspace parameter of this tool . This parameter is the workspace in which the output coverage will be maintained. This is an optional parameter.

Returns:

the Output Workspace

setPath

public void setPath(Object path)

Sets the Output Workspace parameter of this tool . This parameter is the workspace in which the output coverage will be maintained. This is an optional parameter.

Parameters:

path - the workspace in which the output coverage will be maintained.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the feature classes to be split: 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 the feature classes to be split: This is an optional parameter.

Parameters:

featureType - the feature classes to be split:

getFuzzyTolerance

public double getFuzzyTolerance()

Returns the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in each output coverage. By default, the minimum fuzzy tolerance value from the input coverage and split 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 the minimum distance between coordinates in each output coverage. By default, the minimum fuzzy tolerance value from the input coverage and split coverage is used. This is an optional parameter.

Parameters:

fuzzyTolerance - the minimum distance between coordinates in each output coverage. By default, the minimum fuzzy tolerance value from the input coverage and split coverage is used.

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