com.esri.arcgis.geoprocessing.tools.cartographytools
Class DeleteGridsAndGraticules

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.DeleteGridsAndGraticules

All Implemented Interfaces:

GPTool

public class DeleteGridsAndGraticules
extends AbstractGPTool

Deletes all the features associated with one or more selected grid and graticule layers from a feature dataset. The Delete Grids and Graticules tool is contained in the Cartography Tools tool box.

Usage tips:

• You can select all the grid and graticule layers for deletion or specify only the ones you want deleted from the Grid Name list.
• You can unselect all previously selected grid and graticule layers to prevent deletion of any grid and graticule layers or unselect only specific ones not to delete.

Field Summary

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

vals

Constructor Summary

DeleteGridsAndGraticules()
Creates the Delete Grids and Graticules tool with defaults.

DeleteGridsAndGraticules(Object inGridDataset, Object gridName)
Creates the Delete Grids and Graticules tool with the required parameters.

Method Summary

Object	getGridName() Returns the Grid Name parameter of this tool .
Object	getInGridDataset() Returns the Input Grid Dataset parameter of this tool .
Object	getOutGridDataset() Returns the Output Grid Dataset 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	setGridName(Object gridName) Sets the Grid Name parameter of this tool .
void	setInGridDataset(Object inGridDataset) Sets the Input Grid Dataset 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

DeleteGridsAndGraticules

public DeleteGridsAndGraticules()

Creates the Delete Grids and Graticules tool with defaults.

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

DeleteGridsAndGraticules

public DeleteGridsAndGraticules(Object inGridDataset,
                                Object gridName)

Creates the Delete Grids and Graticules 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:

inGridDataset - the feature dataset location where the grid and graticule layers that can be deleted are stored.

gridName - lists the grid and graticule layers in the feature dataset that can be deleted.

Method Detail

getInGridDataset

public Object getInGridDataset()

Returns the Input Grid Dataset parameter of this tool . This parameter is the feature dataset location where the grid and graticule layers that can be deleted are stored. This is a required parameter.

Returns:

the Input Grid Dataset

setInGridDataset

public void setInGridDataset(Object inGridDataset)

Sets the Input Grid Dataset parameter of this tool . This parameter is the feature dataset location where the grid and graticule layers that can be deleted are stored. This is a required parameter.

Parameters:

inGridDataset - the feature dataset location where the grid and graticule layers that can be deleted are stored.

getGridName

public Object getGridName()

Returns the Grid Name parameter of this tool . This parameter is lists the grid and graticule layers in the feature dataset that can be deleted. This is a required parameter.

Returns:

the Grid Name

setGridName

public void setGridName(Object gridName)

Sets the Grid Name parameter of this tool . This parameter is lists the grid and graticule layers in the feature dataset that can be deleted. This is a required parameter.

Parameters:

gridName - lists the grid and graticule layers in the feature dataset that can be deleted.

getOutGridDataset

public Object getOutGridDataset()

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

Returns:

the Output Grid Dataset

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