com.esri.arcgis.geoprocessing.tools.coveragetools
Class Export

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

public class Export
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Converts a coverage to an interchange file for transfer to another platform. The Export To Interchange File tool is contained in the Coverage Tools tool box.
Learn more about how Export to Interchange File works

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Export()
          Creates the Export To Interchange File tool with defaults.
Export(String featureType, Object inDataset, Object interchangeFile)
          Creates the Export To Interchange File tool with the required parameters.
 
Method Summary
 String getCompressionType()
          Returns the Compression Type parameter of this tool .
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 Object getInDataset()
          Returns the Input Dataset parameter of this tool .
 Object getInterchangeFile()
          Returns the Output Interchange File parameter of this tool .
 int getMaxLines()
          Returns the Max Lines 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 setCompressionType(String compressionType)
          Sets the Compression Type parameter of this tool .
 void setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setInDataset(Object inDataset)
          Sets the Input Dataset parameter of this tool .
 void setInterchangeFile(Object interchangeFile)
          Sets the Output Interchange File parameter of this tool .
 void setMaxLines(int maxLines)
          Sets the Max Lines 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

Export

public Export()
Creates the Export To Interchange File tool with defaults.

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


Export

public Export(String featureType,
              Object inDataset,
              Object interchangeFile)
Creates the Export To Interchange 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:
featureType - String, the type of input to be converted.
inDataset - Coverage, the input dataset.
interchangeFile - File, the prefix name of the ArcInfo interchange file or files to be created by Export. A volume ID of E00 will be appended to the file name of the first interchange file, E01 to the second file, and so on. Each subsequent file is created when the {max_lines} for each file is reached.
Method Detail

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is String, the type of input to be converted. This is a required parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is String, the type of input to be converted. This is a required parameter.

Parameters:
featureType - String, the type of input to be converted.

getInDataset

public Object getInDataset()
Returns the Input Dataset parameter of this tool . This parameter is Coverage, the input dataset. This is a required parameter.

Returns:
the Input Dataset

setInDataset

public void setInDataset(Object inDataset)
Sets the Input Dataset parameter of this tool . This parameter is Coverage, the input dataset. This is a required parameter.

Parameters:
inDataset - Coverage, the input dataset.

getInterchangeFile

public Object getInterchangeFile()
Returns the Output Interchange File parameter of this tool . This parameter is File, the prefix name of the ArcInfo interchange file or files to be created by Export. A volume ID of E00 will be appended to the file name of the first interchange file, E01 to the second file, and so on. Each subsequent file is created when the {max_lines} for each file is reached. This is a required parameter.

Returns:
the Output Interchange File

setInterchangeFile

public void setInterchangeFile(Object interchangeFile)
Sets the Output Interchange File parameter of this tool . This parameter is File, the prefix name of the ArcInfo interchange file or files to be created by Export. A volume ID of E00 will be appended to the file name of the first interchange file, E01 to the second file, and so on. Each subsequent file is created when the {max_lines} for each file is reached. This is a required parameter.

Parameters:
interchangeFile - File, the prefix name of the ArcInfo interchange file or files to be created by Export. A volume ID of E00 will be appended to the file name of the first interchange file, E01 to the second file, and so on. Each subsequent file is created when the {max_lines} for each file is reached.

getCompressionType

public String getCompressionType()
Returns the Compression Type parameter of this tool . This parameter is String, specifies how numbers and blanks will be compressed in the export file. There are three options: This is an optional parameter.

Returns:
the Compression Type

setCompressionType

public void setCompressionType(String compressionType)
Sets the Compression Type parameter of this tool . This parameter is String, specifies how numbers and blanks will be compressed in the export file. There are three options: This is an optional parameter.

Parameters:
compressionType - String, specifies how numbers and blanks will be compressed in the export file. There are three options:

getMaxLines

public int getMaxLines()
Returns the Max Lines parameter of this tool . This parameter is Long, maximum number of lines for each volume (for example, disk file) of an EXPORT file. A volume has the extension .E00 through .E99. Only one export file is created if this is not specified. This is an optional parameter.

Returns:
the Max Lines

setMaxLines

public void setMaxLines(int maxLines)
Sets the Max Lines parameter of this tool . This parameter is Long, maximum number of lines for each volume (for example, disk file) of an EXPORT file. A volume has the extension .E00 through .E99. Only one export file is created if this is not specified. This is an optional parameter.

Parameters:
maxLines - Long, maximum number of lines for each volume (for example, disk file) of an EXPORT file. A volume has the extension .E00 through .E99. Only one export file is created if this is not specified.

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