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

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

All Implemented Interfaces:

GPTool

public class Rename
extends AbstractGPTool

Changes the name of all types of data items, among them, feature datasets, rasters, tables, and toolboxes. The Rename tool is contained in the Data Management Tools tool box.

Usage tips:

• The output name must be unique.
• Ancillary files such as the metadata, projection, and index files associated with a shapefile are renamed along with a shapefile. The same applies when renaming a coverage: all region and route subclasses within a coverage are renamed along with it.
• Rename does not rename fields in the dataset. For example, suppose you have a field named ROADS_ID on a feature class named ROADS. Renaming the ROADS feature class to STREETS does not rename the ROADS_ID field to STREETS_ID.
• Do not use the Rename tool to change the data names in a DB2 geodatabase; doing so returns an error indicating the table can't be renamed due to various DBMS constraints.

Field Summary

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

vals

Constructor Summary

Rename()
Creates the Rename tool with defaults.

Rename(Object inData, Object outData)
Creates the Rename 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 .
Object	getOutData() Returns the Output data element parameter of this tool .
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 .
void	setOutData(Object outData) Sets the Output 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

Rename

public Rename()

Creates the Rename tool with defaults.

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

Rename

public Rename(Object inData,
              Object outData)

Creates the Rename 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 item to be renamed.

outData - the name for the output data item.

Method Detail

getInData

public Object getInData()

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

Parameters:

inData - the input data item to be renamed.

getOutData

public Object getOutData()

Returns the Output data element parameter of this tool . This parameter is the name for the output data item. This is a required parameter.

Returns:

the Output data element

setOutData

public void setOutData(Object outData)

Sets the Output data element parameter of this tool . This parameter is the name for the output data item. This is a required parameter.

Parameters:

outData - the name for the output data item.

getDataType

public String getDataType()

Returns the Data type parameter of this tool . This parameter is the type of the data to be renamed. The only time you need to provide a value is when a geodatabase contains a feature dataset and a feature class with the same name. In this case, you need to select the data type (feature dataset or feature class) of the item you want to rename. 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 the type of the data to be renamed. The only time you need to provide a value is when a geodatabase contains a feature dataset and a feature class with the same name. In this case, you need to select the data type (feature dataset or feature class) of the item you want to rename. This is an optional parameter.

Parameters:

dataType - the type of the data to be renamed. The only time you need to provide a value is when a geodatabase contains a feature dataset and a feature class with the same name. In this case, you need to select the data type (feature dataset or feature class) of the item you want to rename.

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