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

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

All Implemented Interfaces:

GPTool

public class Delete
extends AbstractGPTool

Permanently deletes data from disk. All types of geographic data supported by ArcGIS, as well as toolboxes and workspaces (folders, geodatabases), can be deleted. If the specified item is a workspace, all contained items are also deleted. The Delete tool is contained in the Data Management Tools tool box.

Usage tips:

• Data currently in use in another ArcGIS application cannot be deleted—the tool will fail with ERROR 000464.
• Deleting a shapefile also deletes ancillary files such as the metadata, projection, and index files.
• Deleting a folder moves the folder to the system Recycle Bin, where it can be restored or permanently deleted.
• Deleting a geometric network demotes all the feature classes in the network to simple feature types; Edge feature classes become line feature classes; and junction feature classes become point feature classes. Deleting the network also deletes all the related network tables and the orphan junction feature class from the geodatabase.
• Deleting a database connection file does not delete the ArcSDE database. A database connection file is simply a shortcut to the database.
• Deleting a relationship class deletes the row corresponding to that relationship from the relationship table.

Field Summary

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

vals

Constructor Summary

Delete()
Creates the Delete tool with defaults.

Delete(Object inData)
Creates the Delete tool with the required parameters.

Method Summary

String	getDataType() Returns the Data type parameter of this tool .
Object	getInData() Returns the Input Data Element parameter of this tool .
String	getOutResults() Returns the Delete 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	setDataType(String dataType) Sets the Data type parameter 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

Delete

public Delete()

Creates the Delete tool with defaults.

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

Delete

public Delete(Object inData)

Creates the Delete 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 input data to be deleted.

Method Detail

getInData

public Object getInData()

Returns the Input Data Element parameter of this tool . This parameter is the input data to be deleted. This is a required 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 input data to be deleted. This is a required parameter.

Parameters:

inData - the input data to be deleted.

getDataType

public String getDataType()

Returns the Data type parameter of this tool . This parameter is data type of the Input Data Element. Data type is displayed for informative purposes and cannot be changed. This is an optional parameter.

Returns:

the Data type

setDataType

public void setDataType(String dataType)

Sets the Data type parameter of this tool . This parameter is data type of the Input Data Element. Data type is displayed for informative purposes and cannot be changed. This is an optional parameter.

Parameters:

dataType - data type of the Input Data Element. Data type is displayed for informative purposes and cannot be changed.

getOutResults

public String getOutResults()

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

Returns:

the Delete 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