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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.MakeXYEventLayer
All Implemented Interfaces:
GPTool

public class MakeXYEventLayer
extends AbstractGPTool

Creates a new point feature layer based on The Make XY Event Layer tool is contained in the Data Management Tools tool box.

Usage tips:


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 getInZField()
          Returns the Z 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 setInZField(Object inZField)
          Sets the Z 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 - the table containing the and coordinates that define the locations of the point features in the output event layer.
inXField - the field in the input table that contains the coordinates.
inYField - the field in the input table that contains the coordinates.
outLayer - the name of the output point event layer.
Method Detail

getTable

public Object getTable()
Returns the XY Table parameter of this tool . This parameter is the table containing the and coordinates that define the locations of the point features in the output event 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 the table containing the and coordinates that define the locations of the point features in the output event layer. This is a required parameter.

Parameters:
table - the table containing the and coordinates that define the locations of the point features in the output event layer.

getInXField

public Object getInXField()
Returns the X Field parameter of this tool . This parameter is the field in the input table that contains the 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 the field in the input table that contains the coordinates. This is a required parameter.

Parameters:
inXField - the field in the input table that contains the coordinates.

getInYField

public Object getInYField()
Returns the Y Field parameter of this tool . This parameter is the field in the input table that contains the 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 the field in the input table that contains the coordinates. This is a required parameter.

Parameters:
inYField - the field in the input table that contains the coordinates.

getOutLayer

public Object getOutLayer()
Returns the Layer Name or Table View parameter of this tool . This parameter is the name of the output point 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 the name of the output point event layer. This is a required parameter.

Parameters:
outLayer - the name of the output point event layer.

getSpatialReference

public Object getSpatialReference()
Returns the Spatial Reference parameter of this tool . This parameter is the spatial reference of the coordinates in the X and Y Fields defined above. This will be the output event layer's spatial reference. 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 the spatial reference of the coordinates in the X and Y Fields defined above. This will be the output event layer's spatial reference. This is an optional parameter.

Parameters:
spatialReference - the spatial reference of the coordinates in the X and Y Fields defined above. This will be the output event layer's spatial reference.

getInZField

public Object getInZField()
Returns the Z Field parameter of this tool . This parameter is the field in the input table that contains the coordinates. This is an optional parameter.

Returns:
the Z Field

setInZField

public void setInZField(Object inZField)
Sets the Z Field parameter of this tool . This parameter is the field in the input table that contains the coordinates. This is an optional parameter.

Parameters:
inZField - the field in the input table that contains the coordinates.

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