com.esri.arcgis.geoprocessing.tools.coveragetools
Class JoinItem

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

public class JoinItem
extends AbstractGPTool

Joins the item definitions and values of two tables based on a shared item. Joining involves appending items (fields) of one table to those of another through an attribute or item common to both tables. A join is usually used to attach more attributes to the attribute table of a geographic layer. The Join Info Tables tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
JoinItem()
          Creates the Join Info Tables tool with defaults.
JoinItem(Object inInfoTable, Object joinInfoTable, Object outInfoTable, String relateItem)
          Creates the Join Info Tables tool with the required parameters.
 
Method Summary
 Object getInInfoTable()
          Returns the Input Info Table parameter of this tool .
 Object getJoinInfoTable()
          Returns the Join Info Table parameter of this tool .
 Object getOutInfoTable()
          Returns the Output Info Table parameter of this tool .
 String getRelateItem()
          Returns the Relate Item parameter of this tool .
 String getRelateType()
          Returns the Relate Type parameter of this tool .
 String getStartItem()
          Returns the Start Item 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 setInInfoTable(Object inInfoTable)
          Sets the Input Info Table parameter of this tool .
 void setJoinInfoTable(Object joinInfoTable)
          Sets the Join Info Table parameter of this tool .
 void setOutInfoTable(Object outInfoTable)
          Sets the Output Info Table parameter of this tool .
 void setRelateItem(String relateItem)
          Sets the Relate Item parameter of this tool .
 void setRelateType(String relateType)
          Sets the Relate Type parameter of this tool .
 void setStartItem(String startItem)
          Sets the Start Item 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

JoinItem

public JoinItem()
Creates the Join Info Tables tool with defaults.

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


JoinItem

public JoinItem(Object inInfoTable,
                Object joinInfoTable,
                Object outInfoTable,
                String relateItem)
Creates the Join Info Tables 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:
inInfoTable - the INFO data file to which items and their values are to be added.
joinInfoTable - the INFO data file that contains the items and values to be added.
outInfoTable - the INFO data file produced by Join Info Tables. If Output Info Table already exists, it will be replaced.
relateItem - an item contained in the Input Info Table that is used as an index to records in the Join Info Table. This can be a redefined item.
Method Detail

getInInfoTable

public Object getInInfoTable()
Returns the Input Info Table parameter of this tool . This parameter is the INFO data file to which items and their values are to be added. This is a required parameter.

Returns:
the Input Info Table

setInInfoTable

public void setInInfoTable(Object inInfoTable)
Sets the Input Info Table parameter of this tool . This parameter is the INFO data file to which items and their values are to be added. This is a required parameter.

Parameters:
inInfoTable - the INFO data file to which items and their values are to be added.

getJoinInfoTable

public Object getJoinInfoTable()
Returns the Join Info Table parameter of this tool . This parameter is the INFO data file that contains the items and values to be added. This is a required parameter.

Returns:
the Join Info Table

setJoinInfoTable

public void setJoinInfoTable(Object joinInfoTable)
Sets the Join Info Table parameter of this tool . This parameter is the INFO data file that contains the items and values to be added. This is a required parameter.

Parameters:
joinInfoTable - the INFO data file that contains the items and values to be added.

getOutInfoTable

public Object getOutInfoTable()
Returns the Output Info Table parameter of this tool . This parameter is the INFO data file produced by Join Info Tables. If Output Info Table already exists, it will be replaced. This is a required parameter.

Returns:
the Output Info Table

setOutInfoTable

public void setOutInfoTable(Object outInfoTable)
Sets the Output Info Table parameter of this tool . This parameter is the INFO data file produced by Join Info Tables. If Output Info Table already exists, it will be replaced. This is a required parameter.

Parameters:
outInfoTable - the INFO data file produced by Join Info Tables. If Output Info Table already exists, it will be replaced.

getRelateItem

public String getRelateItem()
Returns the Relate Item parameter of this tool . This parameter is an item contained in the Input Info Table that is used as an index to records in the Join Info Table. This can be a redefined item. This is a required parameter.

Returns:
the Relate Item

setRelateItem

public void setRelateItem(String relateItem)
Sets the Relate Item parameter of this tool . This parameter is an item contained in the Input Info Table that is used as an index to records in the Join Info Table. This can be a redefined item. This is a required parameter.

Parameters:
relateItem - an item contained in the Input Info Table that is used as an index to records in the Join Info Table. This can be a redefined item.

getStartItem

public String getStartItem()
Returns the Start Item parameter of this tool . This parameter is the item in the Input Info Table list after which the Join Info Table items will be inserted. The default Start Item is the last item in the Input Info Table. This is an optional parameter.

Returns:
the Start Item

setStartItem

public void setStartItem(String startItem)
Sets the Start Item parameter of this tool . This parameter is the item in the Input Info Table list after which the Join Info Table items will be inserted. The default Start Item is the last item in the Input Info Table. This is an optional parameter.

Parameters:
startItem - the item in the Input Info Table list after which the Join Info Table items will be inserted. The default Start Item is the last item in the Input Info Table.

getRelateType

public String getRelateType()
Returns the Relate Type parameter of this tool . This parameter is how Join Info Table records are matched to Input Info Table records. This is an optional parameter.

Returns:
the Relate Type

setRelateType

public void setRelateType(String relateType)
Sets the Relate Type parameter of this tool . This parameter is how Join Info Table records are matched to Input Info Table records. This is an optional parameter.

Parameters:
relateType - how Join Info Table records are matched to Input Info Table records.

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