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 data, such as feature datasets, feature classes, rasters, tables, and toolboxes. The Rename tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The output name cannot already exist.
• The data to be renamed should not be open anywhere on the operating system; that is, no other user should be accessing the data. For example, a feature class cannot be renamed if it is open in ArcMap.
• When renaming items with the Rename tool, ancillary files associated with the item are also renamed. For example, the metadata, projection, and index files that may accompany a shapefile will also be renamed.
• Toolboxes; you create can be renamed to something more meaningful.
• This tool allows the renaming of an entire coverage and the region and route subclasses within a coverage.
• When renaming data elements that are the result of one of the overlay commands Identity; Intersect; , or Union; , avoid duplicating item names by taking care not to give the input the same name as one of the geographic datasets used in the Overlay operation. Rename does not check beyond the user ID in the feature attribute table (FAT) to see if items have the same name as # and -ID. See each overlay command for the list of items in the output coverage feature attribute table.
• If your data is stored in a geodatabase in DB2, ESRI recommends you do not rename datasets; doing so will return an error indicating the table can't be renamed due to various DBMS constraints. Learn more about renaming geodatabase table issues in KB article 18001.
• Learn more about Organizing your data;
• The following environment settings affect this tool: Extent; workspace; and scratch workspace;

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 - Data Element, the input dataset or file to be renamed.

outData - Data Element, the new name for the dataset or file.

Method Detail

getInData

public Object getInData()

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

Parameters:

inData - Data Element, the input dataset or file to be renamed.

getOutData

public Object getOutData()

Returns the Output data element parameter of this tool . This parameter is Data Element, the new name for the dataset or file. 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 Data Element, the new name for the dataset or file. This is a required parameter.

Parameters:

outData - Data Element, the new name for the dataset or file.

getDataType

public String getDataType()

Returns the Data type parameter of this tool . This parameter is String, the type of data to be renamed. In the case where a geodatabase contains a feature dataset and a feature class with the same name, it would be necessary to specify the type of data to be renamed. In this case you would enter FeatureDataset or FeatureClass. 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, the type of data to be renamed. In the case where a geodatabase contains a feature dataset and a feature class with the same name, it would be necessary to specify the type of data to be renamed. In this case you would enter FeatureDataset or FeatureClass. This is an optional parameter.

Parameters:

dataType - String, the type of data to be renamed. In the case where a geodatabase contains a feature dataset and a feature class with the same name, it would be necessary to specify the type of data to be renamed. In this case you would enter FeatureDataset or FeatureClass.

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