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

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

public class Union
extends AbstractGPTool

Computes the geometric intersection of two polygon coverages. All polygons from both coverages will be split at their intersections and preserved in the output coverage. The Union 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
Union()
          Creates the Union tool with defaults.
Union(Object inCover, Object unionCover, Object outCover)
          Creates the Union tool with the required parameters.
 
Method Summary
 double getFuzzyTolerance()
          Returns the Fuzzy Tolerance parameter of this tool .
 Object getInCover()
          Returns the Input 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.
 Object getUnionCover()
          Returns the Union Coverage 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 setJoinAttributes(String joinAttributes)
          Sets the Join attributes parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setUnionCover(Object unionCover)
          Sets the Union 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

Union

public Union()
Creates the Union tool with defaults.

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


Union

public Union(Object inCover,
             Object unionCover,
             Object outCover)
Creates the Union 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 whose polygons will be combined with the union coverage.
unionCover - the union coverage whose polygons will be combined with the input coverage.
outCover - the output coverage that will be created containing the results of the operation.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage whose polygons will be combined with the union 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 the coverage whose polygons will be combined with the union coverage. This is a required parameter.

Parameters:
inCover - the coverage whose polygons will be combined with the union coverage.

getUnionCover

public Object getUnionCover()
Returns the Union Coverage parameter of this tool . This parameter is the union coverage whose polygons will be combined with the input coverage. This is a required parameter.

Returns:
the Union Coverage

setUnionCover

public void setUnionCover(Object unionCover)
Sets the Union Coverage parameter of this tool . This parameter is the union coverage whose polygons will be combined with the input coverage. This is a required parameter.

Parameters:
unionCover - the union coverage whose polygons will be combined with the input coverage.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the output coverage that will be created containing the results of the operation. 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 the output coverage that will be created containing the results of the operation. This is a required parameter.

Parameters:
outCover - the output coverage that will be created containing the results of the operation.

getFuzzyTolerance

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

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

getJoinAttributes

public String getJoinAttributes()
Returns the Join attributes parameter of this tool . This parameter is specifies whether all items in both the input and the union 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 specifies whether all items in both the input and the union coverage will be joined to the output coverage feature attribute table. This is an optional parameter.

Parameters:
joinAttributes - specifies whether all items in both the input and the union 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