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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.coveragetools.Intersect
All Implemented Interfaces:
GPTool

public class Intersect
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Computes the geometric intersection of two coverages. Only those features in the area common to both coverages will be preserved in the output coverage. The Intersect tool is contained in the Coverage Tools tool box.
Learn more about how Intersect works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Intersect()
          Creates the Intersect tool with defaults.
Intersect(Object inCover, Object intersectCover, Object outCover)
          Creates the Intersect 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 getIntersectCover()
          Returns the Intersect Coverage parameter of this tool .
 String getJoinAttributes()
          Returns the Join attributes parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setIntersectCover(Object intersectCover)
          Sets the Intersect Coverage parameter of this tool .
 void setJoinAttributes(String joinAttributes)
          Sets the Join attributes parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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

Intersect

public Intersect()
Creates the Intersect tool with defaults.

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


Intersect

public Intersect(Object inCover,
                 Object intersectCover,
                 Object outCover)
Creates the Intersect 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 - Coverage, the coverage whose polygon, line, or point features will be intersected with the intersect coverage.
intersectCover - Coverage, the intersect coverage. This coverage must contain polygon features.
outCover - Coverage, the coverage that will be created to contain the results.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage whose polygon, line, or point features will be intersected with the intersect coverage. 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 Coverage, the coverage whose polygon, line, or point features will be intersected with the intersect coverage. This is a required parameter.

Parameters:
inCover - Coverage, the coverage whose polygon, line, or point features will be intersected with the intersect coverage.

getIntersectCover

public Object getIntersectCover()
Returns the Intersect Coverage parameter of this tool . This parameter is Coverage, the intersect coverage. This coverage must contain polygon features. This is a required parameter.

Returns:
the Intersect Coverage

setIntersectCover

public void setIntersectCover(Object intersectCover)
Sets the Intersect Coverage parameter of this tool . This parameter is Coverage, the intersect coverage. This coverage must contain polygon features. This is a required parameter.

Parameters:
intersectCover - Coverage, the intersect coverage. This coverage must contain polygon features.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the coverage that will be created to contain the results. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the coverage that will be created to contain the results. This is a required parameter.

Parameters:
outCover - Coverage, the coverage that will be created to contain the results.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is String, the input coverage feature class to be overlaid and preserved in the output coverage. 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 String, the input coverage feature class to be overlaid and preserved in the output coverage. This is an optional parameter.

Parameters:
featureType - String, the input coverage feature class to be overlaid and preserved in the output coverage.

getFuzzyTolerance

public double getFuzzyTolerance()
Returns the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages 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 Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used. This is an optional parameter.

Parameters:
fuzzyTolerance - Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used.

getJoinAttributes

public String getJoinAttributes()
Returns the Join attributes parameter of this tool . This parameter is String, specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table. This is an optional parameter.

Returns:
the Join attributes

setJoinAttributes

public void setJoinAttributes(String joinAttributes)
Sets the Join attributes parameter of this tool . This parameter is String, specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table. This is an optional parameter.

Parameters:
joinAttributes - String, specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table.

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