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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.ResolveRoadConflicts

All Implemented Interfaces:

GPTool

public class ResolveRoadConflicts
extends AbstractGPTool

Resolves graphic conflicts among symbolized road features by adjusting portions of line segments. The Resolve Road Conflicts tool is contained in the Cartography Tools tool box.

Usage tips:

• This tool is typically used when producing relatively large-scale products where it is preferable to display divided roads with multiple lanes that are visually distinct. At smaller scales, you may want to use the tool to display a single representative line for these features instead. If your workflow includes running both tools on the same collection of roads, it is advisable to merge roads prior to resolving road conflicts.
• The Hierarchy Field parameter is used to specify the hierarchical importance of each road class. Lower integers specify more significant roads, with hierarchy equal to 1 for the most important roads. Movement will be minimized for the most important roads; lower hierarchy roads generally will be moved to accommodate higher hierarchy roads. The hierarchy field must be present and named the same for all input feature classes.
• This tool operates by assessing graphic conflicts of symbolized features. The symbology extent and the reference scale are considered in conjunction with one another. Run this tool only after you have finalized the appearance of your symbols, and ensure that the reference scale corresponds to the final intended output scale.
• You can "lock" features from displacement by calculating the Hierarchy Field value equal to 0 (zero). This is useful when a road should not be moved because of its a spatial relationship with other map features, especially continuous data like elevation, and should not be moved.
• The optional Output Displacement Feature Class parameter creates a feature class of polygons that indicates the amount and direction of displacement that took place. This feature class can be used for visual inspection, for spatial querying, or as an input to the tool.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ResolveRoadConflicts()
Creates the Resolve Road Conflicts tool with defaults.

ResolveRoadConflicts(Object inLayers, String hierarchyField)
Creates the Resolve Road Conflicts tool with the required parameters.

Method Summary

String	getHierarchyField() Returns the Hierarchy Field parameter of this tool .
Object	getInLayers() Returns the Input Road Layers parameter of this tool .
Object	getOutDisplacementFeatures() Returns the Output Displacement Feature Class parameter of this tool .
Object	getOutLayers() Returns the Output Layers parameter of this tool (Read only).
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	setHierarchyField(String hierarchyField) Sets the Hierarchy Field parameter of this tool .
void	setInLayers(Object inLayers) Sets the Input Road Layers parameter of this tool .
void	setOutDisplacementFeatures(Object outDisplacementFeatures) Sets the Output Displacement 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

ResolveRoadConflicts

public ResolveRoadConflicts()

Creates the Resolve Road Conflicts tool with defaults.

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

ResolveRoadConflicts

public ResolveRoadConflicts(Object inLayers,
                            String hierarchyField)

Creates the Resolve Road Conflicts 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:

inLayers - the input feature layers containing symbolized road features that may be in conflict.

hierarchyField - the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 (zero) locks the feature to ensure that it is not moved. The hierarchy field must be present and named the same for all input feature classes.

Method Detail

getInLayers

public Object getInLayers()

Returns the Input Road Layers parameter of this tool . This parameter is the input feature layers containing symbolized road features that may be in conflict. This is a required parameter.

Returns:

the Input Road Layers

setInLayers

public void setInLayers(Object inLayers)

Sets the Input Road Layers parameter of this tool . This parameter is the input feature layers containing symbolized road features that may be in conflict. This is a required parameter.

Parameters:

inLayers - the input feature layers containing symbolized road features that may be in conflict.

getHierarchyField

public String getHierarchyField()

Returns the Hierarchy Field parameter of this tool . This parameter is the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 (zero) locks the feature to ensure that it is not moved. The hierarchy field must be present and named the same for all input feature classes. This is a required parameter.

Returns:

the Hierarchy Field

setHierarchyField

public void setHierarchyField(String hierarchyField)

Sets the Hierarchy Field parameter of this tool . This parameter is the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 (zero) locks the feature to ensure that it is not moved. The hierarchy field must be present and named the same for all input feature classes. This is a required parameter.

Parameters:

hierarchyField - the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 (zero) locks the feature to ensure that it is not moved. The hierarchy field must be present and named the same for all input feature classes.

getOutDisplacementFeatures

public Object getOutDisplacementFeatures()

Returns the Output Displacement Feature Class parameter of this tool . This parameter is the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships. This is an optional parameter.

Returns:

the Output Displacement Feature Class

setOutDisplacementFeatures

public void setOutDisplacementFeatures(Object outDisplacementFeatures)

Sets the Output Displacement Feature Class parameter of this tool . This parameter is the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships. This is an optional parameter.

Parameters:

outDisplacementFeatures - the output polygon features containing the degree and direction of road displacement, to be used by the Propagate Displacement tool to preserve spatial relationships.

getOutLayers

public Object getOutLayers()

Returns the Output Layers parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Layers

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