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

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

All Implemented Interfaces:

GPTool

public class Build
extends AbstractGPTool

Creates or updates feature attribute tables and polygon topology. Build is also used to synchronize polygon User-IDs with label point User-IDs. The Build tool is contained in the Coverage Tools tool box.

Usage tips:

• Build and are similar commands as they are both used to define coverage topology. The basic difference is that Clean can detect and create intersections but Build cannot. However, since Build does not use a fuzzy tolerance, the coordinates will not be adjusted while topology is being built.
• If a coverage feature attribute table exists, the additional items in the feature attribute table will be updated using the old internal number of each of the features specified as the relate item.
• User-defined items in existing feature attribute tables are always maintained.
• Build uses the routine whenever the NAT is updated. However, unlike a regular Renumber Nodes operation, the coincident nodes are not dissolved; they are preserved. Nodes are renumbered to provide a continuous sequence of node numbers beginning with one.
• If an NAT exists, it will be updated when a build with the POLY or NODE option is used.
• Links are not maintained after Build has been executed.
• When using Build with the POLY option, polygons must have label points to retain their attributes. If there are no attributes, label points are not required to generate a PAT. Polygons containing no label points will be assigned a User-ID of zero.Build does not create polygon labels.
• If you want to assign specific User-IDs, place only one label point in each polygon before running Build. If a polygon contains more than one label point, one is chosen arbitrarily to assign the User-ID.
• If you want the User-IDs to be automatically assigned, use the tool, then add polygon attributes.
• Do not Build a point coverage with the POLY (default) option. User-defined point attributes may be lost.
• Do not Build a polygon coverage with the POINT option. User-defined polygon attributes may be lost.
• Build with the POLY option creates one additional polygon called the background polygon. It is always given polygon internal number 1, and its area is the total sum of the areas of all other polygons in the coverage. It is shown as a negative AREA in the PAT.
• Build with the POLY option maintains and updates the SEC and RAT files of any existing route system in the coverage.
• Once the annotation attribute table (TAT) is created, it never needs to be updated with Build. The TAT created by using Build allows you to store attributes and set up relates to other features.
• Polygon Build will update the SEC with correct ARCLINK# values.
• Internal FNODE# and TNODE# are assigned to each node after a line coverage is built using NODE. The arc end points are sorted by their y coordinates from top to bottom, and equal y by x scanning from left to right. The internal node IDs are assigned in that order.
• Several coverage tools generate connecting arcs having the same Arc-ID, separated by node numbers that are equal to zero (for example, ). When Build is run, it will unsplit these arcs, converting the nodes to vertices. If you want to maintain these arcs as separate arcs, run before performing Build.
• Build requires free disk space several times the size of your Input Coverage to create temporary scratch files. These scratch files are created in your current workspace by default. You may override the default and have the scratch files created in another directory by setting the ARCTMPDIR variable. You must have write access to this directory.
• Build cannot be executed on a region coverage that contains unclosed regions.
• Build will stop execution upon detecting the first unclosed region.
• When creating regions from a line coverage, each arc must form a closed loop that defines a region. Build with the LINE option must be issued before region topology is created with the tool.
• Build with the POLY option adds topology to preliminary regions by creating a .PAT and .PATsubclass. The region subclass must be created first with a previously executed tool (for example, ).
• You may add new arcs that define a region (also closed loops) to a coverage that already has a region subclass. A previously executed tool (for example, Line Coverage To Region) must be used to group the new arcs to form the new subclass for regions. The IDs of the new arcs must be numbered greater than any of the existing arcs. Build them with a new subclass name and new arcs will create a new region subclass.
• Build should not be executed on a coverage if it contains coordinate errors. Errors that could cause problems for Build with the POLY option include intersecting arcs (where no node is defined at the intersection), unclosed polygons, or unmatched nodes and polygon slivers.

Field Summary

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

vals

Constructor Summary

Build()
Creates the Build tool with defaults.

Build(Object inCover, String featureType)
Creates the Build tool with the required parameters.

Method Summary

String	getAnnoSubclass() Returns the Annotation Subclass parameter of this tool .
String	getFeatureType() Returns the Feature Type parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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.
void	setAnnoSubclass(String annoSubclass) Sets the Annotation Subclass parameter of this tool .
void	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage 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

Build

public Build()

Creates the Build tool with defaults.

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

Build

public Build(Object inCover,
             String featureType)

Creates the Build 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 coverage to be built.

featureType - the feature class to be built.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage to be built. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage to be built. This is a required parameter.

Parameters:

inCover - the coverage to be built.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the feature class to be built. This is a required parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is the feature class to be built. This is a required parameter.

Parameters:

featureType - the feature class to be built.

getAnnoSubclass

public String getAnnoSubclass()

Returns the Annotation Subclass parameter of this tool . This parameter is the name of the Annotation Subclass to be built. This is an optional parameter.

Returns:

the Annotation Subclass

setAnnoSubclass

public void setAnnoSubclass(String annoSubclass)

Sets the Annotation Subclass parameter of this tool . This parameter is the name of the Annotation Subclass to be built. This is an optional parameter.

Parameters:

annoSubclass - the name of the Annotation Subclass to be built.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Coverage

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