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

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

All Implemented Interfaces:

GPTool

public class Copy
extends AbstractGPTool

Copies input data from one location and pastes it to another location. You can copy entire feature datasets or individual feature classes and tables. The Copy tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The input and the output of Copy will be the same data type. Therefore, if the input type is a shapefile, the output type will also be shapefile. Be sure the output workspace supports the output data type. For example, do not try to copy a shapefile into a geodatabase.
• When using the Copy tool, any data dependent on the input is also copied. For example when copying a feature class or table that is a part of a relationship class, the relationship class, along with the feature class or table to which it relates, is also copied. The same is true for a feature class that has feature-linked annotation, the feature-linked annotation is also copied. When present, domains, subtypes and indexes will be copied along with a feature class.
• To copy a geometric network or a topology class and all the participating feature classes, copy and paste the network or topology class only. This will copy all participating feature classes as well.
• If a feature class is copied to an existing feature dataset, the spatial reference; of the feature class and the feature dataset must match. If the spatial references do not match the copy will fail.
• The following environment settings affect this tool: workspace; and scratch workspace; CONFIG keyword;

Field Summary

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

vals

Constructor Summary

Copy()
Creates the Copy tool with defaults.

Copy(Object inData, Object outData)
Creates the Copy 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

Copy

public Copy()

Creates the Copy tool with defaults.

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

Copy

public Copy(Object inData,
            Object outData)

Creates the Copy 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 data element to be copied to the new location.

outData - Data Element, the name of the new output data element to be created.

Method Detail

getInData

public Object getInData()

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

Parameters:

inData - Data Element, the input data element to be copied to the new location.

getOutData

public Object getOutData()

Returns the Output data element parameter of this tool . This parameter is Data Element, the name of the new output data element to be created. 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 name of the new output data element to be created. This is a required parameter.

Parameters:

outData - Data Element, the name of the new output data element to be created.

getDataType

public String getDataType()

Returns the Data type parameter of this tool . This parameter is String, this is the type of data being copied. 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 copied. 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 copied. 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 copied. 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 copied. 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 copied. You would need to specify feature dataset or 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