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

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

public class Merge
extends AbstractGPTool

Combines multiple input datasets of the same data type into a single, new output dataset. This tool can combine point, line, or polygon feature classes or tables. The Merge tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Merge()
          Creates the Merge tool with defaults.
Merge(Object inputs, Object output)
          Creates the Merge tool with the required parameters.
 
Method Summary
 Object getFieldMappings()
          Returns the Field Map parameter of this tool .
 Object getInputs()
          Returns the Input Datasets parameter of this tool .
 Object getOutput()
          Returns the Output 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 setFieldMappings(Object fieldMappings)
          Sets the Field Map parameter of this tool .
 void setInputs(Object inputs)
          Sets the Input Datasets parameter of this tool .
 void setOutput(Object output)
          Sets the Output 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

Merge

public Merge()
Creates the Merge tool with defaults.

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


Merge

public Merge(Object inputs,
             Object output)
Creates the Merge 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 that will be merged together into a new output dataset. Input datasets can be point, line, or polygon feature classes or tables. The data type of all input datasets must match.
output - the output dataset that will contain all combined input datasets.
Method Detail

getInputs

public Object getInputs()
Returns the Input Datasets parameter of this tool . This parameter is the input datasets that will be merged together into a new output dataset. Input datasets can be point, line, or polygon feature classes or tables. The data type of all input datasets must match. 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 that will be merged together into a new output dataset. Input datasets can be point, line, or polygon feature classes or tables. The data type of all input datasets must match. This is a required parameter.

Parameters:
inputs - the input datasets that will be merged together into a new output dataset. Input datasets can be point, line, or polygon feature classes or tables. The data type of all input datasets must match.

getOutput

public Object getOutput()
Returns the Output Dataset parameter of this tool . This parameter is the output dataset that will contain all combined input datasets. This is a required parameter.

Returns:
the Output Dataset

setOutput

public void setOutput(Object output)
Sets the Output Dataset parameter of this tool . This parameter is the output dataset that will contain all combined input datasets. This is a required parameter.

Parameters:
output - the output dataset that will contain all combined input datasets.

getFieldMappings

public Object getFieldMappings()
Returns the Field Map parameter of this tool . This parameter is the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's subfields, and you can format any output field's values if the data type is text. This is an optional parameter.

Returns:
the Field Map

setFieldMappings

public void setFieldMappings(Object fieldMappings)
Sets the Field Map parameter of this tool . This parameter is the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's subfields, and you can format any output field's values if the data type is text. This is an optional parameter.

Parameters:
fieldMappings - the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's subfields, and you can format any output field's values if the data type is text.

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