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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.Export

All Implemented Interfaces:

GPTool

public class Export
extends AbstractGPTool

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.

Usage tips:

• When exporting a coverage, all associated INFO tables are written to the interchange file. For example, if the coverage name specified for input data is Forest, an INFO table named Forest.LABEL would be saved in the interchange file. A table named Forest1.LABEL, however, would not be saved in the interchange file.
• Export files created with the Compression type parameter set to FULL can be significantly smaller than export files created with the PARTIAL or NONE options.
• Exporting a grid can result in an export file much larger than the original grid, even when FULL compression is used. This is because each grid cell must be represented in the export file in ASCII format, which is less efficient than the grid's binary format. Also, integer grids are stored in a compressed format, which cannot be maintained in the export file.The best solution is not to export large grids. All ArcInfo platforms that support grids now read the same file format, so exporting is not necessary. To create a single file for transfer, a utility, such as PKZIP (or "tar" on UNIX systems), can be used to place the workspace containing the grid into a single file. Versions of PKZIP and tar are available on both UNIX and PC systems. Warning: Do not PKZIP or tar just the grid, because you'll lose the INFO tables. If you don't want to transfer all the grids in your workspace, create a temporary workspace and copy the grids to be transferred into it.
• Coverages to be exported must not contain edit masks. In other words, do not export an uncleaned cover. Run the or tool to remove edit masks (msk.adf file in the coverage directory).
• Export has a limit of -999999999 on negative User-IDs.
• Export files for coverages with nondefault text alignment will have data loss if imported to a version prior to 8.0.1.
• When exporting text files, the FULL and PARTIAL compression options support line lengths up to 300 characters. Longer line lengths will get truncated. The NONE option supports up to 80 characters per line.

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 - the data type to be exported.

inDataset - the input dataset.

interchangeFile - 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 the data type to be exported. 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 the data type to be exported. This is a required parameter.

Parameters:

featureType - the data type to be exported.

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is 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 the input dataset. This is a required parameter.

Parameters:

inDataset - the input dataset.

getInterchangeFile

public Object getInterchangeFile()

Returns the Output Interchange File parameter of this tool . This parameter is 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 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 - 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 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 specifies how numbers and blanks will be compressed in the export file. There are three options: This is an optional parameter.

Parameters:

compressionType - 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 maximum number of lines for each volume (for example, disk file) of an Export To Interchange File 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 maximum number of lines for each volume (for example, disk file) of an Export To Interchange File 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 - maximum number of lines for each volume (for example, disk file) of an Export To Interchange File 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