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 including data types such as The Delete tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The data to be deleted should not be open anywhere on the operating system; that is, no other user should have the file open. For example, a feature class cannot be deleted if it is open in ArcMap.
• When deleting items with the Delete tool, ancillary files associated with the item are also deleted. For example the metadata, projection, and index files that may accompany a shapefile will be deleted if the shapefile is deleted.
• If a relationship class is deleted, the row corresponding to that relationship is deleted from the relationship table. Learn more about editing relationships and related objects;
• If a geometric network is deleted, all the feature classes in the network are demoted to simple feature types. Edge feature classes become line feature classes, and junction feature classes become point feature classes. Deleting the network will also delete all the related network tables and the orphan junction feature class from the geodatabase.
• When a database connection is deleted the database and its contents remain in tact, only the connection information is deleted. Similarly, deleting a shortcut has no effect on its target. However, if a personal or file geodatabase is deleted, the Access database file and all the data it contains is deleted.
• Toolboxes can be deleted using the Delete tool.
• Learn more about deleting and removing toolboxes;
• Learn more about organizing your data;
• The environment settings do not affect this tool.

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 - Data Element | Layer, the input data to be deleted.

Method Detail

getInData

public Object getInData()

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

Parameters:

inData - Data Element | Layer, the input data to be deleted.

getDataType

public String getDataType()

Returns the Data type parameter of this tool . This parameter is String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class. 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 String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class. This is an optional parameter.

Parameters:

dataType - String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class.

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