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. The Add XY Coordinates tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• Add XY Coordinates is most commonly used to get access to feature class geometry to perform queries or analysis or extract features based on their x,y location.
• If the fields POINT_X and POINT_Y fields already exist, the values will be updated.
• If the features are moved after using Add XY Coordinates, the POINT_X and POINT_Y values will not represent the new locations. To update their values to the new location, rerun the tool. The values for POINT_X and POINT_Y are not modified by other tools, such as Project;
• If your input features are in a geographic coordinate system; , POINT_X and POINT_Y represent the longitude and latitude, respectively.
• Add XY Coordinates will also add POINT_Z and POINT_M fields when the input features is z- and m-enabled.
• If an layer in ArcMap is selected as the input feature class, the XY coordinates will be based on the coordinate system of the input not the coordinate system of the dataframe (if they are different).
• The following environments affect this tool: extent; and workspace;

Field Summary

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

vals

Constructor Summary

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

AddXY(java.lang.Object inFeatures)
Creates the Add XY Coordinates tool with the required parameters.

Method Summary

java.lang.Object	getInFeatures() Returns the Input Features parameter of this tool .
java.lang.Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInFeatures(java.lang.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(java.lang.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 - Feature Layer, the point features whose x,y coordinates will become feature fields.

Method Detail

getInFeatures

public java.lang.Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the point features whose x,y coordinates will become feature fields. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(java.lang.Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is Feature Layer, the point features whose x,y coordinates will become feature fields. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the point features whose x,y coordinates will become feature fields.

getOutFeatures

public java.lang.Object getOutFeatures()

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

Returns:

the Output Features

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias