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

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

All Implemented Interfaces:

GPTool

public class MakeXYEventLayer
extends AbstractGPTool

Makes a point The Make XY Event Layer tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool allows you to create a layer based on x and y columns from an input table.
• The Spatial Reference parameter allows you to specify the spatial reference of the output coordinates.
• If the table is editable, you will be able to edit the layer. However, you won't be able to interactively move a point on the map; you can change the x & y coordinates attributes in the table.
• If the table does not have an ObjectID (such as delimited text files or tables from OLE DB connections), you will not be able to make selections or add joins to the resulting layer.
• When working in ArcCatalog, you can use the Save To Layer File tool to write the x,y layer to a layer file. When using ArcMap, the tool adds the layer to the table of contents automatically.
• Learn more about adding x,y coordinate data to a map;
• No environment settings affect this tool.

Field Summary

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

vals

Constructor Summary

MakeXYEventLayer()
Creates the Make XY Event Layer tool with defaults.

MakeXYEventLayer(Object table, Object inXField, Object inYField, Object outLayer)
Creates the Make XY Event Layer tool with the required parameters.

Method Summary

Object	getInXField() Returns the X Field parameter of this tool .
Object	getInYField() Returns the Y Field parameter of this tool .
Object	getOutLayer() Returns the Layer Name or Table View parameter of this tool .
Object	getSpatialReference() Returns the Spatial Reference parameter of this tool .
Object	getTable() Returns the XY Table 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	setInXField(Object inXField) Sets the X Field parameter of this tool .
void	setInYField(Object inYField) Sets the Y Field parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Layer Name or Table View parameter of this tool .
void	setSpatialReference(Object spatialReference) Sets the Spatial Reference parameter of this tool .
void	setTable(Object table) Sets the XY Table 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

MakeXYEventLayer

public MakeXYEventLayer()

Creates the Make XY Event Layer tool with defaults.

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

MakeXYEventLayer

public MakeXYEventLayer(Object table,
                        Object inXField,
                        Object inYField,
                        Object outLayer)

Creates the Make XY Event Layer 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:

table - Table View, the table that contains the X and Y coordinates that define the location of the points in the layer.

inXField - Field, in the table that contains the X coordinates.

inYField - Field, the field in the table that contains the Y coordinates.

outLayer - Feature Layer, the name of the point layer generated by Make XY Event Layer.

Method Detail

getTable

public Object getTable()

Returns the XY Table parameter of this tool . This parameter is Table View, the table that contains the X and Y coordinates that define the location of the points in the layer. This is a required parameter.

Returns:

the XY Table

setTable

public void setTable(Object table)

Sets the XY Table parameter of this tool . This parameter is Table View, the table that contains the X and Y coordinates that define the location of the points in the layer. This is a required parameter.

Parameters:

table - Table View, the table that contains the X and Y coordinates that define the location of the points in the layer.

getInXField

public Object getInXField()

Returns the X Field parameter of this tool . This parameter is Field, in the table that contains the X coordinates. This is a required parameter.

Returns:

the X Field

setInXField

public void setInXField(Object inXField)

Sets the X Field parameter of this tool . This parameter is Field, in the table that contains the X coordinates. This is a required parameter.

Parameters:

inXField - Field, in the table that contains the X coordinates.

getInYField

public Object getInYField()

Returns the Y Field parameter of this tool . This parameter is Field, the field in the table that contains the Y coordinates. This is a required parameter.

Returns:

the Y Field

setInYField

public void setInYField(Object inYField)

Sets the Y Field parameter of this tool . This parameter is Field, the field in the table that contains the Y coordinates. This is a required parameter.

Parameters:

inYField - Field, the field in the table that contains the Y coordinates.

getOutLayer

public Object getOutLayer()

Returns the Layer Name or Table View parameter of this tool . This parameter is Feature Layer, the name of the point layer generated by Make XY Event Layer. This is a required parameter.

Returns:

the Layer Name or Table View

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Layer Name or Table View parameter of this tool . This parameter is Feature Layer, the name of the point layer generated by Make XY Event Layer. This is a required parameter.

Parameters:

outLayer - Feature Layer, the name of the point layer generated by Make XY Event Layer.

getSpatialReference

public Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is Spatial Reference, of the coordinates in the X and Y fields defined above. This will be the output layer's coordinate system. 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 coordinates in the X and Y fields defined above. This will be the output layer's coordinate system. This is an optional parameter.

Parameters:

spatialReference - Spatial Reference, of the coordinates in the X and Y fields defined above. This will be the output layer's coordinate system.

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