com.esri.arcgis.geoprocessing.tools.coveragetools
Class SDTSImport
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
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:
- 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 Import From SDTS. The type of profile being converted is automatically determined by the tool.
- Import From SDTS can read the U.S. Bureau of the Census TIGER, U.S. Geological Survey (USGS) DLG-3 vector data, National Geodetic Survey geodetic control point data, and USGS DEM raster data in SDTS format.
- A set of files containing global information about more than one transfer can be external from the transfer but must be under a directory called masterdd located at the same directory level as the transfer directory. If the command is executed from the same directory as the transfer files, specify a path to the prefix so the masterdd is used correctly. For example, ..tvpdata\tr01 would be used as the input prefix if the master data dictionary is at the same level as the tvpdata directory.
- Polygon and line topology is generated for TVP data. Point topology is generated for Point Profile data.
- Complex spatial object modules in a TVP transfer are converted to either regions or route/sections depending on the spatial object type.
- Aggregated spatial object modules or data layers are converted separately by executing Import From SDTS for each layer or raster object record number in the transfer.
- The raster profile provides a flexible way to encode raster data. In a raster transfer, there should be one RSDF module, one LDEF module, and one or more cell modules. Each record in the RSDF module denotes one raster object. Each raster object can have multiple layers. Each layer will be encoded as one record in the LDEF module. The actual grid data is stored in the cell module which is referenced by the layer record. A typical USGS DEM dataset will have one RSDF record, one LDEF record, and one cell file. A typical ERDAS image dataset will have one RSDF record, multiple LDEF records, and one or more cell files.
- Related attribute tables are written to the output dataset.
- The relate environment is stored in Output Dataset.REL and/or Output Point Cover.REL.
- An additional cross reference table, Output Dataset.XREF, will be written to store both the from and to table information for all related attribute tables.
- Attribute tables will be named with either Output Dataset or Output Point Cover prefix and either APxx or ASxx extensions. Region and Route subclasses will be named with FFxx extensions.
- Use the AIDF module when converting an SDTS dataset that was created by the tool. The module contains information on items and redefined items in INFO.
- Information in the CATS module is saved as follows:
Constructor Summary |
SDTSImport()
Creates the Import From SDTS tool with defaults. |
SDTSImport(java.lang.String inTransferPrefix,
java.lang.Object output)
Creates the Import From SDTS tool with the required parameters. |
Method Summary |
java.lang.String |
getConvertVoid()
Returns the Convert void and fill values during raster import parameter of this tool . |
java.lang.String |
getDataDictionary()
Returns the Drop data dictionary parameter of this tool . |
java.lang.String |
getInTransferPrefix()
Returns the Input SDTS Transfer File Prefix parameter of this tool . |
java.lang.String |
getLayerName()
Returns the SDTS Layer parameter of this tool . |
java.lang.Object |
getOutPointCover()
Returns the Output Point Coverage parameter of this tool . |
java.lang.Object |
getOutput()
Returns the Output Coverage or Grid parameter of this tool . |
java.lang.Object |
getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
void |
setConvertVoid(java.lang.String convertVoid)
Sets the Convert void and fill values during raster import parameter of this tool . |
void |
setDataDictionary(java.lang.String dataDictionary)
Sets the Drop data dictionary parameter of this tool . |
void |
setInTransferPrefix(java.lang.String inTransferPrefix)
Sets the Input SDTS Transfer File Prefix parameter of this tool . |
void |
setLayerName(java.lang.String layerName)
Sets the SDTS Layer parameter of this tool . |
void |
setOutPointCover(java.lang.Object outPointCover)
Sets the Output Point Coverage parameter of this tool . |
void |
setOutput(java.lang.Object output)
Sets the Output Coverage or Grid parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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(java.lang.String inTransferPrefix,
java.lang.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.
getInTransferPrefix
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Object getOutWorkspace()
- Returns the Output Workspace parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Output Workspace
getToolName
public java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias