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

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

All Implemented Interfaces:

GPTool

public class AlignMarkerToStrokeOrFill
extends AbstractGPTool

Align the representation marker symbols of a point feature class to the nearest stroke or fill representation symbols in a line or polygon feature class within a specified search distance. The Align Marker To Stroke Or Fill tool is contained in the Cartography Tools tool box.

Usage tips:

• Representation marker symbols are aligned by overriding the angle property of representation marker symbol layer.
• The search distance is the measurement from the graphical edge of the marker to the graphical edge of the nearest stroke or fill outline. Representation geometry (shape) overrides are honored. Representation markers beyond the search distance will not be rotated. A search distance of zero aligns only markers that are coincident to a representation stroke or fill symbol.
• Features that have null or invalid representation rules, or that have the representation visibility property off, will not be aligned.
• Rotating markers may introduce graphic conflicts. Thetool can be used to identify these areas.

Field Summary

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

vals

Constructor Summary

AlignMarkerToStrokeOrFill()
Creates the Align Marker To Stroke Or Fill tool with defaults.

AlignMarkerToStrokeOrFill(Object inPointFeatures, Object inLineOrPolygonFeatures, Object searchDistance)
Creates the Align Marker To Stroke Or Fill tool with the required parameters.

Method Summary

Object	getInLineOrPolygonFeatures() Returns the Input Features With Stroke Or Fill Representations parameter of this tool .
Object	getInPointFeatures() Returns the Input Point Features With Marker Representations parameter of this tool .
String	getMarkerOrientation() Returns the Marker Orientation parameter of this tool .
Object	getOutRepresentations() Returns the Output Representations parameter of this tool (Read only).
Object	getSearchDistance() Returns the Search Distance 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	setInLineOrPolygonFeatures(Object inLineOrPolygonFeatures) Sets the Input Features With Stroke Or Fill Representations parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input Point Features With Marker Representations parameter of this tool .
void	setMarkerOrientation(String markerOrientation) Sets the Marker Orientation parameter of this tool .
void	setSearchDistance(Object searchDistance) Sets the Search Distance 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

AlignMarkerToStrokeOrFill

public AlignMarkerToStrokeOrFill()

Creates the Align Marker To Stroke Or Fill tool with defaults.

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

AlignMarkerToStrokeOrFill

public AlignMarkerToStrokeOrFill(Object inPointFeatures,
                                 Object inLineOrPolygonFeatures,
                                 Object searchDistance)

Creates the Align Marker To Stroke Or Fill 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:

inPointFeatures - the input point feature layer containing marker representations.

inLineOrPolygonFeatures - the input line or polygon feature layer containing stroke or fill representations.

searchDistance - the search distance from graphical marker edge to graphical stroke edge. A distance greater than or equal to zero must be specified.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input Point Features With Marker Representations parameter of this tool . This parameter is the input point feature layer containing marker representations. This is a required parameter.

Returns:

the Input Point Features With Marker Representations

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input Point Features With Marker Representations parameter of this tool . This parameter is the input point feature layer containing marker representations. This is a required parameter.

Parameters:

inPointFeatures - the input point feature layer containing marker representations.

getInLineOrPolygonFeatures

public Object getInLineOrPolygonFeatures()

Returns the Input Features With Stroke Or Fill Representations parameter of this tool . This parameter is the input line or polygon feature layer containing stroke or fill representations. This is a required parameter.

Returns:

the Input Features With Stroke Or Fill Representations

setInLineOrPolygonFeatures

public void setInLineOrPolygonFeatures(Object inLineOrPolygonFeatures)

Sets the Input Features With Stroke Or Fill Representations parameter of this tool . This parameter is the input line or polygon feature layer containing stroke or fill representations. This is a required parameter.

Parameters:

inLineOrPolygonFeatures - the input line or polygon feature layer containing stroke or fill representations.

getSearchDistance

public Object getSearchDistance()

Returns the Search Distance parameter of this tool . This parameter is the search distance from graphical marker edge to graphical stroke edge. A distance greater than or equal to zero must be specified. This is a required parameter.

Returns:

the Search Distance

setSearchDistance

public void setSearchDistance(Object searchDistance)

Sets the Search Distance parameter of this tool . This parameter is the search distance from graphical marker edge to graphical stroke edge. A distance greater than or equal to zero must be specified. This is a required parameter.

Parameters:

searchDistance - the search distance from graphical marker edge to graphical stroke edge. A distance greater than or equal to zero must be specified.

getMarkerOrientation

public String getMarkerOrientation()

Returns the Marker Orientation parameter of this tool . This parameter is specifies the representation marker orientation relative to the stroke or fill edge. This is an optional parameter.

Returns:

the Marker Orientation

setMarkerOrientation

public void setMarkerOrientation(String markerOrientation)

Sets the Marker Orientation parameter of this tool . This parameter is specifies the representation marker orientation relative to the stroke or fill edge. This is an optional parameter.

Parameters:

markerOrientation - specifies the representation marker orientation relative to the stroke or fill edge.

getOutRepresentations

public Object getOutRepresentations()

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

Returns:

the Output Representations

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