com.esri.arcgis.geoprocessing.tools.coveragetools
Class VPFExport
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.coveragetools.VPFExport
- All Implemented Interfaces:
- GPTool
public class VPFExport
- extends AbstractGPTool
Converts a coverage into either a Vector Product Format (VPF) Coverage or VPF Tile.
The Export To VPF tool is contained in the Coverage Tools tool box.
Usage tips:
- The coverage must not have a mask file. Use the tool to remove mask files.
- The coverage must have a projection defined or it will not be converted. The Arc/Info coverage must not have a mask file. Only Clean coverages will export.
- A full VPF pathname must be specified with Output VPF Coverage or Table.
- Pathnames are specified as vpfDatabase\vpfLibrary\vpfCoverage when the Input Coverage or Table type is set to Coverage.
- Pathnames are specified as vpfDatabase\vpfLibrary\vpfTable when the Input Coverage or Table type is set to Table.
- If the vpfDatabase or the vpfLibrary directories do not exist; they will be created.
- The Output VPF tile will be appended to vvpfDatabase\vpfLibrary\vpfCoverage\ specified by the Output VPF Coverage or Table and is only valid when the Input Coverage or Table type is set to Coverage.
- Projections must match between the library and the coverage being created.
- The VPF standard specifies only coverages in geographic coordinates. Using units of Decimal Degrees, on the WGS 1984 datum, you cannot clean a coverage that has units in Decimal Degrees. You should build the coverage in this case, or understand how cleaning will affect your coverage.
- In the default translation of a coverage to a VPF coverage, arcs become edges, polygons become faces, and nodes remain nodes. Feature attribute tables become feature tables with a 1:1 relationship with primitive tables. One exception is the annotation TAT, which becomes one primitive table plus as many feature tables as there are annotation subclasses in the coverage. Route and Section tables become unconnected "extra" tables.Other coverage tables are translated to VPF as extra tables, meaning that the tables are not needed to make up VPF coverages but should be maintained for the VPF to Coverage tool to translate all of the coverage information back to ArcInfo. If there are no VPF tiles, the extra tables are located at the coverage level; otherwise, they are located at the tile level. Extra tables that may be generated by the tool are TIC, SEC, RAT, LNK, TRN, ADD, and ADDRESS.LST. The naming convention is X_TIC, X_SEC, X_RAT, and so on.
Constructor Summary |
VPFExport()
Creates the Export To VPF tool with defaults. |
VPFExport(java.lang.Object inCover,
java.lang.Object outFile)
Creates the Export To VPF tool with the required parameters. |
Method Summary |
java.lang.Object |
getControlFile()
Returns the Conversion Control File parameter of this tool . |
java.lang.Object |
getInCover()
Returns the Input Coverage or Table parameter of this tool . |
java.lang.String |
getIndexTable()
Returns the Create feature index table parameter of this tool . |
java.lang.Object |
getOutFile()
Returns the Output VPF Coverage or Table parameter of this tool . |
java.lang.String |
getStandardTable()
Returns the Nonstandard ArcInfo tables will be converted parameter of this tool . |
java.lang.String |
getTileName()
Returns the Tile Name parameter of this tool . |
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 |
setControlFile(java.lang.Object controlFile)
Sets the Conversion Control File parameter of this tool . |
void |
setInCover(java.lang.Object inCover)
Sets the Input Coverage or Table parameter of this tool . |
void |
setIndexTable(java.lang.String indexTable)
Sets the Create feature index table parameter of this tool . |
void |
setOutFile(java.lang.Object outFile)
Sets the Output VPF Coverage or Table parameter of this tool . |
void |
setStandardTable(java.lang.String standardTable)
Sets the Nonstandard ArcInfo tables will be converted parameter of this tool . |
void |
setTileName(java.lang.String tileName)
Sets the Tile Name parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
VPFExport
public VPFExport()
- Creates the Export To VPF tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
VPFExport
public VPFExport(java.lang.Object inCover,
java.lang.Object outFile)
- Creates the Export To 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:
inCover
- the input coverage that will be converted to VPF format.outFile
- the name of the VPF coverage or table to be created. The full pathname must be specified.
getInCover
public java.lang.Object getInCover()
- Returns the Input Coverage or Table parameter of this tool .
This parameter is the input coverage that will be converted to VPF format.
This is a required parameter.
- Returns:
- the Input Coverage or Table
setInCover
public void setInCover(java.lang.Object inCover)
- Sets the Input Coverage or Table parameter of this tool .
This parameter is the input coverage that will be converted to VPF format.
This is a required parameter.
- Parameters:
inCover
- the input coverage that will be converted to VPF format.
getOutFile
public java.lang.Object getOutFile()
- Returns the Output VPF Coverage or Table parameter of this tool .
This parameter is the name of the VPF coverage or table to be created. The full pathname must be specified.
This is a required parameter.
- Returns:
- the Output VPF Coverage or Table
setOutFile
public void setOutFile(java.lang.Object outFile)
- Sets the Output VPF Coverage or Table parameter of this tool .
This parameter is the name of the VPF coverage or table to be created. The full pathname must be specified.
This is a required parameter.
- Parameters:
outFile
- the name of the VPF coverage or table to be created. The full pathname must be specified.
getTileName
public java.lang.String getTileName()
- Returns the Tile Name parameter of this tool .
This parameter is the name of the VPF tile to be created.
This is an optional parameter.
- Returns:
- the Tile Name
setTileName
public void setTileName(java.lang.String tileName)
- Sets the Tile Name parameter of this tool .
This parameter is the name of the VPF tile to be created.
This is an optional parameter.
- Parameters:
tileName
- the name of the VPF tile to be created.
getControlFile
public java.lang.Object getControlFile()
- Returns the Conversion Control File parameter of this tool .
This parameter is a file that can be used to drop, add, change, or ignore items and other information during translation. The name of this file is defined by the user. Polycov.ccf, poly_cov_con, and conversionfile are all acceptable names. an input coverage defines feature translations for specified feature classes as well as specifies feature classes to be ignored. It can also be used to determine which values are to be filled in the database and library header files at creation.
This is an optional parameter.
- Returns:
- the Conversion Control File
setControlFile
public void setControlFile(java.lang.Object controlFile)
- Sets the Conversion Control File parameter of this tool .
This parameter is a file that can be used to drop, add, change, or ignore items and other information during translation. The name of this file is defined by the user. Polycov.ccf, poly_cov_con, and conversionfile are all acceptable names. an input coverage defines feature translations for specified feature classes as well as specifies feature classes to be ignored. It can also be used to determine which values are to be filled in the database and library header files at creation.
This is an optional parameter.
- Parameters:
controlFile
- a file that can be used to drop, add, change, or ignore items and other information during translation. The name of this file is defined by the user. Polycov.ccf, poly_cov_con, and conversionfile are all acceptable names. an input coverage defines feature translations for specified feature classes as well as specifies feature classes to be ignored. It can also be used to determine which values are to be filled in the database and library header files at creation.
getStandardTable
public java.lang.String getStandardTable()
- Returns the Nonstandard ArcInfo tables will be converted parameter of this tool .
This parameter is specifies whether nonstandard ARC/INFO tables will be converted.
This is an optional parameter.
- Returns:
- the Nonstandard ArcInfo tables will be converted
setStandardTable
public void setStandardTable(java.lang.String standardTable)
- Sets the Nonstandard ArcInfo tables will be converted parameter of this tool .
This parameter is specifies whether nonstandard ARC/INFO tables will be converted.
This is an optional parameter.
- Parameters:
standardTable
- specifies whether nonstandard ARC/INFO tables will be converted.
getIndexTable
public java.lang.String getIndexTable()
- Returns the Create feature index table parameter of this tool .
This parameter is specifies whether to create a feature index table (FIT).
This is an optional parameter.
- Returns:
- the Create feature index table
setIndexTable
public void setIndexTable(java.lang.String indexTable)
- Sets the Create feature index table parameter of this tool .
This parameter is specifies whether to create a feature index table (FIT).
This is an optional parameter.
- Parameters:
indexTable
- specifies whether to create a feature index table (FIT).
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