com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class ExportXYv

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.ExportXYv

All Implemented Interfaces:

GPTool

public class ExportXYv
extends AbstractGPTool

Exports feature class coordinates and attribute values to a space, comma, or semi-colon delimited ASCII text file. The Export Feature Attribute to ASCII tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• This tool may be used to export data for analysis with external software packages.
• The X and Y coordinate values are written to the text file with eight significant digits of precision. Floating point attribute values are written to the text file with six significant digits.
• When using shapefiles, keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from non-shapefile inputs may store or interpret null values as zero. This can lead to unexpected results. See also .

Field Summary

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

vals

Constructor Summary

ExportXYv()
Creates the Export Feature Attribute to ASCII tool with defaults.

ExportXYv(Object inputFeatureClass, Object valueField, String delimiter, Object outputAsciiFile)
Creates the Export Feature Attribute to ASCII tool with the required parameters.

Method Summary

String	getDelimiter() Returns the Delimiter parameter of this tool .
Object	getInputFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getOutputAsciiFile() Returns the Output Ascii File 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	getValueField() Returns the Value Field parameter of this tool .
void	setDelimiter(String delimiter) Sets the Delimiter parameter of this tool .
void	setInputFeatureClass(Object inputFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setOutputAsciiFile(Object outputAsciiFile) Sets the Output Ascii File parameter of this tool .
void	setValueField(Object valueField) Sets the Value 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

ExportXYv

public ExportXYv()

Creates the Export Feature Attribute to ASCII tool with defaults.

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

ExportXYv

public ExportXYv(Object inputFeatureClass,
                 Object valueField,
                 String delimiter,
                 Object outputAsciiFile)

Creates the Export Feature Attribute to ASCII 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:

inputFeatureClass - the feature class from which to export feature coordinates and attribute values.

valueField - the field or fields in the input feature class containing the values to export to an ASCII text file.

delimiter - specifies how feature coordinates and attribute values will be separated in the output ASCII file.

outputAsciiFile - the ASCII text file that will contain the feature coordinate and attribute values.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the feature class from which to export feature coordinates and attribute values. This is a required parameter.

Returns:

the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the feature class from which to export feature coordinates and attribute values. This is a required parameter.

Parameters:

inputFeatureClass - the feature class from which to export feature coordinates and attribute values.

getValueField

public Object getValueField()

Returns the Value Field parameter of this tool . This parameter is the field or fields in the input feature class containing the values to export to an ASCII text file. This is a required parameter.

Returns:

the Value Field

setValueField

public void setValueField(Object valueField)

Sets the Value Field parameter of this tool . This parameter is the field or fields in the input feature class containing the values to export to an ASCII text file. This is a required parameter.

Parameters:

valueField - the field or fields in the input feature class containing the values to export to an ASCII text file.

getDelimiter

public String getDelimiter()

Returns the Delimiter parameter of this tool . This parameter is specifies how feature coordinates and attribute values will be separated in the output ASCII file. This is a required parameter.

Returns:

the Delimiter

setDelimiter

public void setDelimiter(String delimiter)

Sets the Delimiter parameter of this tool . This parameter is specifies how feature coordinates and attribute values will be separated in the output ASCII file. This is a required parameter.

Parameters:

delimiter - specifies how feature coordinates and attribute values will be separated in the output ASCII file.

getOutputAsciiFile

public Object getOutputAsciiFile()

Returns the Output Ascii File parameter of this tool . This parameter is the ASCII text file that will contain the feature coordinate and attribute values. This is a required parameter.

Returns:

the Output Ascii File

setOutputAsciiFile

public void setOutputAsciiFile(Object outputAsciiFile)

Sets the Output Ascii File parameter of this tool . This parameter is the ASCII text file that will contain the feature coordinate and attribute values. This is a required parameter.

Parameters:

outputAsciiFile - the ASCII text file that will contain the feature coordinate and attribute values.

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