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

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

All Implemented Interfaces:

GPTool

public class CopyFeatures
extends AbstractGPTool

Copies features from the input feature class or layer to a new feature class. If the input is a layer which has a selection, only the selected features will be copied. If the input is a geodatabase feature class or shapefile, all features will be copied. The Copy Features tool is contained in the Data Management Tools tool box.

Usage tips:

• Both the geometry and attributes of the Input Features will be copied to the output feature class.
• This tool can be used for data conversion as it can read many feature formats (any you can add to ArcMap) and write these to shapefile or geodatabase (File, Personal, or ArcSDE).
• If the output feature class already exists, it will be overwritten. To control the overwrite behavior in an application, uncheck Overwrite the outputs of geoprocessing operations option found in Geoprocessing Geoprocessing Options..., or in a script use the OverwriteOutput property on the geoprocessor object. To add or append the Input Features to an existing feature class without overwritting it use the Append tool.

Field Summary

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

vals

Constructor Summary

CopyFeatures()
Creates the Copy Features tool with defaults.

CopyFeatures(Object inFeatures, Object outFeatureClass)
Creates the Copy Features tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getSpatialGrid1() Returns the Output Spatial Grid 1 parameter of this tool .
double	getSpatialGrid2() Returns the Output Spatial Grid 2 parameter of this tool .
double	getSpatialGrid3() Returns the Output Spatial Grid 3 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	setConfigKeyword(String configKeyword) Sets the Configuration Keyword parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSpatialGrid1(double spatialGrid1) Sets the Output Spatial Grid 1 parameter of this tool .
void	setSpatialGrid2(double spatialGrid2) Sets the Output Spatial Grid 2 parameter of this tool .
void	setSpatialGrid3(double spatialGrid3) Sets the Output Spatial Grid 3 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

CopyFeatures

public CopyFeatures()

Creates the Copy Features tool with defaults.

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

CopyFeatures

public CopyFeatures(Object inFeatures,
                    Object outFeatureClass)

Creates the Copy Features 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:

inFeatures - the features to be copied.

outFeatureClass - the feature class which will be created and to which the features will be copied. If the output feature class already exists and the overwrite option is set to true, the output will be deleted first. If the output feature class already exists and the overwrite option is set to false, the operation will fail.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the features to be copied. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the features to be copied. This is a required parameter.

Parameters:

inFeatures - the features to be copied.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class which will be created and to which the features will be copied. If the output feature class already exists and the overwrite option is set to true, the output will be deleted first. If the output feature class already exists and the overwrite option is set to false, the operation will fail. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the feature class which will be created and to which the features will be copied. If the output feature class already exists and the overwrite option is set to true, the output will be deleted first. If the output feature class already exists and the overwrite option is set to false, the operation will fail. This is a required parameter.

Parameters:

outFeatureClass - the feature class which will be created and to which the features will be copied. If the output feature class already exists and the overwrite option is set to true, the output will be deleted first. If the output feature class already exists and the overwrite option is set to false, the operation will fail.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase or file geodatabase. This is an optional parameter.

Returns:

the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)

Sets the Configuration Keyword parameter of this tool . This parameter is geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase or file geodatabase. This is an optional parameter.

Parameters:

configKeyword - geodatabase configuration keyword to be applied if the output is an ArcSDE geodatabase or file geodatabase.

getSpatialGrid1

public double getSpatialGrid1()

Returns the Output Spatial Grid 1 parameter of this tool . This parameter is the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. For more information about this parameter, refer to the Add Spatial Index tool documentation. This is an optional parameter.

Returns:

the Output Spatial Grid 1

setSpatialGrid1

public void setSpatialGrid1(double spatialGrid1)

Sets the Output Spatial Grid 1 parameter of this tool . This parameter is the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. For more information about this parameter, refer to the Add Spatial Index tool documentation. This is an optional parameter.

Parameters:

spatialGrid1 - the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabases and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0 and ArcGIS will compute optimal sizes for you. For more information about this parameter, refer to the Add Spatial Index tool documentation.

getSpatialGrid2

public double getSpatialGrid2()

Returns the Output Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Returns:

the Output Spatial Grid 2

setSpatialGrid2

public void setSpatialGrid2(double spatialGrid2)

Sets the Output Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Parameters:

spatialGrid2 - cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1.

getSpatialGrid3

public double getSpatialGrid3()

Returns the Output Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. This is an optional parameter.

Returns:

the Output Spatial Grid 3

setSpatialGrid3

public void setSpatialGrid3(double spatialGrid3)

Sets the Output Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. This is an optional parameter.

Parameters:

spatialGrid3 - cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2.

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