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

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

All Implemented Interfaces:

GPTool

public class AddXY
extends AbstractGPTool

Adds the fields POINT_X and POINT_Y to the point input features and calculates their values. It also appends the POINT_Z and POINT_M fields if the input features are Z- and M-enabled. The Add XY Coordinates tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool modifies the input data. See for more information and strategies to avoid undesired data changes.
• Add XY Coordinates is most commonly used to get access to point features to perform analysis or to extract points based on their x,y location.
• If the POINT_X, POINT_Y, POINT_Z, and POINT_M fields exist, their values are recalculated.
• If points are moved after using Add XY Coordinates, their POINT_X and POINT_Y values, and POINT_Z, and POINT_M values—if present—must be recomputed by running Add XY Coordinates again.
• does not modify the values of POINT_X, POINT_Y, POINT_Z, or POINT_M.
• If the Input Features are in a geographic coordinate system, POINT_X and POINT_Y represent the longitude and latitude, respectively.
• If an ArcMap layer is selected as input , the x,y coordinates are based on the input's coordinate system, not that of the data frame.

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 inFeatures)
Creates the Add XY Coordinates tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatures() Returns the Output Features 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	setInFeatures(Object inFeatures) Sets the Input Features 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 inFeatures)

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:

inFeatures - the point features whose x,y coordinates will be appended as POINT_X and POINT_Y fields.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the point features whose x,y coordinates will be appended as POINT_X and POINT_Y fields. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the point features whose x,y coordinates will be appended as POINT_X and POINT_Y fields. This is a required parameter.

Parameters:

inFeatures - the point features whose x,y coordinates will be appended as POINT_X and POINT_Y fields.

getOutFeatures

public Object getOutFeatures()

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

Returns:

the Output Features

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