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

Detects graphic conflicts between feature representations and stores the overlaps as polygons in the output feature class. The Detect Graphic Conflict tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Illustration:

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 Features With Representations parameter of this tool .
 Object getInFeatures()
          Returns the Input Features With Representations 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 Features With Representations parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features With Representations 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 - Layer, the input feature layer containing representations.
conflictFeatures - Layer, the feature layer containing representations potentially in conflict with the representations in the input feature layer.
outFeatureClass - Feature Class, the output feature class to be created to store conflict polygons. It cannot be one of the feature classes associated with the input feature layers.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features With Representations parameter of this tool . This parameter is Layer, the input feature layer containing representations. This is a required parameter.

Returns:
the Input Features With Representations

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Features With Representations parameter of this tool . This parameter is Layer, the input feature layer containing representations. This is a required parameter.

Parameters:
inFeatures - Layer, the input feature layer containing representations.

getConflictFeatures

public Object getConflictFeatures()
Returns the Conflict Features With Representations parameter of this tool . This parameter is Layer, the feature layer containing representations potentially in conflict with the representations in the input feature layer. This is a required parameter.

Returns:
the Conflict Features With Representations

setConflictFeatures

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

Parameters:
conflictFeatures - Layer, the feature layer containing representations potentially in conflict with the representations in the input feature layer.

getOutFeatureClass

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

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

getConflictDistance

public Object getConflictDistance()
Returns the Conflict Distance parameter of this tool . This parameter is Linear unit, sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around feature representation graphics in both the input and conflict layers. Conflict polygons will be generated where buffers overlap. Conflict distance is calculated in page units (Points, Milimeters, and so on). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. When the conflict distance is zero, no buffers are made, and just the representation footprints are used to detect conflicts; this is the default. 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 Linear unit, sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around feature representation graphics in both the input and conflict layers. Conflict polygons will be generated where buffers overlap. Conflict distance is calculated in page units (Points, Milimeters, and so on). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. When the conflict distance is zero, no buffers are made, and just the representation footprints are used to detect conflicts; this is the default. This is an optional parameter.

Parameters:
conflictDistance - Linear unit, sets the conflict distance. Temporary buffers one-half the size of the conflict distance value are created around feature representation graphics in both the input and conflict layers. Conflict polygons will be generated where buffers overlap. Conflict distance is calculated in page units (Points, Milimeters, and so on). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. When the conflict distance is zero, no buffers are made, and just the representation footprints are used to detect conflicts; this is the default.

getLineConnectionAllowance

public Object getLineConnectionAllowance()
Returns the Line Connection Allowance parameter of this tool . This parameter is Linear unit, the line connection allowance 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, and contain line representations. Otherwise, this value is ignored when the tool is executed. The default value is 1 point. A value of zero means no allowance, and will detect a conflict at each line join in this case. The value can not be negative. Line connection allowance is calculated in page units (points, mm, in, or cm). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. 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 Linear unit, the line connection allowance 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, and contain line representations. Otherwise, this value is ignored when the tool is executed. The default value is 1 point. A value of zero means no allowance, and will detect a conflict at each line join in this case. The value can not be negative. Line connection allowance is calculated in page units (points, mm, in, or cm). If you enter a conflict distance in map units, it will be converted to page units using the reference scale. This is an optional parameter.

Parameters:
lineConnectionAllowance - Linear unit, the line connection allowance 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, and contain line representations. Otherwise, this value is ignored when the tool is executed. The default value is 1 point. A value of zero means no allowance, and will detect a conflict at each line join in this case. The value can not be negative. Line connection allowance is calculated in page units (points, mm, in, or cm). If you enter a conflict distance in map units, it will be converted to page units using the reference scale.

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