com.esri.arcgis.geoprocessing.tools.cartographytools
Class DetectGraphicConflict

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

public class DetectGraphicConflict
extends AbstractGPTool

Creates polygons where two or more symbolized features graphically conflict. The Detect Graphic Conflict tool is contained in the Cartography Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DetectGraphicConflict()
          Creates the Detect Graphic Conflict tool with defaults.
DetectGraphicConflict(Object inFeatures, Object conflictFeatures, Object outFeatureClass)
          Creates the Detect Graphic Conflict tool with the required parameters.
 
Method Summary
 Object getConflictDistance()
          Returns the Conflict Distance parameter of this tool .
 Object getConflictFeatures()
          Returns the Conflict Layer parameter of this tool .
 Object getInFeatures()
          Returns the Input Layer parameter of this tool .
 Object getLineConnectionAllowance()
          Returns the Line Connection Allowance parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class 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 setConflictDistance(Object conflictDistance)
          Sets the Conflict Distance parameter of this tool .
 void setConflictFeatures(Object conflictFeatures)
          Sets the Conflict Layer parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Layer parameter of this tool .
 void setLineConnectionAllowance(Object lineConnectionAllowance)
          Sets the Line Connection Allowance parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class 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

DetectGraphicConflict

public DetectGraphicConflict()
Creates the Detect Graphic Conflict tool with defaults.

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


DetectGraphicConflict

public DetectGraphicConflict(Object inFeatures,
                             Object conflictFeatures,
                             Object outFeatureClass)
Creates the Detect Graphic Conflict 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 input feature layer containing symbolized features.
conflictFeatures - the feature layer containing symbolized features potentially in conflict with symbolized features in the input layer.
outFeatureClass - the output feature class to be created to store conflict polygons. It cannot be one of the feature classes associated with the input layers.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Layer parameter of this tool . This parameter is the input feature layer containing symbolized features. This is a required parameter.

Returns:
the Input Layer

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Layer parameter of this tool . This parameter is the input feature layer containing symbolized features. This is a required parameter.

Parameters:
inFeatures - the input feature layer containing symbolized features.

getConflictFeatures

public Object getConflictFeatures()
Returns the Conflict Layer parameter of this tool . This parameter is the feature layer containing symbolized features potentially in conflict with symbolized features in the input layer. This is a required parameter.

Returns:
the Conflict Layer

setConflictFeatures

public void setConflictFeatures(Object conflictFeatures)
Sets the Conflict Layer parameter of this tool . This parameter is the feature layer containing symbolized features potentially in conflict with symbolized features in the input layer. This is a required parameter.

Parameters:
conflictFeatures - the feature layer containing symbolized features potentially in conflict with symbolized features in the input layer.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the output feature class to be created to store conflict polygons. It cannot be one of the feature classes associated with the input layers. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is the output feature class to be created to store conflict polygons. It cannot be one of the feature classes associated with the input layers. This is a required parameter.

Parameters:
outFeatureClass - the output feature class to be created to store conflict polygons. It cannot be one of the feature classes associated with the input layers.

getConflictDistance

public Object getConflictDistance()
Returns the Conflict Distance parameter of this tool . This parameter is sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around symbols in both the input and conflict layers. Conflict polygons will be generated where these buffers overlap. Conflict distance is measured in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The default conflict distance is 0, where no buffers are created and only symbols that physically overlap one another are detected as conflicts. This is an optional parameter.

Returns:
the Conflict Distance

setConflictDistance

public void setConflictDistance(Object conflictDistance)
Sets the Conflict Distance parameter of this tool . This parameter is sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around symbols in both the input and conflict layers. Conflict polygons will be generated where these buffers overlap. Conflict distance is measured in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The default conflict distance is 0, where no buffers are created and only symbols that physically overlap one another are detected as conflicts. This is an optional parameter.

Parameters:
conflictDistance - sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around symbols in both the input and conflict layers. Conflict polygons will be generated where these buffers overlap. Conflict distance is measured in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The default conflict distance is 0, where no buffers are created and only symbols that physically overlap one another are detected as conflicts.

getLineConnectionAllowance

public Object getLineConnectionAllowance()
Returns the Line Connection Allowance parameter of this tool . This parameter is the radius of a circle, centered where lines join, within which graphic overlaps won't be detected. This parameter is only considered when the input layer and the conflict layer are identical. Zero allowance will detect a conflict at each line join (if end caps are overlapping). Line connection allowance is calculated in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The value cannot be negative; the default value is 1 Point. This is an optional parameter.

Returns:
the Line Connection Allowance

setLineConnectionAllowance

public void setLineConnectionAllowance(Object lineConnectionAllowance)
Sets the Line Connection Allowance parameter of this tool . This parameter is the radius of a circle, centered where lines join, within which graphic overlaps won't be detected. This parameter is only considered when the input layer and the conflict layer are identical. Zero allowance will detect a conflict at each line join (if end caps are overlapping). Line connection allowance is calculated in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The value cannot be negative; the default value is 1 Point. This is an optional parameter.

Parameters:
lineConnectionAllowance - the radius of a circle, centered where lines join, within which graphic overlaps won't be detected. This parameter is only considered when the input layer and the conflict layer are identical. Zero allowance will detect a conflict at each line join (if end caps are overlapping). Line connection allowance is calculated in page units (Points, Inches, Millimeters, Centimeters). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. The value cannot be negative; the default value is 1 Point.

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