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

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

All Implemented Interfaces:

GPTool

public class ClearWorkspaceCache
extends AbstractGPTool

Clears any ArcSDE workspaces from the ArcSDE workspace cache. The Clear Workspace Cache tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool only works with ArcSDE workspaces.
• This tool can be used to help disconnect idle ArcSDE connections in a long-running application.
• If you run the tool without specifying an Input data element, all ArcSDE workspaces in the ArcSDE workspace cache will be cleared. Specify the specific .sde file associated with the workspace you want to clear in order to clear a specific ArcSDE workspace.
• Clearing an ArcSDE workspace from the ArcSDE workspace cache does not guarantee the connection to the ArcSDE server will be disconnected. It will only ensure the geoprocessor object no longer has any hold on the ArcSDE workspace that has been cleared. If any other process has references to this ArcSDE workspace the connection will be maintained.
  • To clear the workspace cache correctly in ArcCatalog: After using this tool in ArcCatalog you will have to navigate to a different folder in the Table of Contents and refresh before the ArcSDE connection will be disconnected.
  • To clear the workspace cache correctly in ArcMap: Remove all references to data in ArcMap that may be accessing the ArcSDE workspace and then run the Clear Workspace Cache tool to ensure the connection is disconnected.
  • To clear the workspace cache correctly in a script: The call to ClearWorkspaceCache() should be the last call in your script making sure to remove all references to any objects that may be pointing to the ArcSDE workspace before making the call to ClearWorkspaceCache().

Field Summary

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

vals

Constructor Summary

ClearWorkspaceCache()
Creates the Clear Workspace Cache tool with defaults.

Method Summary

Object	getInData() Returns the Input Data Element parameter of this tool .
String	getOutResults() Returns the Operation succeeded 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	setInData(Object inData) Sets the Input Data Element 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

ClearWorkspaceCache

public ClearWorkspaceCache()

Creates the Clear Workspace Cache tool with defaults.

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

Method Detail

getInData

public Object getInData()

Returns the Input Data Element parameter of this tool . This parameter is the ArcSDE database connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input parameter will clear all ArcSDE workspaces from the cache. This is an optional parameter.

Returns:

the Input Data Element

setInData

public void setInData(Object inData)

Sets the Input Data Element parameter of this tool . This parameter is the ArcSDE database connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input parameter will clear all ArcSDE workspaces from the cache. This is an optional parameter.

Parameters:

inData - the ArcSDE database connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input parameter will clear all ArcSDE workspaces from the cache.

getOutResults

public String getOutResults()

Returns the Operation succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:

the Operation succeeded

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