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

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

• Use Append when you have an existing dataset into which you want to append new data. Input datasets can be point, line or polygon feature classes, tables, rasters or raster catalogs.
• When the inputs are features, all input features must be of the same feature type as the features of the target dataset. For example, if the target feature class contains polygon features, the input features types must be polygon as well.
• Input datasets may overlap one another and/or the target dataset.
• Input datasets in a different coordinate system from the target featureclass will be projected into the coordinate system of the target featureclass.
• Unlike the Union; function, Append does not planarize the input features into a single output. Input features from all the input feature classes remain intact in the target feature class.
• If the TEST option is specified, the field definitions of the feature classes must be the same and in the same order for all appended features.
• If the NO TEST option is selected, input features schemas do not have to match the target feature classes's schema. However, information in the input feature class's fields which do not match the target feature class's schema will not be carried into the target unless the FieldMap parameter is used.
• The Field Map parameter can only be issued if the NO TEST option is selected in the schema type parameter.
• When NO TEST is selected, the Field Map parameter can be used to control the output attribute content of input features. For example, consider the case where both the input and target feature classes have fields containing population information but the name of the fields are different (e.g. pop vs population). If you do not manipulate the FieldMap control features from the input featureclass will get a null value for the population field. Using the FieldMap, you can set the it such that the input features will get their values for the population field from the input pop field. For more information please see the How to Perform Field Mapping; help page.
• Current map layers may be used to define input features. When using layers, only the currently selected features are used in the Append operation.
• Append cannot use multiple input layers; of the same name. Although ArcMap allows for the display of layers with the same name (from different directories) these may not be used in the Append tool. For example, although c:\roads and d:\redlands\roads are two distinct datasets;
• Append does not perform edge matching. There will be no adjustment to the boundaries of features. Edge matching can be performed through ArcMap (or ArcINFO Workstation) only.
• Learn more about working with layers and table views;
• Learn more about using the field map control;
• Learn more about mapping fields in scripts.;
• Learn more about ArcGIS data types;
• The following environment affects this tool: Extent; and workspace;

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