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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.AddXY

All Implemented Interfaces:

GPTool

public class AddXY
extends AbstractGPTool

Adds the items X-COORD and Y-COORD for labels or points to the input coverage PAT, or for nodes to the input coverage NAT, and calculates their values. The Add XY Coordinates tool is contained in the Coverage Tools tool box.

Usage tips:

• If the items X-COORD and Y-COORD already exist, they will be overwritten.
• If the input coverage is single precision, the items will be defined with Item width 4, Display width 12, Item type F, and Decimal places 3. If the input coverage is double precision, the items will be defined with Item width 8, Display width 18, Item type F, and Decimal places 5. Once defined, this definition will not change even if the is changed.
• If the point or node locations are moved after using Add XY Coordinates, the X-COORD and Y-COORD values will not represent the new locations. To update their values to the new location, rerun the tool. The values for X-COORD and Y-COORD are not modified by other tools, such as and .
• If your input coverage is in a geographic coordinate system, the X-COORD and Y-COORD represents the longitude and latitude, respectively.

Field Summary

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

vals

Constructor Summary

AddXY()
Creates the Add XY Coordinates tool with defaults.

AddXY(Object inCover)
Creates the Add XY Coordinates tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setInCover(Object inCover) Sets the Input 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

AddXY

public AddXY()

Creates the Add XY Coordinates tool with defaults.

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

AddXY

public AddXY(Object inCover)

Creates the Add XY Coordinates 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 containing points or polygon labels whose x,y coordinates will become attributes in the PAT, or in the coverage containing nodes, to the NAT.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage containing points or polygon labels whose x,y coordinates will become attributes in the PAT, or in the coverage containing nodes, to the NAT. 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 containing points or polygon labels whose x,y coordinates will become attributes in the PAT, or in the coverage containing nodes, to the NAT. This is a required parameter.

Parameters:

inCover - the coverage containing points or polygon labels whose x,y coordinates will become attributes in the PAT, or in the coverage containing nodes, to the NAT.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is type of coverage feature whose x,y coordinates will become feature attributes. This is an optional parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is type of coverage feature whose x,y coordinates will become feature attributes. This is an optional parameter.

Parameters:

featureType - type of coverage feature whose x,y coordinates will become feature attributes.

getOutCover

public Object getOutCover()

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

Returns:

the Output Coverage

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