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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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