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

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

public class TigerArc
extends AbstractGPTool

Converts a set of U.S. Bureau of Census TIGER/Line files into one or more ArcInfo coverages. The Basic Tiger Conversion 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
TigerArc()
          Creates the Basic Tiger Conversion tool with defaults.
TigerArc(java.lang.String inTigerFilePrefix, java.lang.Object outCover)
          Creates the Basic Tiger Conversion tool with the required parameters.
 
Method Summary
 java.lang.String getInTigerFilePrefix()
          Returns the Input TIGER File Prefix parameter of this tool .
 java.lang.Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 java.lang.Object getOutLandmarkCover()
          Returns the Output Landmark Coverage parameter of this tool .
 java.lang.Object getOutPointCover()
          Returns the Output Point Coverage parameter of this tool .
 java.lang.Object getOutWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 java.lang.String getTigerVersion()
          Returns the TIGER/Line File Version 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 setInTigerFilePrefix(java.lang.String inTigerFilePrefix)
          Sets the Input TIGER File Prefix parameter of this tool .
 void setOutCover(java.lang.Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setOutLandmarkCover(java.lang.Object outLandmarkCover)
          Sets the Output Landmark Coverage parameter of this tool .
 void setOutPointCover(java.lang.Object outPointCover)
          Sets the Output Point Coverage parameter of this tool .
 void setTigerVersion(java.lang.String tigerVersion)
          Sets the TIGER/Line File Version 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

TigerArc

public TigerArc()
Creates the Basic Tiger Conversion tool with defaults.

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


TigerArc

public TigerArc(java.lang.String inTigerFilePrefix,
                java.lang.Object outCover)
Creates the Basic 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 path.
outCover - the name of the output coverage to be created containing the basic line features and attribute data from the set of TIGER/Line files.
Method Detail

getInTigerFilePrefix

public java.lang.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 path. This is a required parameter.

Returns:
the Input TIGER File Prefix

setInTigerFilePrefix

public void setInTigerFilePrefix(java.lang.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 path. 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 path.

getOutCover

public java.lang.Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the name of the output coverage to be created containing the basic line features and attribute data from the set of TIGER/Line files. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(java.lang.Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is the name of the output coverage to be created containing the basic line features and attribute data from the set of TIGER/Line files. This is a required parameter.

Parameters:
outCover - the name of the output coverage to be created containing the basic line features and attribute data from the set of TIGER/Line files.

getOutPointCover

public java.lang.Object getOutPointCover()
Returns the Output Point Coverage parameter of this tool . This parameter is the name of the output coverage that contains point features that represent polygon label points for polygons in out_cover. 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 the output coverage that contains point features that represent polygon label points for polygons in out_cover. This is an optional parameter.

Parameters:
outPointCover - the name of the output coverage that contains point features that represent polygon label points for polygons in out_cover.

getOutLandmarkCover

public java.lang.Object getOutLandmarkCover()
Returns the Output Landmark Coverage parameter of this tool . This parameter is the name of the output point coverage containing landmark features. This is an optional parameter.

Returns:
the Output Landmark Coverage

setOutLandmarkCover

public void setOutLandmarkCover(java.lang.Object outLandmarkCover)
Sets the Output Landmark Coverage parameter of this tool . This parameter is the name of the output point coverage containing landmark features. This is an optional parameter.

Parameters:
outLandmarkCover - the name of the output point coverage containing landmark features.

getTigerVersion

public java.lang.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(java.lang.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.

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