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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.Copy
All Implemented Interfaces:
GPTool

public class Copy
extends AbstractGPTool

Copies input data and pastes the output to the same or another location regardless of size. The data type of the Input and Output Data Element is identical. The Copy tool is contained in the Data Management Tools tool box.

Usage tips:


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 - the Input Data Element to be copied to the same or another location.
outData - the name of the Output Data Element.
Method Detail

getInData

public Object getInData()
Returns the Input Data Element parameter of this tool . This parameter is the Input Data Element to be copied to the same or another 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 the Input Data Element to be copied to the same or another location. This is a required parameter.

Parameters:
inData - the Input Data Element to be copied to the same or another location.

getOutData

public Object getOutData()
Returns the Output data element parameter of this tool . This parameter is the name of the Output Data Element. 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 of the Output Data Element. This is a required parameter.

Parameters:
outData - the name of the Output Data Element.

getDataType

public String getDataType()
Returns the Data type parameter of this tool . This parameter is the data type of the Input and Output Data Element is identical. This parameter is read-only. 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 data type of the Input and Output Data Element is identical. This parameter is read-only. This is an optional parameter.

Parameters:
dataType - the data type of the Input and Output Data Element is identical. This parameter is read-only.

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