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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.JoinField

All Implemented Interfaces:

GPTool

public class JoinField
extends AbstractGPTool

Joins the contents of a table to another table based on a common attribute field. The input table is updated to contain the fields from the join table. You can select which fields from the join table will be added to the input table. The Join Field tool is contained in the Data Management Tools tool box.

Usage tips:

• All fields in the Input Table will be kept during the join. Optionally, only selected fields from the Join Table will be added to the output. These can be checked under the Join Fields parameter.
• If no fields are selected for the optional Join Fields parameter, all fields from the Join Table to the output will be joined.
• The Input Table can be a feature class, table, or shapefile.
• Records from the Join Table can be matched to more than one record in the Input Table.
• Joins can be based on fields of types text, date, or number.
• Joins based on text fields are case-sensitive.
• Fields of different number can be joined as long as the values are equal. For example, a field of type float can be joined to a short integer field.
• The Input Join Field and the Output Join Field can have different names.
• If a join field has the same name as a field from the input table, the joined field will be appended by _1 (or _2 or _3, and so on) to make it unique.
• If values in the Output Join Field are not unique, only the first occurrence of each value will be used.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

JoinField()
Creates the Join Field tool with defaults.

JoinField(Object inData, Object inField, Object joinTable, Object joinField)
Creates the Join Field tool with the required parameters.

Method Summary

Object	getFields() Returns the Join Fields parameter of this tool .
Object	getInData() Returns the Input Table parameter of this tool .
Object	getInField() Returns the Input Join Field parameter of this tool .
Object	getJoinField() Returns the Output Join Field parameter of this tool .
Object	getJoinTable() Returns the Join Table parameter of this tool .
Object	getOutLayerOrView() Returns the Output Layer Name parameter of this tool (Read only).
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	setFields(Object fields) Sets the Join Fields parameter of this tool .
void	setInData(Object inData) Sets the Input Table parameter of this tool .
void	setInField(Object inField) Sets the Input Join Field parameter of this tool .
void	setJoinField(Object joinField) Sets the Output Join Field parameter of this tool .
void	setJoinTable(Object joinTable) Sets the Join Table 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

JoinField

public JoinField()

Creates the Join Field tool with defaults.

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

JoinField

public JoinField(Object inData,
                 Object inField,
                 Object joinTable,
                 Object joinField)

Creates the Join Field 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:

inData - the table or feature class to which the join table will be joined.

inField - the field in the input table on which the join will be based.

joinTable - the table to be joined to the input table.

joinField - the field in the join table that contains the values on which the join will be based.

Method Detail

getInData

public Object getInData()

Returns the Input Table parameter of this tool . This parameter is the table or feature class to which the join table will be joined. This is a required parameter.

Returns:

the Input Table

setInData

public void setInData(Object inData)

Sets the Input Table parameter of this tool . This parameter is the table or feature class to which the join table will be joined. This is a required parameter.

Parameters:

inData - the table or feature class to which the join table will be joined.

getInField

public Object getInField()

Returns the Input Join Field parameter of this tool . This parameter is the field in the input table on which the join will be based. This is a required parameter.

Returns:

the Input Join Field

setInField

public void setInField(Object inField)

Sets the Input Join Field parameter of this tool . This parameter is the field in the input table on which the join will be based. This is a required parameter.

Parameters:

inField - the field in the input table on which the join will be based.

getJoinTable

public Object getJoinTable()

Returns the Join Table parameter of this tool . This parameter is the table to be joined to the input table. This is a required parameter.

Returns:

the Join Table

setJoinTable

public void setJoinTable(Object joinTable)

Sets the Join Table parameter of this tool . This parameter is the table to be joined to the input table. This is a required parameter.

Parameters:

joinTable - the table to be joined to the input table.

getJoinField

public Object getJoinField()

Returns the Output Join Field parameter of this tool . This parameter is the field in the join table that contains the values on which the join will be based. This is a required parameter.

Returns:

the Output Join Field

setJoinField

public void setJoinField(Object joinField)

Sets the Output Join Field parameter of this tool . This parameter is the field in the join table that contains the values on which the join will be based. This is a required parameter.

Parameters:

joinField - the field in the join table that contains the values on which the join will be based.

getFields

public Object getFields()

Returns the Join Fields parameter of this tool . This parameter is the fields from the join table to be included in the join. This is an optional parameter.

Returns:

the Join Fields

setFields

public void setFields(Object fields)

Sets the Join Fields parameter of this tool . This parameter is the fields from the join table to be included in the join. This is an optional parameter.

Parameters:

fields - the fields from the join table to be included in the join.

getOutLayerOrView

public Object getOutLayerOrView()

Returns the Output Layer Name parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Layer Name

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