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

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

All Implemented Interfaces:

GPTool

public class SDTSExport
extends AbstractGPTool

Creates a Spatial Data Transfer Standard (SDTS). Topological Vector Profile (TVP). or Point Profile Transfer from an ArcGIS coverage or grid. The Export To SDTS tool is contained in the Coverage Tools tool box.

Usage tips:

• SDTS is a large standard composed of smaller, more limited subsets that are Federally approved as part of the SDTS FIPS 173 standard. These subsets are called profiles. The Topological Vector Profile (designed specifically for planar vector data with topology), Raster, and Point profiles are the only profiles supported by SDTSEXPORT.
• The following conditions must be met when creating a TVP transfer:
  • The coverage must have polygon topology.
  • The coverage cannot have a mask file, only coverages will export.
  • The coverage must have a projection defined or it will not be exported.
• Annotation will be ignored when creating a TVP transfer.

Field Summary

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

vals

Constructor Summary

SDTSExport()
Creates the Export To SDTS tool with defaults.

SDTSExport(String sDTSType, Object inDataset, String outTransferPrefix)
Creates the Export To SDTS tool with the required parameters.

Method Summary

Object	getConvCtrlFile() Returns the Conversion Control File parameter of this tool .
Object	getInDataset() Returns the Input Coverage or Grid parameter of this tool .
Object	getInPointCover() Returns the Point Coverage parameter of this tool .
String	getOutDDTransfer() Returns the Output Data Dictionary Prefix parameter of this tool .
String	getOutTransferPrefix() Returns the Output SDTS Transfer File Prefix parameter of this tool .
String	getSDTSType() Returns the SDTS Format Type 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	setConvCtrlFile(Object convCtrlFile) Sets the Conversion Control File parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Coverage or Grid parameter of this tool .
void	setInPointCover(Object inPointCover) Sets the Point Coverage parameter of this tool .
void	setOutDDTransfer(String outDDTransfer) Sets the Output Data Dictionary Prefix parameter of this tool .
void	setOutTransferPrefix(String outTransferPrefix) Sets the Output SDTS Transfer File Prefix parameter of this tool .
void	setSDTSType(String sDTSType) Sets the SDTS Format Type 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

SDTSExport

public SDTSExport()

Creates the Export To SDTS tool with defaults.

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

SDTSExport

public SDTSExport(String sDTSType,
                  Object inDataset,
                  String outTransferPrefix)

Creates the Export To SDTS 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:

sDTSType - the type of SDTS profile that will be created:

inDataset - the input coverage or grid.

outTransferPrefix - a four-character prefix used to name each file in the transfer. The prefix may include a pathname to a directory. By default, the files in the transfer will be written to the current workspace.

Method Detail

getSDTSType

public String getSDTSType()

Returns the SDTS Format Type parameter of this tool . This parameter is the type of SDTS profile that will be created: This is a required parameter.

Returns:

the SDTS Format Type

setSDTSType

public void setSDTSType(String sDTSType)

Sets the SDTS Format Type parameter of this tool . This parameter is the type of SDTS profile that will be created: This is a required parameter.

Parameters:

sDTSType - the type of SDTS profile that will be created:

getInDataset

public Object getInDataset()

Returns the Input Coverage or Grid parameter of this tool . This parameter is the input coverage or grid. This is a required parameter.

Returns:

the Input Coverage or Grid

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Coverage or Grid parameter of this tool . This parameter is the input coverage or grid. This is a required parameter.

Parameters:

inDataset - the input coverage or grid.

getOutTransferPrefix

public String getOutTransferPrefix()

Returns the Output SDTS Transfer File Prefix parameter of this tool . This parameter is a four-character prefix used to name each file in the transfer. The prefix may include a pathname to a directory. By default, the files in the transfer will be written to the current workspace. This is a required parameter.

Returns:

the Output SDTS Transfer File Prefix

setOutTransferPrefix

public void setOutTransferPrefix(String outTransferPrefix)

Sets the Output SDTS Transfer File Prefix parameter of this tool . This parameter is a four-character prefix used to name each file in the transfer. The prefix may include a pathname to a directory. By default, the files in the transfer will be written to the current workspace. This is a required parameter.

Parameters:

outTransferPrefix - a four-character prefix used to name each file in the transfer. The prefix may include a pathname to a directory. By default, the files in the transfer will be written to the current workspace.

getInPointCover

public Object getInPointCover()

Returns the Point Coverage parameter of this tool . This parameter is the name of the Point Coverage to be converted when the transfer type is TVP. This option will be ignored if the transfer type is set to POINT. This is an optional parameter.

Returns:

the Point Coverage

setInPointCover

public void setInPointCover(Object inPointCover)

Sets the Point Coverage parameter of this tool . This parameter is the name of the Point Coverage to be converted when the transfer type is TVP. This option will be ignored if the transfer type is set to POINT. This is an optional parameter.

Parameters:

inPointCover - the name of the Point Coverage to be converted when the transfer type is TVP. This option will be ignored if the transfer type is set to POINT.

getOutDDTransfer

public String getOutDDTransfer()

Returns the Output Data Dictionary Prefix parameter of this tool . This parameter is a four-character prefix for the Master Data Dictionary. A directory named MASTERDD will be created at the same directory level as the Out Transfer directory. This option is used for creating a single master data dictionary for coverages or grids that share a common data dictionary. This is an optional parameter.

Returns:

the Output Data Dictionary Prefix

setOutDDTransfer

public void setOutDDTransfer(String outDDTransfer)

Sets the Output Data Dictionary Prefix parameter of this tool . This parameter is a four-character prefix for the Master Data Dictionary. A directory named MASTERDD will be created at the same directory level as the Out Transfer directory. This option is used for creating a single master data dictionary for coverages or grids that share a common data dictionary. This is an optional parameter.

Parameters:

outDDTransfer - a four-character prefix for the Master Data Dictionary. A directory named MASTERDD will be created at the same directory level as the Out Transfer directory. This option is used for creating a single master data dictionary for coverages or grids that share a common data dictionary.

getConvCtrlFile

public Object getConvCtrlFile()

Returns the Conversion Control File parameter of this tool . This parameter is a file that can be used to add information during translation. The name of this file is defined by the user. This is an optional parameter.

Returns:

the Conversion Control File

setConvCtrlFile

public void setConvCtrlFile(Object convCtrlFile)

Sets the Conversion Control File parameter of this tool . This parameter is a file that can be used to add information during translation. The name of this file is defined by the user. This is an optional parameter.

Parameters:

convCtrlFile - a file that can be used to add information during translation. The name of this file is defined by the user.

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