com.esri.arcgis.geoprocessing.tools.samples
Class WriteFeaturesToTextFile

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.samples.WriteFeaturesToTextFile

All Implemented Interfaces:

GPTool

public class WriteFeaturesToTextFile
extends AbstractGPTool

Writes feature coordinates to a text file. The Write Features To Text File tool is contained in the Samples tool box.

Usage tips:

• Output from this tool is in the same format as described for the input to the Create Features From Text File tool.
• Output coordinates are space delimited with the decimal separator of your choice.
• Outputs with null values for z or m will have the value 1.#QNAN for those positions.
• Selecting the locale decimal point option will result in the output being separated by whatever the system decimal point is set to. If the system is on a German locale, the output will take the form 1234,5. If the system is on a United States locale, the output will take the form 1234.5
• Selecting the default Python output option will result in the output being separated by whatever Python is using for a decimal point. This is usually a period.
• Point features will be output to the following format:
• Multipoint features will be output to the following format:
• Line features will be output to the following format:
• Polygon features will be output to the following format:
• No environment settings affect this tool.

Field Summary

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

vals

Constructor Summary

WriteFeaturesToTextFile()
Creates the Write Features To Text File tool with defaults.

WriteFeaturesToTextFile(Object inputFeatures, Object outputTextFile, String decimalSeparatorCharacter)
Creates the Write Features To Text File tool with the required parameters.

Method Summary

String	getDecimalSeparatorCharacter() Returns the Decimal Separator Character parameter of this tool .
Object	getInputFeatures() Returns the Input Features parameter of this tool .
Object	getOutputTextFile() Returns the Output Text 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.
void	setDecimalSeparatorCharacter(String decimalSeparatorCharacter) Sets the Decimal Separator Character parameter of this tool .
void	setInputFeatures(Object inputFeatures) Sets the Input Features parameter of this tool .
void	setOutputTextFile(Object outputTextFile) Sets the Output Text File 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

WriteFeaturesToTextFile

public WriteFeaturesToTextFile()

Creates the Write Features To Text File tool with defaults.

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

WriteFeaturesToTextFile

public WriteFeaturesToTextFile(Object inputFeatures,
                               Object outputTextFile,
                               String decimalSeparatorCharacter)

Creates the Write Features To Text File 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:

inputFeatures - null

outputTextFile - null

decimalSeparatorCharacter - null

Method Detail

getInputFeatures

public Object getInputFeatures()

Returns the Input Features parameter of this tool . This is a required parameter.

Returns:

the Input Features

setInputFeatures

public void setInputFeatures(Object inputFeatures)

Sets the Input Features parameter of this tool . This is a required parameter.

Parameters:

inputFeatures - null

getOutputTextFile

public Object getOutputTextFile()

Returns the Output Text File parameter of this tool . This is a required parameter.

Returns:

the Output Text File

setOutputTextFile

public void setOutputTextFile(Object outputTextFile)

Sets the Output Text File parameter of this tool . This is a required parameter.

Parameters:

outputTextFile - null

getDecimalSeparatorCharacter

public String getDecimalSeparatorCharacter()

Returns the Decimal Separator Character parameter of this tool . This is a required parameter.

Returns:

the Decimal Separator Character

setDecimalSeparatorCharacter

public void setDecimalSeparatorCharacter(String decimalSeparatorCharacter)

Sets the Decimal Separator Character parameter of this tool . This is a required parameter.

Parameters:

decimalSeparatorCharacter - null

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