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

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

All Implemented Interfaces:

GPTool

public class TableToEllipse
extends AbstractGPTool

Converts a table (text file, CSV file, Excel file, dBASE table, or geodatabase table) containing coordinate and other required fields to a feature class. The output features are elliptical polygons. A single ellipse is generated from each row in the table. The features created are defined by a starting point, semi-major and semi-minor axis lengths, and rotation. The Table To Ellipse tool is contained in the Data Management Tools tool box.

Usage tips:

• Input text files and CSV files must follow the file structure specified in .
• The default spatial reference is GCS_WGS_1984.
• The following fields are required in the input table, as they are used to generate the ellipse geometries:
  • X Field
  • Y Field
  • Major Axis Field
  • Minor Axis Field
  • Distance Units
• The Azimuth (rotation) field is optional.

Field Summary

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

vals

Constructor Summary

TableToEllipse()
Creates the Table To Ellipse tool with defaults.

TableToEllipse(Object inTable, Object outFeatureclass, Object xField, Object yField, Object majorField, Object minorField, String distanceUnits)
Creates the Table To Ellipse tool with the required parameters.

Method Summary

Object	getAzimuthField() Returns the Azimuth Field parameter of this tool .
String	getAzimuthUnits() Returns the Azimuth Units parameter of this tool .
String	getDistanceUnits() Returns the Distance Units parameter of this tool .
Object	getIdField() Returns the ID parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getMajorField() Returns the Major Field parameter of this tool .
Object	getMinorField() Returns the Minor Field 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 .
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 parameter of this tool .
Object	getYField() Returns the Y Field parameter of this tool .
void	setAzimuthField(Object azimuthField) Sets the Azimuth Field parameter of this tool .
void	setAzimuthUnits(String azimuthUnits) Sets the Azimuth Units parameter of this tool .
void	setDistanceUnits(String distanceUnits) Sets the Distance Units 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	setMajorField(Object majorField) Sets the Major Field parameter of this tool .
void	setMinorField(Object minorField) Sets the Minor Field 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	setXField(Object xField) Sets the X Field parameter of this tool .
void	setYField(Object yField) Sets the 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

TableToEllipse

public TableToEllipse()

Creates the Table To Ellipse tool with defaults.

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

TableToEllipse

public TableToEllipse(Object inTable,
                      Object outFeatureclass,
                      Object xField,
                      Object yField,
                      Object majorField,
                      Object minorField,
                      String distanceUnits)

Creates the Table To Ellipse 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 - the input table from which to generate ellipse features.

outFeatureclass - the output feature class that will contain the ellipse features.

xField - the input table field containing the X (longitude) center point coordinate.

yField - the input table field containing the Y (latitude) center point coordinate.

majorField - field name containing (semi) major axis length values of the ellipses.

minorField - field name containing (semi) minor axis length values of the ellipses.

distanceUnits - the units of measure of the major and minor axes. METERS is the default.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the input table from which to generate ellipse features. 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 the input table from which to generate ellipse features. This is a required parameter.

Parameters:

inTable - the input table from which to generate ellipse features.

getOutFeatureclass

public Object getOutFeatureclass()

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

Parameters:

outFeatureclass - the output feature class that will contain the ellipse features.

getXField

public Object getXField()

Returns the X Field parameter of this tool . This parameter is the input table field containing the X (longitude) center point coordinate. This is a required parameter.

Returns:

the X Field

setXField

public void setXField(Object xField)

Sets the X Field parameter of this tool . This parameter is the input table field containing the X (longitude) center point coordinate. This is a required parameter.

Parameters:

xField - the input table field containing the X (longitude) center point coordinate.

getYField

public Object getYField()

Returns the Y Field parameter of this tool . This parameter is the input table field containing the Y (latitude) center point coordinate. This is a required parameter.

Returns:

the Y Field

setYField

public void setYField(Object yField)

Sets the Y Field parameter of this tool . This parameter is the input table field containing the Y (latitude) center point coordinate. This is a required parameter.

Parameters:

yField - the input table field containing the Y (latitude) center point coordinate.

getMajorField

public Object getMajorField()

Returns the Major Field parameter of this tool . This parameter is field name containing (semi) major axis length values of the ellipses. This is a required parameter.

Returns:

the Major Field

setMajorField

public void setMajorField(Object majorField)

Sets the Major Field parameter of this tool . This parameter is field name containing (semi) major axis length values of the ellipses. This is a required parameter.

Parameters:

majorField - field name containing (semi) major axis length values of the ellipses.

getMinorField

public Object getMinorField()

Returns the Minor Field parameter of this tool . This parameter is field name containing (semi) minor axis length values of the ellipses. This is a required parameter.

Returns:

the Minor Field

setMinorField

public void setMinorField(Object minorField)

Sets the Minor Field parameter of this tool . This parameter is field name containing (semi) minor axis length values of the ellipses. This is a required parameter.

Parameters:

minorField - field name containing (semi) minor axis length values of the ellipses.

getDistanceUnits

public String getDistanceUnits()

Returns the Distance Units parameter of this tool . This parameter is the units of measure of the major and minor axes. METERS is the default. This is a required parameter.

Returns:

the Distance Units

setDistanceUnits

public void setDistanceUnits(String distanceUnits)

Sets the Distance Units parameter of this tool . This parameter is the units of measure of the major and minor axes. METERS is the default. This is a required parameter.

Parameters:

distanceUnits - the units of measure of the major and minor axes. METERS is the default.

getAzimuthField

public Object getAzimuthField()

Returns the Azimuth Field parameter of this tool . This parameter is field name containing Azimuth (rotation) values for the ellipse. azimuth values are geographic rotation and measured from North (zero degrees) with positive clockwise rotation. This is an optional parameter.

Returns:

the Azimuth Field

setAzimuthField

public void setAzimuthField(Object azimuthField)

Sets the Azimuth Field parameter of this tool . This parameter is field name containing Azimuth (rotation) values for the ellipse. azimuth values are geographic rotation and measured from North (zero degrees) with positive clockwise rotation. This is an optional parameter.

Parameters:

azimuthField - field name containing Azimuth (rotation) values for the ellipse. azimuth values are geographic rotation and measured from North (zero degrees) with positive clockwise rotation.

getAzimuthUnits

public String getAzimuthUnits()

Returns the Azimuth Units parameter of this tool . This parameter is the measurement units of the values in the Azimuth Field. DEGREES is the default. This is an optional parameter.

Returns:

the Azimuth Units

setAzimuthUnits

public void setAzimuthUnits(String azimuthUnits)

Sets the Azimuth Units parameter of this tool . This parameter is the measurement units of the values in the Azimuth Field. DEGREES is the default. This is an optional parameter.

Parameters:

azimuthUnits - the measurement units of the values in the Azimuth Field. DEGREES is the default.

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 the spatial reference of the input coordinates in the X Field and Y Field. This will become the spatial refrence of the output feature class. 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 the spatial reference of the input coordinates in the X Field and Y Field. This will become the spatial refrence of the output feature class. The default is GCS_WGS_1984. This is an optional parameter.

Parameters:

spatialReference - the spatial reference of the input coordinates in the X Field and Y Field. This will become the spatial refrence of the output feature class. 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