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

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

All Implemented Interfaces:

GPTool

public class XYToLine
extends AbstractGPTool

Creates a new feature class containing geodetic two-point polyline features from a table of start and end points. The XY To Line tool is contained in the Data Management Tools tool box.

Usage tips:

• Each row in the input table creates an individual two-point polyline in the output feature class.

Field Summary

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

vals

Constructor Summary

XYToLine()
Creates the XY To Line tool with defaults.

XYToLine(Object inTable, Object outFeatureclass, Object startxField, Object startyField, Object endxField, Object endyField, String lineType)
Creates the XY To Line tool with the required parameters.

Method Summary

Object	getEndxField() Returns the End X Field parameter of this tool .
Object	getEndyField() Returns the End Y Field parameter of this tool .
Object	getIdField() Returns the ID parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
String	getLineType() Returns the Line Type parameter of this tool .
Object	getOutFeatureclass() Returns the Output Feature Class parameter of this tool .
Object	getSpatialReference() Returns the Spatial Reference parameter of this tool .
Object	getStartxField() Returns the Start X Field parameter of this tool .
Object	getStartyField() Returns the Start Y Field 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	setEndxField(Object endxField) Sets the End X Field parameter of this tool .
void	setEndyField(Object endyField) Sets the End Y Field parameter of this tool .
void	setIdField(Object idField) Sets the ID parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setLineType(String lineType) Sets the Line Type parameter of this tool .
void	setOutFeatureclass(Object outFeatureclass) Sets the Output Feature Class parameter of this tool .
void	setSpatialReference(Object spatialReference) Sets the Spatial Reference parameter of this tool .
void	setStartxField(Object startxField) Sets the Start X Field parameter of this tool .
void	setStartyField(Object startyField) Sets the Start Y Field 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

XYToLine

public XYToLine()

Creates the XY To Line tool with defaults.

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

XYToLine

public XYToLine(Object inTable,
                Object outFeatureclass,
                Object startxField,
                Object startyField,
                Object endxField,
                Object endyField,
                String lineType)

Creates the XY To Line 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 with fields for starting and ending X and Y coordinates.

outFeatureclass - feature class that will contain the output lines.

startxField - starting point's X coordinate field.

startyField - starting point's Y coordinate field.

endxField - ending point's X coordinate field.

endyField - ending point's Y coordinate field.

lineType - type of two-point lines to construct. Default line type is GEODESIC.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is table with fields for starting and ending X and Y coordinates. 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 with fields for starting and ending X and Y coordinates. This is a required parameter.

Parameters:

inTable - table with fields for starting and ending X and Y coordinates.

getOutFeatureclass

public Object getOutFeatureclass()

Returns the Output Feature Class parameter of this tool . This parameter is feature class that will contain the output lines. 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 feature class that will contain the output lines. This is a required parameter.

Parameters:

outFeatureclass - feature class that will contain the output lines.

getStartxField

public Object getStartxField()

Returns the Start X Field parameter of this tool . This parameter is starting point's X coordinate field. This is a required parameter.

Returns:

the Start X Field

setStartxField

public void setStartxField(Object startxField)

Sets the Start X Field parameter of this tool . This parameter is starting point's X coordinate field. This is a required parameter.

Parameters:

startxField - starting point's X coordinate field.

getStartyField

public Object getStartyField()

Returns the Start Y Field parameter of this tool . This parameter is starting point's Y coordinate field. This is a required parameter.

Returns:

the Start Y Field

setStartyField

public void setStartyField(Object startyField)

Sets the Start Y Field parameter of this tool . This parameter is starting point's Y coordinate field. This is a required parameter.

Parameters:

startyField - starting point's Y coordinate field.

getEndxField

public Object getEndxField()

Returns the End X Field parameter of this tool . This parameter is ending point's X coordinate field. This is a required parameter.

Returns:

the End X Field

setEndxField

public void setEndxField(Object endxField)

Sets the End X Field parameter of this tool . This parameter is ending point's X coordinate field. This is a required parameter.

Parameters:

endxField - ending point's X coordinate field.

getEndyField

public Object getEndyField()

Returns the End Y Field parameter of this tool . This parameter is ending point's Y coordinate field. This is a required parameter.

Returns:

the End Y Field

setEndyField

public void setEndyField(Object endyField)

Sets the End Y Field parameter of this tool . This parameter is ending point's Y coordinate field. This is a required parameter.

Parameters:

endyField - ending point's Y coordinate field.

getLineType

public String getLineType()

Returns the Line Type parameter of this tool . This parameter is type of two-point lines to construct. Default line type is GEODESIC. This is a required parameter.

Returns:

the Line Type

setLineType

public void setLineType(String lineType)

Sets the Line Type parameter of this tool . This parameter is type of two-point lines to construct. Default line type is GEODESIC. This is a required parameter.

Parameters:

lineType - type of two-point lines to construct. Default line type is GEODESIC.

getIdField

public Object getIdField()

Returns the ID parameter of this tool . This parameter is iD field from the input table. This may be used to join the output features back to the input table. This is an optional parameter.

Returns:

the ID

setIdField

public void setIdField(Object idField)

Sets the ID parameter of this tool . This parameter is iD field from the input table. This may be used to join the output features back to the input table. This is an optional parameter.

Parameters:

idField - iD field from the input table. This may be used to join the output features back to the input table.

getSpatialReference

public Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is spatial Reference of the input coordinates. 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. Default is GCS_WGS_1984. This is an optional parameter.

Parameters:

spatialReference - spatial Reference of the input coordinates. 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