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

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

All Implemented Interfaces:

GPTool

public class DeleteFeatures
extends AbstractGPTool

Deletes features from the input feature class or layer. If the input is a layer with a selection, only the selected features will be deleted. If the input is a geodatabase feature class or shapefile, all features will be deleted. The Delete Features tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool accepts layers with selections as input, and will delete only those features that are selected. To delete specific features from a feature class, convert the feature class into a layer using or by adding it to the ArcMap display. A selection can then be applied using the or tools or by querying a map layer or selecting features with the selection arrow in ArcMap.
• This tool deletes both the geometry and attributes of the Input Features.
• When working in ArcMap, using this tool in an edit session will allow for the Delete Features operation to be undone using undo/redo.
• If you want to delete all features from a feature class, use this tool on a feature class or a layer without a selection.
• If you want to delete all features from an ArcSDE feature class, use this tool against the ArcSDE feature class (not a layer) without a selection in order to perform a database truncate rather than a row by row deletion of features to delete all the features. The database truncate operation is much faster when deleting all the features in a feature class.

Field Summary

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

vals

Constructor Summary

DeleteFeatures()
Creates the Delete Features tool with defaults.

DeleteFeatures(Object inFeatures)
Creates the Delete Features tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class 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	setInFeatures(Object inFeatures) Sets the Input Features 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

DeleteFeatures

public DeleteFeatures()

Creates the Delete Features tool with defaults.

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

DeleteFeatures

public DeleteFeatures(Object inFeatures)

Creates the Delete Features 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:

inFeatures - the feature class, shapefile, or layer containing features to be deleted.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the feature class, shapefile, or layer containing features to be deleted. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the feature class, shapefile, or layer containing features to be deleted. This is a required parameter.

Parameters:

inFeatures - the feature class, shapefile, or layer containing features to be deleted.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Feature Class

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