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

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

All Implemented Interfaces:

GPTool

public class Append
extends AbstractGPTool

Combines an unlimited number of coverages into a single coverage. The Append tool is contained in the Coverage Tools tool box.

Usage tips:

• All Input Coverages to be appended must contain the feature class or set of feature classes and feature attribute tables to be appended. For example, if the NET feature type option is used, all coverages should have line and polygon features, and corresponding AATs and PATs.
• The TOL file with single precision coverages and the PAR file with double precision coverages will not be transformed or retained in the Output Coverage files.
• The of the Output Coverage will default to 0.002 if the width of the BND is between 1 and 100; otherwise, the tolerance is 1/10,000 of the width or height of the BND, whichever is greater.
• The item definitions of the feature attribute tables must be the same and in the same order for all appended coverages (unless the FEATURES_ONLY option is used).
• Using the ROUTE.subclass option is the same as using the ROUTE.subclass and SECTION.subclass options together; that is, both the routes and sections of the specified subclass are appended. If the User-ID of any route is not unique across the coverages being appended, that route will be merged with other routes of the same User-ID. The Output Coverage may, therefore, contain less routes than the total number of routes in the Input Coverages. Append never modifies route measures.
• All polygons in the Input Coverages are appended with the REGION.subclass option, not just those pertaining to the regions being appended. Region subclasses are not maintained with the POLY option; you must also specify REGION.subclass. After combining region subclasses with Append, the new topological relationships between features must be calculated using or . Another way to combine region subclasses is to use . Union calculates topology when combining region subclasses.
• Annotation for each coverage is appended to the Output Coverage. As with all other feature classes, all TATs within a subclass must have identical item definitions.
• The projection file (PRJ) will be copied to the Output Coverage. The first coverage entered will provide the projection information for the Output Coverage.
• The coordinate precision of the Output Coverage is determined by the current processing rule as set by the environment setting. If the processing rule has not been established, then the processing rule will be HIGHEST. This means that Append will create an Output Coverage in the highest precision of the Input Coverages.
• Projection files will be compared for similarity using the level of comparison specified with the environment setting.
• The Feature Type parameter's Add Value button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run or its derived data does not exist, the Feature Type parameter may not be populated with values. The Add Value button allows you to add expected value(s) so you can complete the Append dialog and continue to build your model.

Field Summary

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

vals

Constructor Summary

Append()
Creates the Append tool with defaults.

Append(Object inCovers, Object outCover)
Creates the Append tool with the required parameters.

Method Summary

String	getAppendMethod() Returns the Append Method parameter of this tool .
Object	getFeatureClasses() Returns the Feature Type parameter of this tool .
Object	getInCovers() Returns the Input Coverages parameter of this tool .
String	getNumberMethod() Returns the Create Unique IDs parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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.
void	setAppendMethod(String appendMethod) Sets the Append Method parameter of this tool .
void	setFeatureClasses(Object featureClasses) Sets the Feature Type parameter of this tool .
void	setInCovers(Object inCovers) Sets the Input Coverages parameter of this tool .
void	setNumberMethod(String numberMethod) Sets the Create Unique IDs parameter of this tool .
void	setOutCover(Object outCover) Sets the Output 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

Append

public Append()

Creates the Append tool with defaults.

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

Append

public Append(Object inCovers,
              Object outCover)

Creates the Append 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:

inCovers - the input coverages to be appended. There is no limit to the number of coverages that can be entered.

outCover - the output coverage to be created. The output coverage cannot already exist.

Method Detail

getInCovers

public Object getInCovers()

Returns the Input Coverages parameter of this tool . This parameter is the input coverages to be appended. There is no limit to the number of coverages that can be entered. This is a required parameter.

Returns:

the Input Coverages

setInCovers

public void setInCovers(Object inCovers)

Sets the Input Coverages parameter of this tool . This parameter is the input coverages to be appended. There is no limit to the number of coverages that can be entered. This is a required parameter.

Parameters:

inCovers - the input coverages to be appended. There is no limit to the number of coverages that can be entered.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the output coverage to be created. The output coverage cannot already exist. 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 output coverage to be created. The output coverage cannot already exist. This is a required parameter.

Parameters:

outCover - the output coverage to be created. The output coverage cannot already exist.

getAppendMethod

public String getAppendMethod()

Returns the Append Method parameter of this tool . This parameter is determines whether only coordinates will be appended (FEATURES_ONLY) or if features will also be appended. This is an optional parameter.

Returns:

the Append Method

setAppendMethod

public void setAppendMethod(String appendMethod)

Sets the Append Method parameter of this tool . This parameter is determines whether only coordinates will be appended (FEATURES_ONLY) or if features will also be appended. This is an optional parameter.

Parameters:

appendMethod - determines whether only coordinates will be appended (FEATURES_ONLY) or if features will also be appended.

getFeatureClasses

public Object getFeatureClasses()

Returns the Feature Type parameter of this tool . This parameter is the feature class of the input coverage or coverages. the Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is an optional parameter.

Returns:

the Feature Type

setFeatureClasses

public void setFeatureClasses(Object featureClasses)

Sets the Feature Type parameter of this tool . This parameter is the feature class of the input coverage or coverages. the Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is an optional parameter.

Parameters:

featureClasses - the feature class of the input coverage or coverages. the Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model.

getNumberMethod

public String getNumberMethod()

Returns the Create Unique IDs parameter of this tool . This parameter is specifies how tics and coverage features will be numbered in the Output Coverage. IDs can be offset to ensure unique ID values for Output Coverage features. The ID offset is equal to 1 plus the highest ID value in the previously appended coverages. Offsets can be calculated for the following types of IDs: This is an optional parameter.

Returns:

the Create Unique IDs

setNumberMethod

public void setNumberMethod(String numberMethod)

Sets the Create Unique IDs parameter of this tool . This parameter is specifies how tics and coverage features will be numbered in the Output Coverage. IDs can be offset to ensure unique ID values for Output Coverage features. The ID offset is equal to 1 plus the highest ID value in the previously appended coverages. Offsets can be calculated for the following types of IDs: This is an optional parameter.

Parameters:

numberMethod - specifies how tics and coverage features will be numbered in the Output Coverage. IDs can be offset to ensure unique ID values for Output Coverage features. The ID offset is equal to 1 plus the highest ID value in the previously appended coverages. Offsets can be calculated for the following types of IDs:

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