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

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

All Implemented Interfaces:

GPTool

public class DLGArc
extends AbstractGPTool

Converts a Standard or Optional formatted Digital Line Graph (DLG) file to a coverage. The Import From DLG tool is contained in the Coverage Tools tool box.

Usage tips:

• Topology data contained in the DLG file is ignored. You can use the tool after running Import From DLG, creating topology on the newly created coverage. Sometimes the coverage will have arc intersections and will need to be cleaned using the tool.The feature attribute table NAT is automatically created and does not require an additional build for nodes.
• The Output Coverage may require editing before polygons or lines can be built and feature attribute tables created. For example, checks should be made on the output coverage to ensure that label points occur within their polygons, arcs match at nodes, polygons close, arcs do not cross, and so on.
• Feature numbers in the DLG area (A) records become label point User-IDs for polygons; feature numbers in line (L) records become User-IDs for arcs in the output coverage. The same User-IDs are written to the INFO table output coverage.ACODE and output coverage.PCODE.
• The CODE files, output coverage.ACODE and output coverage.PCODE, hold line attribute codes and polygon attribute codes.
• The DLG feature numbers for node (N) records become User-IDs for nodes in output coverage. There is no corresponding CODE file for node attributes. The User-IDs and attribute codes for node (N) records are stored directly in the output coverage.NAT feature attribute table.
• For the Output Point Coverage, the DLG feature numbers in degenerate (zero-length) line (L) records become User-IDs for points in the Output Point Coverage. An Output Point Coverage.XCODE is created to hold degenerate line (L) attribute codes.
• CODE files for a particular feature class are only created if feature attributes are found in the DLG.
• The fields in the CODE files consist of a Cover-ID, major and Minor fields. The Cover-ID is each feature's unique identifier. MAJOR1 is the first major feature code in the DLG; MINOR1 is the first minor code. There are as many major/minor pairs in the table as the maximum number of pairs for that feature class in the DLG. If no value appears for a particular code, it will be set to -99999.
• Import From DLG writes the projection parameters stored in the DLG file to a projection definition file (PRJ) stored in the output coverage subdirectory.
• DLG header records may contain parameters of a transformation that are used to convert the internal file coordinates to the ground coordinate system. Import From DLG will automatically apply any transformation parameters found in the header records to the feature coordinates and control points (in addition to any specified shift).
• The header records in the DLG file provide information used to determine the tic locations of the output coverages.
• If the fields used to store control point information are blank, Import From DLG will generate tics for the output coverages.
• DLG files usually provide four control points representing the four corners of the map area in the same map coordinate system used to store geographic features. Any transformation or x,y shift applied to the feature coordinates will apply to the control points as well.
• A DLG category is equivalent to a layer.
• Usually, only one category is included in a DLG file; however, some DLGs contain more than one category.
• Categories are listed in DLG header records. Use of the tool's DLG Category parameter enables you to create a set of coverages for other layers or categories contained in the DLG.
• The coordinate precision of the output coverage is determined by the current creation rule. If the precision setting has not yet been established during the current ArcInfo session, then the creation rule will be Single. This means the Import From DLG tool will create an output coverage in single precision. (Coordinate values in DLG files have a format definition of F12.2.)
• can be used to merge each coverage feature attribute table with the DLG code files—INFO table PCODE to Output Coverage.PAT, ACODE with Output Coverage.AAT, and XCODE with Output Point Coverage.PAT.

Field Summary

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

vals

Constructor Summary

DLGArc()
Creates the Import From DLG tool with defaults.

DLGArc(Object inDlgFile, Object outCover)
Creates the Import From DLG tool with the required parameters.

Method Summary

String	getAreaCalculation() Returns the Area Calculation Method parameter of this tool .
String	getCategory() Returns the DLG Category Name parameter of this tool .
Object	getInDlgFile() Returns the Input DLG File parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
Object	getOutPointCover() Returns the Output Point Coverage parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
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.
double	getXShift() Returns the X Shift parameter of this tool .
double	getYShift() Returns the Y Shift parameter of this tool .
void	setAreaCalculation(String areaCalculation) Sets the Area Calculation Method parameter of this tool .
void	setCategory(String category) Sets the DLG Category Name parameter of this tool .
void	setInDlgFile(Object inDlgFile) Sets the Input DLG File parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setOutPointCover(Object outPointCover) Sets the Output Point Coverage parameter of this tool .
void	setXShift(double xShift) Sets the X Shift parameter of this tool .
void	setYShift(double yShift) Sets the Y Shift 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

DLGArc

public DLGArc()

Creates the Import From DLG tool with defaults.

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

DLGArc

public DLGArc(Object inDlgFile,
              Object outCover)

Creates the Import From DLG 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:

inDlgFile - the DLG file to be converted to a coverage.

outCover - the name of the coverage to be created from the DLG data. If the input DLG file contains data produced by the United States Geological Survey (USGS), the output coverage will usually contain line, polygon, and node features created from nondegenerate line (L) records, area (A) records, and node (N) records. An Output Coverage.NAT for node features will be created. this is the only feature attribute table that is created by Import From DLG. an INFO table named Output Coverage.ACODE will be created that contains the major/minor pair values for all line (L) records. Similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records.

Method Detail

getInDlgFile

public Object getInDlgFile()

Returns the Input DLG File parameter of this tool . This parameter is the DLG file to be converted to a coverage. This is a required parameter.

Returns:

the Input DLG File

setInDlgFile

public void setInDlgFile(Object inDlgFile)

Sets the Input DLG File parameter of this tool . This parameter is the DLG file to be converted to a coverage. This is a required parameter.

Parameters:

inDlgFile - the DLG file to be converted to a coverage.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the name of the coverage to be created from the DLG data. If the input DLG file contains data produced by the United States Geological Survey (USGS), the output coverage will usually contain line, polygon, and node features created from nondegenerate line (L) records, area (A) records, and node (N) records. An Output Coverage.NAT for node features will be created. this is the only feature attribute table that is created by Import From DLG. an INFO table named Output Coverage.ACODE will be created that contains the major/minor pair values for all line (L) records. Similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the name of the coverage to be created from the DLG data. If the input DLG file contains data produced by the United States Geological Survey (USGS), the output coverage will usually contain line, polygon, and node features created from nondegenerate line (L) records, area (A) records, and node (N) records. An Output Coverage.NAT for node features will be created. this is the only feature attribute table that is created by Import From DLG. an INFO table named Output Coverage.ACODE will be created that contains the major/minor pair values for all line (L) records. Similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records. This is a required parameter.

Parameters:

outCover - the name of the coverage to be created from the DLG data. If the input DLG file contains data produced by the United States Geological Survey (USGS), the output coverage will usually contain line, polygon, and node features created from nondegenerate line (L) records, area (A) records, and node (N) records. An Output Coverage.NAT for node features will be created. this is the only feature attribute table that is created by Import From DLG. an INFO table named Output Coverage.ACODE will be created that contains the major/minor pair values for all line (L) records. Similarly, an INFO table named Output Coverage.PCODE will store the major/minor codes for area (A) records.

getOutPointCover

public Object getOutPointCover()

Returns the Output Point Coverage parameter of this tool . This parameter is the name of an Optional point coverage to be created from degenerate line (L) records in the DLG. In a DLG, points are stored as zero-length arcs (that is, degenerate lines). these are optionally converted to points by specifying an output point coverage. An INFO table named Output Point Coverage.XCODE will be created, which contains all major and minor code pair values for degenerate line (L) records. no coverage will be created from degenerate line records unless an Output Point Coverage is specified. This is an optional parameter.

Returns:

the Output Point Coverage

setOutPointCover

public void setOutPointCover(Object outPointCover)

Sets the Output Point Coverage parameter of this tool . This parameter is the name of an Optional point coverage to be created from degenerate line (L) records in the DLG. In a DLG, points are stored as zero-length arcs (that is, degenerate lines). these are optionally converted to points by specifying an output point coverage. An INFO table named Output Point Coverage.XCODE will be created, which contains all major and minor code pair values for degenerate line (L) records. no coverage will be created from degenerate line records unless an Output Point Coverage is specified. This is an optional parameter.

Parameters:

outPointCover - the name of an Optional point coverage to be created from degenerate line (L) records in the DLG. In a DLG, points are stored as zero-length arcs (that is, degenerate lines). these are optionally converted to points by specifying an output point coverage. An INFO table named Output Point Coverage.XCODE will be created, which contains all major and minor code pair values for degenerate line (L) records. no coverage will be created from degenerate line records unless an Output Point Coverage is specified.

getAreaCalculation

public String getAreaCalculation()

Returns the Area Calculation Method parameter of this tool . This parameter is determines how the area (A) records are written to the output coverage. This is an optional parameter.

Returns:

the Area Calculation Method

setAreaCalculation

public void setAreaCalculation(String areaCalculation)

Sets the Area Calculation Method parameter of this tool . This parameter is determines how the area (A) records are written to the output coverage. This is an optional parameter.

Parameters:

areaCalculation - determines how the area (A) records are written to the output coverage.

getXShift

public double getXShift()

Returns the X Shift parameter of this tool . This parameter is a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero. This is an optional parameter.

Returns:

the X Shift

setXShift

public void setXShift(double xShift)

Sets the X Shift parameter of this tool . This parameter is a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero. This is an optional parameter.

Parameters:

xShift - a constant value to be added to all x coordinates during DLG conversion. The default X Shift value is zero.

getYShift

public double getYShift()

Returns the Y Shift parameter of this tool . This parameter is a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero. This is an optional parameter.

Returns:

the Y Shift

setYShift

public void setYShift(double yShift)

Sets the Y Shift parameter of this tool . This parameter is a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero. This is an optional parameter.

Parameters:

yShift - a constant value to be added to all y coordinates during DLG conversion. The default Y Shift value is zero.

getCategory

public String getCategory()

Returns the DLG Category Name parameter of this tool . This parameter is the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage. This is an optional parameter.

Returns:

the DLG Category Name

setCategory

public void setCategory(String category)

Sets the DLG Category Name parameter of this tool . This parameter is the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage. This is an optional parameter.

Parameters:

category - the optional name of a specific DLG category to be converted from the DLG file. Only the specified category will be converted if one is given. Otherwise, only the first category in the DLG will be written to the output coverages: output coverage, point coverage.

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