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 datasets into an existing target dataset. Input datasets can be point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes. The Append tool is contained in the Data Management Tools tool box.

Usage tips:

• Use this tool to add new features or other data from mutliple datasets into an existing datasets. This tool can append point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes into an existing dataset of the same type. For example, several tables can be appended to an existing table, or several rasters can be appended to an existing raster dataset, but a line feature class cannot be appended to a point feature class.
• The Append tool's can be used to control how the attribute information from the input dataset fields is transferred to the target dataset. The Field Map control can only be used if the Schema Type NO_TEST is specified.
• This tool will not planarize features when they are added to the target dataset. All features from both the input feature class and the target feature class will remain intact after the append, even if the features overlap. To combine, or planarize feature geometries, use the tool.
• If the Schema Type TEST is specified, the schema (field definitions) of the input datasets must match that of the target dataset in order for the features to be appended. If the Schema Type NO_TEST is specified, input dataset schema (field definitions) do not have to match the target dataset. However, any fields from the input datasets which do not match the fields of the target dataset will not be mapped to the target dataset unless the mapping is explicitly set in the Field Map control.
• Because the input datasets' data is written into an existing target dataset that has a predefined schema (field definitions), the Field Map control does not allow for fields to be added or removed from the target dataset.
• If the spatial references of an input and target feature class do not match, the Append tool will project the features in the input feature class to the coordinate system used by the target feature class.
• This tool does not perform edge matching—there will be no adjustment to the geometry of features.
• Map layers can be used as Input Datasets. If a layer has a selection, only the selected records (features or table rows) are used by the Append tool.
• This tool cannot use multiple input layers with the same name. Although ArcMap allows for the display of layers with the same name, these layers may not be used. To work around this limitation, use the tool dialog browse button to browse for the full paths of each of the Input Datasets.
• To use the Subtype parameter, the target dataset must have a defined subtype field and assigned subtype codes. In the Subtype parameter, provide a subtype description to assign that subtype to all new data that is appended to the target dataset.

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 - the input datasets whose data will be appended into the target dataset. Input datasets can be point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes. Each input dataset must match the data type of the target dataset.

target - the existing dataset that the input datasets' data will be appended into. Each input dataset must match the data type of the target dataset.

Method Detail

getInputs

public Object getInputs()

Returns the Input Datasets parameter of this tool . This parameter is the input datasets whose data will be appended into the target dataset. Input datasets can be point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes. Each input dataset must match the data type of 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 the input datasets whose data will be appended into the target dataset. Input datasets can be point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes. Each input dataset must match the data type of the target dataset. This is a required parameter.

Parameters:

inputs - the input datasets whose data will be appended into the target dataset. Input datasets can be point, line, or polygon feature classes, tables, rasters, raster catalogs, annotation feature classes, or dimensions feature classes. Each input dataset must match the data type of the target dataset.

getTarget

public Object getTarget()

Returns the Target Dataset parameter of this tool . This parameter is the existing dataset that the input datasets' data will be appended into. Each input dataset must match the data type of the target dataset. 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 the existing dataset that the input datasets' data will be appended into. Each input dataset must match the data type of the target dataset. This is a required parameter.

Parameters:

target - the existing dataset that the input datasets' data will be appended into. Each input dataset must match the data type of the target dataset.

getSchemaType

public String getSchemaType()

Returns the Schema Type parameter of this tool . This parameter is specifies if the schema (field definitions) of the input datasets must match the schema of the target dataset in order for data to be appended. 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 specifies if the schema (field definitions) of the input datasets must match the schema of the target dataset in order for data to be appended. This is an optional parameter.

Parameters:

schemaType - specifies if the schema (field definitions) of the input datasets must match the schema of the target dataset in order for data to be appended.

getFieldMapping

public Object getFieldMapping()

Returns the Field Map parameter of this tool . This parameter is controls how the attribute information in input datasets' fields is transferred to the target dataset. The Field Map control can only be used if the Schema Type NO_TEST is specified. because the input datasets' data is appended into an existing target dataset that has a predefined schema (field definitions), the Append tool Field Map control does not allow for fields to be added or removed from the target dataset. 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 controls how the attribute information in input datasets' fields is transferred to the target dataset. The Field Map control can only be used if the Schema Type NO_TEST is specified. because the input datasets' data is appended into an existing target dataset that has a predefined schema (field definitions), the Append tool Field Map control does not allow for fields to be added or removed from the target dataset. This is an optional parameter.

Parameters:

fieldMapping - controls how the attribute information in input datasets' fields is transferred to the target dataset. The Field Map control can only be used if the Schema Type NO_TEST is specified. because the input datasets' data is appended into an existing target dataset that has a predefined schema (field definitions), the Append tool Field Map control does not allow for fields to be added or removed from the target dataset.

getSubtype

public String getSubtype()

Returns the Subtype parameter of this tool . This parameter is a subtype description to assign that subtype to all new data that is appended to the target dataset. This is an optional parameter.

Returns:

the Subtype

setSubtype

public void setSubtype(String subtype)

Sets the Subtype parameter of this tool . This parameter is a subtype description to assign that subtype to all new data that is appended to the target dataset. This is an optional parameter.

Parameters:

subtype - a subtype description to assign that subtype to all new data that is appended to the target dataset.

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