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

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

public class CopyFeatures
extends AbstractGPTool

Copies features from the input The Copy Features tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


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 - Feature Layer | Raster Catalog Layer, the features to be copied.
outFeatureClass - Feature Class, 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 Feature Layer | Raster Catalog Layer, 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 Feature Layer | Raster Catalog Layer, the features to be copied. This is a required parameter.

Parameters:
inFeatures - Feature Layer | Raster Catalog Layer, the features to be copied.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, 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 Feature Class, 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 - Feature Class, 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 String, environment setting. 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 String, environment setting. This is an optional parameter.

Parameters:
configKeyword - String, environment setting.

getSpatialGrid1

public double getSpatialGrid1()
Returns the Output Spatial Grid 1 parameter of this tool . This parameter is Double, the size of the output feature classe's spatial grid index. The following formats support spatial index grids: personal geodatabase, file geodatabase or ArcSDE geodatabase. If this value is left blank (or 0) a valid grid size will be calculated automatically. 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 Double, the size of the output feature classe's spatial grid index. The following formats support spatial index grids: personal geodatabase, file geodatabase or ArcSDE geodatabase. If this value is left blank (or 0) a valid grid size will be calculated automatically. This is an optional parameter.

Parameters:
spatialGrid1 - Double, the size of the output feature classe's spatial grid index. The following formats support spatial index grids: personal geodatabase, file geodatabase or ArcSDE geodatabase. If this value is left blank (or 0) a valid grid size will be calculated automatically.

getSpatialGrid2

public double getSpatialGrid2()
Returns the Output Spatial Grid 2 parameter of this tool . This parameter is Double, the size of the output feature classe's second spatial grid index. This value must be at least 3 times larger than the first index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. For more information, see the Add Spatial Index tool. Note that personal geodatabase support only one spatial index grid. 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 Double, the size of the output feature classe's second spatial grid index. This value must be at least 3 times larger than the first index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. For more information, see the Add Spatial Index tool. Note that personal geodatabase support only one spatial index grid. This is an optional parameter.

Parameters:
spatialGrid2 - Double, the size of the output feature classe's second spatial grid index. This value must be at least 3 times larger than the first index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. For more information, see the Add Spatial Index tool. Note that personal geodatabase support only one spatial index grid.

getSpatialGrid3

public double getSpatialGrid3()
Returns the Output Spatial Grid 3 parameter of this tool . This parameter is Double, the size of the output feature classe's third spatial grid index. This value must be at least 3 times larger than the second index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. Note that personal geodatabase support only one spatial index grid. 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 Double, the size of the output feature classe's third spatial grid index. This value must be at least 3 times larger than the second index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. Note that personal geodatabase support only one spatial index grid. This is an optional parameter.

Parameters:
spatialGrid3 - Double, the size of the output feature classe's third spatial grid index. This value must be at least 3 times larger than the second index grid. The following formats support more than one spatial index grids: file geodatabase or ArcSDE geodatabase. Note that personal geodatabase support only one spatial index grid.

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