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

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

All Implemented Interfaces:

GPTool

public class TigerTool
extends AbstractGPTool

Converts a set of U.S. Census Bureau TIGER/Line files to a set of ArcInfo coverages. The Advanced Tiger Conversion tool is contained in the Coverage Tools tool box.

Usage tips:

• Advanced Tiger Conversion performs the following conversion and processing tasks:Converts TIGER\line files to coverages.Builds output coverages for line, polygon, and point.Merges line features and creates polygon labels.Provides handling of intersection errors.Copies and relates attribute tables to feature attributes.Optionally joins TIGER attributes to feature attribute tables.Optionally projects to either UTM or State Plane coordinate systems.
• Converts all versions released after April 1989.
• Starting in 2007, the U.S. Census Bureau switched to a shapefile based format. Use the tool on these.
• This tool does not support Record Types F and G released with the 1992 School District version. These are temporary record types, not found in earlier or subsequent versions.
• The output coverages created in the TIGER file conversion will always be in double precision. TIGER/Line files often contain tiny line segments that would be lost if converted to single precision.
• Advanced Tiger Conversion creates up to three output coverages. An ouput point coverage and an output landmark coverage are only created when the dataset contains area point and landmark features.

Field Summary

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

vals

Constructor Summary

TigerTool()
Creates the Advanced Tiger Conversion tool with defaults.

TigerTool(String inTigerFilePrefix, String outCoverPrefix)
Creates the Advanced Tiger Conversion tool with the required parameters.

Method Summary

String	getInTigerFilePrefix() Returns the Input TIGER File Prefix parameter of this tool .
String	getJoinAttributes() Returns the Join attributes parameter of this tool .
String	getOutCoverPrefix() Returns the Output Coverage Prefix parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
String	getProjection() Returns the Projection parameter of this tool .
String	getRestart() Returns the Restart parameter of this tool .
String	getTigerVersion() Returns the TIGER/Line File Version 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.
int	getZoneNumber() Returns the Zone Number parameter of this tool .
void	setInTigerFilePrefix(String inTigerFilePrefix) Sets the Input TIGER File Prefix parameter of this tool .
void	setJoinAttributes(String joinAttributes) Sets the Join attributes parameter of this tool .
void	setOutCoverPrefix(String outCoverPrefix) Sets the Output Coverage Prefix parameter of this tool .
void	setProjection(String projection) Sets the Projection parameter of this tool .
void	setRestart(String restart) Sets the Restart parameter of this tool .
void	setTigerVersion(String tigerVersion) Sets the TIGER/Line File Version parameter of this tool .
void	setZoneNumber(int zoneNumber) Sets the Zone Number 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

TigerTool

public TigerTool()

Creates the Advanced Tiger Conversion tool with defaults.

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

TigerTool

public TigerTool(String inTigerFilePrefix,
                 String outCoverPrefix)

Creates the Advanced Tiger Conversion 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:

inTigerFilePrefix - the filename prefix, common to all files in the set of TIGER/Line files being converted. The prefix may include a directory pathname.

outCoverPrefix - the prefix of the output coverages to be created from the TIGER/Line files.

Method Detail

getInTigerFilePrefix

public String getInTigerFilePrefix()

Returns the Input TIGER File Prefix parameter of this tool . This parameter is the filename prefix, common to all files in the set of TIGER/Line files being converted. The prefix may include a directory pathname. This is a required parameter.

Returns:

the Input TIGER File Prefix

setInTigerFilePrefix

public void setInTigerFilePrefix(String inTigerFilePrefix)

Sets the Input TIGER File Prefix parameter of this tool . This parameter is the filename prefix, common to all files in the set of TIGER/Line files being converted. The prefix may include a directory pathname. This is a required parameter.

Parameters:

inTigerFilePrefix - the filename prefix, common to all files in the set of TIGER/Line files being converted. The prefix may include a directory pathname.

getOutCoverPrefix

public String getOutCoverPrefix()

Returns the Output Coverage Prefix parameter of this tool . This parameter is the prefix of the output coverages to be created from the TIGER/Line files. This is a required parameter.

Returns:

the Output Coverage Prefix

setOutCoverPrefix

public void setOutCoverPrefix(String outCoverPrefix)

Sets the Output Coverage Prefix parameter of this tool . This parameter is the prefix of the output coverages to be created from the TIGER/Line files. This is a required parameter.

Parameters:

outCoverPrefix - the prefix of the output coverages to be created from the TIGER/Line files.

getJoinAttributes

public String getJoinAttributes()

Returns the Join attributes parameter of this tool . This parameter is determines if the basic line, area, and landmark point features will be joined to their feature attribute tables. This is an optional parameter.

Returns:

the Join attributes

setJoinAttributes

public void setJoinAttributes(String joinAttributes)

Sets the Join attributes parameter of this tool . This parameter is determines if the basic line, area, and landmark point features will be joined to their feature attribute tables. This is an optional parameter.

Parameters:

joinAttributes - determines if the basic line, area, and landmark point features will be joined to their feature attribute tables.

getProjection

public String getProjection()

Returns the Projection parameter of this tool . This parameter is the spatial reference of the output coverages. This is an optional parameter.

Returns:

the Projection

setProjection

public void setProjection(String projection)

Sets the Projection parameter of this tool . This parameter is the spatial reference of the output coverages. This is an optional parameter.

Parameters:

projection - the spatial reference of the output coverages.

getZoneNumber

public int getZoneNumber()

Returns the Zone Number parameter of this tool . This parameter is the zone number of the specified coordinate system. This is an optional parameter.

Returns:

the Zone Number

setZoneNumber

public void setZoneNumber(int zoneNumber)

Sets the Zone Number parameter of this tool . This parameter is the zone number of the specified coordinate system. This is an optional parameter.

Parameters:

zoneNumber - the zone number of the specified coordinate system.

getTigerVersion

public String getTigerVersion()

Returns the TIGER/Line File Version parameter of this tool . This parameter is the input TIGER/Line files version. This is an optional parameter.

Returns:

the TIGER/Line File Version

setTigerVersion

public void setTigerVersion(String tigerVersion)

Sets the TIGER/Line File Version parameter of this tool . This parameter is the input TIGER/Line files version. This is an optional parameter.

Parameters:

tigerVersion - the input TIGER/Line files version.

getRestart

public String getRestart()

Returns the Restart parameter of this tool . This parameter is determines whether processing will continue if the TIGER data contains intersection errors. This is an optional parameter.

Returns:

the Restart

setRestart

public void setRestart(String restart)

Sets the Restart parameter of this tool . This parameter is determines whether processing will continue if the TIGER data contains intersection errors. This is an optional parameter.

Parameters:

restart - determines whether processing will continue if the TIGER data contains intersection errors.

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