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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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