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

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

public class Append
extends AbstractGPTool

Appends multiple input dataset into an already existing target dataset. Input datasets can be point, line or polygon feature classes, tables, rasters or raster catalogs. The Append tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

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 inputs, Object target)
          Creates the Append tool with the required parameters.
 
Method Summary
 Object getFieldMapping()
          Returns the Field Map parameter of this tool .
 Object getInputs()
          Returns the Input Datasets parameter of this tool .
 Object getOutput()
          Returns the Output Features parameter of this tool (Read only).
 String getSchemaType()
          Returns the Schema Type parameter of this tool .
 String getSubtype()
          Returns the Subtype parameter of this tool .
 Object getTarget()
          Returns the Target Dataset 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 setFieldMapping(Object fieldMapping)
          Sets the Field Map parameter of this tool .
 void setInputs(Object inputs)
          Sets the Input Datasets parameter of this tool .
 void setSchemaType(String schemaType)
          Sets the Schema Type parameter of this tool .
 void setSubtype(String subtype)
          Sets the Subtype parameter of this tool .
 void setTarget(Object target)
          Sets the Target Dataset 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 inputs,
              Object target)
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:
inputs - Table View | Raster Layer, the input point, line or polygon featureclasses or tables that will be appended into the target dataset.
target - Table View | Raster Layer, the existing output feature class, table, raster or raster catalog that will contain the appended input features.
Method Detail

getInputs

public Object getInputs()
Returns the Input Datasets parameter of this tool . This parameter is Table View | Raster Layer, the input point, line or polygon featureclasses or tables that will be appended into the target dataset. This is a required parameter.

Returns:
the Input Datasets

setInputs

public void setInputs(Object inputs)
Sets the Input Datasets parameter of this tool . This parameter is Table View | Raster Layer, the input point, line or polygon featureclasses or tables that will be appended into the target dataset. This is a required parameter.

Parameters:
inputs - Table View | Raster Layer, the input point, line or polygon featureclasses or tables that will be appended into the target dataset.

getTarget

public Object getTarget()
Returns the Target Dataset parameter of this tool . This parameter is Table View | Raster Layer, the existing output feature class, table, raster or raster catalog that will contain the appended input features. This is a required parameter.

Returns:
the Target Dataset

setTarget

public void setTarget(Object target)
Sets the Target Dataset parameter of this tool . This parameter is Table View | Raster Layer, the existing output feature class, table, raster or raster catalog that will contain the appended input features. This is a required parameter.

Parameters:
target - Table View | Raster Layer, the existing output feature class, table, raster or raster catalog that will contain the appended input features.

getSchemaType

public String getSchemaType()
Returns the Schema Type parameter of this tool . This parameter is String, specifies how input schemas are transferred to the target feature class. This is an optional parameter.

Returns:
the Schema Type

setSchemaType

public void setSchemaType(String schemaType)
Sets the Schema Type parameter of this tool . This parameter is String, specifies how input schemas are transferred to the target feature class. This is an optional parameter.

Parameters:
schemaType - String, specifies how input schemas are transferred to the target feature class.

getFieldMapping

public Object getFieldMapping()
Returns the Field Map parameter of this tool . This parameter is Field Mapping, this parameter maps field contents from the input datasets to the target dataset. This parameter is only valid when NO_TEST is specified for the schema type. This is an optional parameter.

Returns:
the Field Map

setFieldMapping

public void setFieldMapping(Object fieldMapping)
Sets the Field Map parameter of this tool . This parameter is Field Mapping, this parameter maps field contents from the input datasets to the target dataset. This parameter is only valid when NO_TEST is specified for the schema type. This is an optional parameter.

Parameters:
fieldMapping - Field Mapping, this parameter maps field contents from the input datasets to the target dataset. This parameter is only valid when NO_TEST is specified for the schema type.

getSubtype

public String getSubtype()
Returns the Subtype parameter of this tool . This parameter is string, if subtype is set for a field of the target dataset then all appended features will have the selected subtype value. This is an optional parameter.

Returns:
the Subtype

setSubtype

public void setSubtype(String subtype)
Sets the Subtype parameter of this tool . This parameter is string, if subtype is set for a field of the target dataset then all appended features will have the selected subtype value. This is an optional parameter.

Parameters:
subtype - string, if subtype is set for a field of the target dataset then all appended features will have the selected subtype value.

getOutput

public Object getOutput()
Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Features

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