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

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

public class AddJoin
extends AbstractGPTool

The Add Join tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddJoin()
          Creates the Add Join tool with defaults.
AddJoin(Object inLayerOrView, Object inField, Object joinTable, Object joinField)
          Creates the Add Join tool with the required parameters.
 
Method Summary
 Object getInField()
          Returns the Input Join Field parameter of this tool .
 Object getInLayerOrView()
          Returns the Layer Name or Table View 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 .
 String getJoinType()
          Returns the Keep All 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 setInField(Object inField)
          Sets the Input Join Field parameter of this tool .
 void setInLayerOrView(Object inLayerOrView)
          Sets the Layer Name or Table View 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 .
 void setJoinType(String joinType)
          Sets the Keep All 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

AddJoin

public AddJoin()
Creates the Add Join tool with defaults.

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


AddJoin

public AddJoin(Object inLayerOrView,
               Object inField,
               Object joinTable,
               Object joinField)
Creates the Add Join 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:
inLayerOrView - Table View | Raster Layer, the layer or table view to which the join table will be joined.
inField - Field, the field in the input layer or table view on which the join will be based.
joinTable - Table View | Raster Layer, the table or table view to be joined to the input layer or table view.
joinField - Field, the field in the join table that contains the values on which the join will be based.
Method Detail

getInLayerOrView

public Object getInLayerOrView()
Returns the Layer Name or Table View parameter of this tool . This parameter is Table View | Raster Layer, the layer or table view to which the join table will be joined. This is a required parameter.

Returns:
the Layer Name or Table View

setInLayerOrView

public void setInLayerOrView(Object inLayerOrView)
Sets the Layer Name or Table View parameter of this tool . This parameter is Table View | Raster Layer, the layer or table view to which the join table will be joined. This is a required parameter.

Parameters:
inLayerOrView - Table View | Raster Layer, the layer or table view to which the join table will be joined.

getInField

public Object getInField()
Returns the Input Join Field parameter of this tool . This parameter is Field, the field in the input layer or table view 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 Field, the field in the input layer or table view on which the join will be based. This is a required parameter.

Parameters:
inField - Field, the field in the input layer or table view on which the join will be based.

getJoinTable

public Object getJoinTable()
Returns the Join Table parameter of this tool . This parameter is Table View | Raster Layer, the table or table view to be joined to the input layer or table view. 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 Table View | Raster Layer, the table or table view to be joined to the input layer or table view. This is a required parameter.

Parameters:
joinTable - Table View | Raster Layer, the table or table view to be joined to the input layer or table view.

getJoinField

public Object getJoinField()
Returns the Output Join Field parameter of this tool . This parameter is Field, 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 Field, the field in the join table that contains the values on which the join will be based. This is a required parameter.

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

getJoinType

public String getJoinType()
Returns the Keep All parameter of this tool . This parameter is String, specifies what will be done with records in the input that match a record in the join table. This is an optional parameter.

Returns:
the Keep All

setJoinType

public void setJoinType(String joinType)
Sets the Keep All parameter of this tool . This parameter is String, specifies what will be done with records in the input that match a record in the join table. This is an optional parameter.

Parameters:
joinType - String, specifies what will be done with records in the input that match a record in the join table.

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