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

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

All Implemented Interfaces:

GPTool

public class RemoveJoin
extends AbstractGPTool

Removes a join from a feature layer or table view. The Remove Join tool is contained in the Data Management Tools tool box.

Usage tips:

• The Join name is the name of the table that was joined to the input layer or table view.
• When a layer is joined to two tables and the first join is removed, then both joins will be removed. For example, Layer1 is joined to TableA. Then Layer1 is joined to TableB. If the join to TableA is removed, the join to TableB is also removed.
• This tool is not limited to working within ArcMap; it works on layers and table views in other ArcGIS applications and in scripts. The tool makes a layer from a feature class, and the tool creates a table view from an input table or feature class. The layer or table view can then be used as the input to the Add Join and Remove Join tools.

Field Summary

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

vals

Constructor Summary

RemoveJoin()
Creates the Remove Join tool with defaults.

RemoveJoin(Object inLayerOrView, String joinName)
Creates the Remove Join tool with the required parameters.

Method Summary

Object	getInLayerOrView() Returns the Layer Name or Table View parameter of this tool .
String	getJoinName() Returns the Join 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	setInLayerOrView(Object inLayerOrView) Sets the Layer Name or Table View parameter of this tool .
void	setJoinName(String joinName) Sets the Join 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

RemoveJoin

public RemoveJoin()

Creates the Remove Join tool with defaults.

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

RemoveJoin

public RemoveJoin(Object inLayerOrView,
                  String joinName)

Creates the Remove 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 - the layer or table view from which the join will be removed.

joinName - the join to be removed.

Method Detail

getInLayerOrView

public Object getInLayerOrView()

Returns the Layer Name or Table View parameter of this tool . This parameter is the layer or table view from which the join will be removed. 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 the layer or table view from which the join will be removed. This is a required parameter.

Parameters:

inLayerOrView - the layer or table view from which the join will be removed.

getJoinName

public String getJoinName()

Returns the Join parameter of this tool . This parameter is the join to be removed. This is a required parameter.

Returns:

the Join

setJoinName

public void setJoinName(String joinName)

Sets the Join parameter of this tool . This parameter is the join to be removed. This is a required parameter.

Parameters:

joinName - the join to be removed.

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