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

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

public class VPFImport
extends AbstractGPTool

Converts a VPF table to an INFO table, or converts either an untiled VPF coverage or VPF tile to an ARC/INFO coverage. The Import From VPF 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
VPFImport()
          Creates the Import From VPF tool with defaults.
VPFImport(Object inputVpf, Object output)
          Creates the Import From VPF tool with the required parameters.
 
Method Summary
 Object getControlFile()
          Returns the Conversion Control File parameter of this tool .
 Object getInputVpf()
          Returns the Input VPF Coverage or Table parameter of this tool .
 Object getOutput()
          Returns the Output Coverage or Table parameter of this tool .
 String getStandardVpf()
          Returns the Nonstandard VPF tables will be converted parameter of this tool .
 String getTileName()
          Returns the Tile Name 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 setControlFile(Object controlFile)
          Sets the Conversion Control File parameter of this tool .
 void setInputVpf(Object inputVpf)
          Sets the Input VPF Coverage or Table parameter of this tool .
 void setOutput(Object output)
          Sets the Output Coverage or Table parameter of this tool .
 void setStandardVpf(String standardVpf)
          Sets the Nonstandard VPF tables will be converted parameter of this tool .
 void setTileName(String tileName)
          Sets the Tile Name 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

VPFImport

public VPFImport()
Creates the Import From VPF tool with defaults.

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


VPFImport

public VPFImport(Object inputVpf,
                 Object output)
Creates the Import From VPF 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:
inputVpf - the name of the VPF table, untiled coverage, or tile to be converted. The full pathname must be specified.
output - the output table or coverage to be created.
Method Detail

getInputVpf

public Object getInputVpf()
Returns the Input VPF Coverage or Table parameter of this tool . This parameter is the name of the VPF table, untiled coverage, or tile to be converted. The full pathname must be specified. This is a required parameter.

Returns:
the Input VPF Coverage or Table

setInputVpf

public void setInputVpf(Object inputVpf)
Sets the Input VPF Coverage or Table parameter of this tool . This parameter is the name of the VPF table, untiled coverage, or tile to be converted. The full pathname must be specified. This is a required parameter.

Parameters:
inputVpf - the name of the VPF table, untiled coverage, or tile to be converted. The full pathname must be specified.

getOutput

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

Returns:
the Output Coverage or Table

setOutput

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

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

getTileName

public String getTileName()
Returns the Tile Name parameter of this tool . This parameter is the input VPF tile, if one exists. This is an optional parameter.

Returns:
the Tile Name

setTileName

public void setTileName(String tileName)
Sets the Tile Name parameter of this tool . This parameter is the input VPF tile, if one exists. This is an optional parameter.

Parameters:
tileName - the input VPF tile, if one exists.

getControlFile

public Object getControlFile()
Returns the Conversion Control File parameter of this tool . This parameter is a file that can be used to ignore specific VPF feature classes or three-dimensional coordinates during translation. The name of this file is defined by the user. This is an optional parameter.

Returns:
the Conversion Control File

setControlFile

public void setControlFile(Object controlFile)
Sets the Conversion Control File parameter of this tool . This parameter is a file that can be used to ignore specific VPF feature classes or three-dimensional coordinates during translation. The name of this file is defined by the user. This is an optional parameter.

Parameters:
controlFile - a file that can be used to ignore specific VPF feature classes or three-dimensional coordinates during translation. The name of this file is defined by the user.

getStandardVpf

public String getStandardVpf()
Returns the Nonstandard VPF tables will be converted parameter of this tool . This parameter is specifies whether nonstandard VPF tables will be converted. This is an optional parameter.

Returns:
the Nonstandard VPF tables will be converted

setStandardVpf

public void setStandardVpf(String standardVpf)
Sets the Nonstandard VPF tables will be converted parameter of this tool . This parameter is specifies whether nonstandard VPF tables will be converted. This is an optional parameter.

Parameters:
standardVpf - specifies whether nonstandard VPF tables will be converted.

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