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

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

All Implemented Interfaces:

GPTool

public class ConvertCoordinateNotation
extends AbstractGPTool

Converts a table containing point coordinate fields to a point feature class. The input table's coordinate fields can be in a variety of notations, such as GARS, UTM, and MGRS. The output point feature class also contains point coordinate fields in a coordinate notation of your choosing. The Convert Coordinate Notation tool is contained in the Data Management Tools tool box.

Usage tips:

• The input coordinate fields can be in any of the following notations. The point output feature class will also have coordinate fields in any of these notations.
  • decimal degrees (DD)
  • decimal minutes (DDM)
  • degrees-minutes-seconds (DMS)
  • Global Area Reference System (GARS)
  • World Geographic Reference System (GEOREF)
  • Universal Transverse Mercator (UTM)
  • United States National Grid (USNG)
  • Military Grid Reference System (MGRS)
• Decimal degree (DD) coordinates are two strings and must be in the format DDD.dddd.
• Decimal minute (DDM) coordinates are two strings and must be in the format DDD MM.mmmm.
• Degree-minute-second (DMS) coordinates are single string and must be in the format DD MM SS.ssss DDD MM SS.ssss. Latitude is first followed by longitude separated by spaces.
• GARS, GEOREF, UTM, USNG, and MGRS are single-string coordinate formats, meaning only one field contains the coordinate. When converting from one of these formats only the X Field will be used.
• Field names in the output point feature class match the output coordinate notation name. For example, MGRS coordinates will be stored in a field named MGRS. If the field name exists, a new sequential field will be added (e.g., MGRS1, MGRS2, MGRS3, and so on).
• Fields from the input table are not copied to the output feature class. You can use the tool to copy fields from the input table to the output feature class.
• The tool can be used to create a feature class from a table containing x,y coordinate fields.

Field Summary

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

vals

Constructor Summary

ConvertCoordinateNotation()
Creates the Convert Coordinate Notation tool with defaults.

ConvertCoordinateNotation(Object inTable, Object outFeatureclass, Object xField, Object yField, String inputCoordinateFormat, String outputCoordinateFormat)
Creates the Convert Coordinate Notation tool with the required parameters.

Method Summary

Object	getIdField() Returns the ID parameter of this tool .
String	getInputCoordinateFormat() Returns the Input Coordinate Format parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutFeatureclass() Returns the Output Feature Class parameter of this tool .
String	getOutputCoordinateFormat() Returns the Output Coordinate Format parameter of this tool .
Object	getSpatialReference() Returns the Spatial Reference 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.
Object	getXField() Returns the X Field (Longitude) parameter of this tool .
Object	getYField() Returns the Y Field (Latitude) parameter of this tool .
void	setIdField(Object idField) Sets the ID parameter of this tool .
void	setInputCoordinateFormat(String inputCoordinateFormat) Sets the Input Coordinate Format parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutFeatureclass(Object outFeatureclass) Sets the Output Feature Class parameter of this tool .
void	setOutputCoordinateFormat(String outputCoordinateFormat) Sets the Output Coordinate Format parameter of this tool .
void	setSpatialReference(Object spatialReference) Sets the Spatial Reference parameter of this tool .
void	setXField(Object xField) Sets the X Field (Longitude) parameter of this tool .
void	setYField(Object yField) Sets the Y Field (Latitude) 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

ConvertCoordinateNotation

public ConvertCoordinateNotation()

Creates the Convert Coordinate Notation tool with defaults.

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

ConvertCoordinateNotation

public ConvertCoordinateNotation(Object inTable,
                                 Object outFeatureclass,
                                 Object xField,
                                 Object yField,
                                 String inputCoordinateFormat,
                                 String outputCoordinateFormat)

Creates the Convert Coordinate Notation 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:

inTable - table containing the coordinate field(s) to convert.

outFeatureclass - output feature class of points. The attribute table will contain a field of the converted coordinates.

xField - x coordinate field name in the Input Table. For DD and DDM this is the longitude field. For DMS, GARS, GEOREF, UTM, USNG, and MGRS, this is the only field as these are single-string coordinate types.

yField - y coordinate field name in the input table. For DD and DDM this is the latitude field. This parameter is disabled for DMS, GARS, GEOREF, UTM, USNG, and MGRS.

inputCoordinateFormat - coordinate format of the input fields. The default is DD.

outputCoordinateFormat - format of the output coordinates in the output point feature class. The default is DD.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is table containing the coordinate field(s) to convert. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is table containing the coordinate field(s) to convert. This is a required parameter.

Parameters:

inTable - table containing the coordinate field(s) to convert.

getOutFeatureclass

public Object getOutFeatureclass()

Returns the Output Feature Class parameter of this tool . This parameter is output feature class of points. The attribute table will contain a field of the converted coordinates. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureclass

public void setOutFeatureclass(Object outFeatureclass)

Sets the Output Feature Class parameter of this tool . This parameter is output feature class of points. The attribute table will contain a field of the converted coordinates. This is a required parameter.

Parameters:

outFeatureclass - output feature class of points. The attribute table will contain a field of the converted coordinates.

getXField

public Object getXField()

Returns the X Field (Longitude) parameter of this tool . This parameter is x coordinate field name in the Input Table. For DD and DDM this is the longitude field. For DMS, GARS, GEOREF, UTM, USNG, and MGRS, this is the only field as these are single-string coordinate types. This is a required parameter.

Returns:

the X Field (Longitude)

setXField

public void setXField(Object xField)

Sets the X Field (Longitude) parameter of this tool . This parameter is x coordinate field name in the Input Table. For DD and DDM this is the longitude field. For DMS, GARS, GEOREF, UTM, USNG, and MGRS, this is the only field as these are single-string coordinate types. This is a required parameter.

Parameters:

xField - x coordinate field name in the Input Table. For DD and DDM this is the longitude field. For DMS, GARS, GEOREF, UTM, USNG, and MGRS, this is the only field as these are single-string coordinate types.

getYField

public Object getYField()

Returns the Y Field (Latitude) parameter of this tool . This parameter is y coordinate field name in the input table. For DD and DDM this is the latitude field. This parameter is disabled for DMS, GARS, GEOREF, UTM, USNG, and MGRS. This is a required parameter.

Returns:

the Y Field (Latitude)

setYField

public void setYField(Object yField)

Sets the Y Field (Latitude) parameter of this tool . This parameter is y coordinate field name in the input table. For DD and DDM this is the latitude field. This parameter is disabled for DMS, GARS, GEOREF, UTM, USNG, and MGRS. This is a required parameter.

Parameters:

yField - y coordinate field name in the input table. For DD and DDM this is the latitude field. This parameter is disabled for DMS, GARS, GEOREF, UTM, USNG, and MGRS.

getInputCoordinateFormat

public String getInputCoordinateFormat()

Returns the Input Coordinate Format parameter of this tool . This parameter is coordinate format of the input fields. The default is DD. This is a required parameter.

Returns:

the Input Coordinate Format

setInputCoordinateFormat

public void setInputCoordinateFormat(String inputCoordinateFormat)

Sets the Input Coordinate Format parameter of this tool . This parameter is coordinate format of the input fields. The default is DD. This is a required parameter.

Parameters:

inputCoordinateFormat - coordinate format of the input fields. The default is DD.

getOutputCoordinateFormat

public String getOutputCoordinateFormat()

Returns the Output Coordinate Format parameter of this tool . This parameter is format of the output coordinates in the output point feature class. The default is DD. This is a required parameter.

Returns:

the Output Coordinate Format

setOutputCoordinateFormat

public void setOutputCoordinateFormat(String outputCoordinateFormat)

Sets the Output Coordinate Format parameter of this tool . This parameter is format of the output coordinates in the output point feature class. The default is DD. This is a required parameter.

Parameters:

outputCoordinateFormat - format of the output coordinates in the output point feature class. The default is DD.

getIdField

public Object getIdField()

Returns the ID parameter of this tool . This is an optional parameter.

Returns:

the ID

setIdField

public void setIdField(Object idField)

Sets the ID parameter of this tool . This is an optional parameter.

Parameters:

idField - null

getSpatialReference

public Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is spatial reference of the input coordinates. The default is GCS_WGS_1984. This is an optional parameter.

Returns:

the Spatial Reference

setSpatialReference

public void setSpatialReference(Object spatialReference)

Sets the Spatial Reference parameter of this tool . This parameter is spatial reference of the input coordinates. The default is GCS_WGS_1984. This is an optional parameter.

Parameters:

spatialReference - spatial reference of the input coordinates. The default is GCS_WGS_1984.

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