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

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

public class SDTSImport
extends AbstractGPTool

Creates ArcGIS coverages or grids from a Spatial Data Transfer Standard (SDTS) Topological Vector Profile (TVP) or Point Profile Transfer. The Import From SDTS tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
SDTSImport()
          Creates the Import From SDTS tool with defaults.
SDTSImport(String inTransferPrefix, Object output)
          Creates the Import From SDTS tool with the required parameters.
 
Method Summary
 String getConvertVoid()
          Returns the Convert void and fill values during raster import parameter of this tool .
 String getDataDictionary()
          Returns the Drop data dictionary parameter of this tool .
 String getInTransferPrefix()
          Returns the Input SDTS Transfer File Prefix parameter of this tool .
 String getLayerName()
          Returns the SDTS Layer parameter of this tool .
 Object getOutPointCover()
          Returns the Output Point Coverage parameter of this tool .
 Object getOutput()
          Returns the Output Coverage or Grid parameter of this tool .
 Object getOutWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 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 setConvertVoid(String convertVoid)
          Sets the Convert void and fill values during raster import parameter of this tool .
 void setDataDictionary(String dataDictionary)
          Sets the Drop data dictionary parameter of this tool .
 void setInTransferPrefix(String inTransferPrefix)
          Sets the Input SDTS Transfer File Prefix parameter of this tool .
 void setLayerName(String layerName)
          Sets the SDTS Layer parameter of this tool .
 void setOutPointCover(Object outPointCover)
          Sets the Output Point Coverage parameter of this tool .
 void setOutput(Object output)
          Sets the Output Coverage or Grid 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

SDTSImport

public SDTSImport()
Creates the Import From SDTS tool with defaults.

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


SDTSImport

public SDTSImport(String inTransferPrefix,
                  Object output)
Creates the Import From 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:
inTransferPrefix - a four-character prefix common to all files in the SDTS transfer. The prefix may include a pathname to a directory. If no directory pathname is given, the files in the transfer will be read from the current workspace.
output - the coverage or grid to be created.
Method Detail

getInTransferPrefix

public String getInTransferPrefix()
Returns the Input SDTS Transfer File Prefix parameter of this tool . This parameter is a four-character prefix common to all files in the SDTS transfer. The prefix may include a pathname to a directory. If no directory pathname is given, the files in the transfer will be read from the current workspace. This is a required parameter.

Returns:
the Input SDTS Transfer File Prefix

setInTransferPrefix

public void setInTransferPrefix(String inTransferPrefix)
Sets the Input SDTS Transfer File Prefix parameter of this tool . This parameter is a four-character prefix common to all files in the SDTS transfer. The prefix may include a pathname to a directory. If no directory pathname is given, the files in the transfer will be read from the current workspace. This is a required parameter.

Parameters:
inTransferPrefix - a four-character prefix common to all files in the SDTS transfer. The prefix may include a pathname to a directory. If no directory pathname is given, the files in the transfer will be read from the current workspace.

getOutput

public Object getOutput()
Returns the Output Coverage or Grid parameter of this tool . This parameter is the coverage or grid to be created. This is a required parameter.

Returns:
the Output Coverage or Grid

setOutput

public void setOutput(Object output)
Sets the Output Coverage or Grid parameter of this tool . This parameter is the coverage or grid to be created. This is a required parameter.

Parameters:
output - the coverage or grid to be created.

getOutPointCover

public Object getOutPointCover()
Returns the Output Point Coverage parameter of this tool . This parameter is the name of an optional point coverage to be created when the Topological Vector Profile is converted. This option is ignored if the SDTS dataset is not the Point Profile Transfer. This is an optional parameter.

Returns:
the Output Point Coverage

setOutPointCover

public void setOutPointCover(Object outPointCover)
Sets the Output Point Coverage parameter of this tool . This parameter is the name of an optional point coverage to be created when the Topological Vector Profile is converted. This option is ignored if the SDTS dataset is not the Point Profile Transfer. This is an optional parameter.

Parameters:
outPointCover - the name of an optional point coverage to be created when the Topological Vector Profile is converted. This option is ignored if the SDTS dataset is not the Point Profile Transfer.

getLayerName

public String getLayerName()
Returns the SDTS Layer parameter of this tool . This parameter is the name of an aggregated spatial object that represents a single data layer in a transfer. There can be multiple layers in a single transfer. By default, the first layer encountered is the only one that will be converted. This is an optional parameter.

Returns:
the SDTS Layer

setLayerName

public void setLayerName(String layerName)
Sets the SDTS Layer parameter of this tool . This parameter is the name of an aggregated spatial object that represents a single data layer in a transfer. There can be multiple layers in a single transfer. By default, the first layer encountered is the only one that will be converted. This is an optional parameter.

Parameters:
layerName - the name of an aggregated spatial object that represents a single data layer in a transfer. There can be multiple layers in a single transfer. By default, the first layer encountered is the only one that will be converted.

getDataDictionary

public String getDataDictionary()
Returns the Drop data dictionary parameter of this tool . This parameter is option to retain or drop the data dictionary. This is an optional parameter.

Returns:
the Drop data dictionary

setDataDictionary

public void setDataDictionary(String dataDictionary)
Sets the Drop data dictionary parameter of this tool . This parameter is option to retain or drop the data dictionary. This is an optional parameter.

Parameters:
dataDictionary - option to retain or drop the data dictionary.

getConvertVoid

public String getConvertVoid()
Returns the Convert void and fill values during raster import parameter of this tool . This parameter is used to convert or preserve void and fill values in the raster transfer. In the raster profile, NULL values are defined in two general categories: (Undefined, not relevant) or (Relevant but unknown or missing). This is an optional parameter.

Returns:
the Convert void and fill values during raster import

setConvertVoid

public void setConvertVoid(String convertVoid)
Sets the Convert void and fill values during raster import parameter of this tool . This parameter is used to convert or preserve void and fill values in the raster transfer. In the raster profile, NULL values are defined in two general categories: (Undefined, not relevant) or (Relevant but unknown or missing). This is an optional parameter.

Parameters:
convertVoid - used to convert or preserve void and fill values in the raster transfer. In the raster profile, NULL values are defined in two general categories: (Undefined, not relevant) or (Relevant but unknown or missing).

getOutWorkspace

public Object getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Workspace

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