com.esri.arcgis.geoprocessing.tools.conversiontools
Class FeatureClassToFeatureClass

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.FeatureClassToFeatureClass

All Implemented Interfaces:

GPTool

public class FeatureClassToFeatureClass
extends AbstractGPTool

Converts a shapefile, coverage feature class, or geodatabase feature class to a shapefile or geodatabase feature class. The Feature Class to Feature Class tool is contained in the Conversion Tools tool box.

Software restrictions: none

Usage tips:

• The Copy Features; tool can also be used to convert a shapefile, coverage feature class, or geodatabase (file, personal, or ArcSDE) feature class to a shapefile or geodatabase (file, personal, or ArcSDE) feature class.
• If no SQL expression is entered, all rows will be used. For further details on the syntax for the Expression parameter, see Building an SQL Expression; or SQL Reference;
• To drop fields during the conversion, delete input fields from the Field Map. This will not affect the input table.
• Output fields and their contents can be controlled by the Field Map option;
• The order in which you select fields determines the order in which their values will be displayed in the output field. When joining several input fields into a single output field, the output fields' values will be generated based on the order the input fields were chosen.
• A new output field can be added to the output feature class, composed of user-specified input fields.
• A single output field can be generated from multiple input fields. This happens, if more than one input table contains a field of the same name, or it can happen, if a new field is created and the contents of the output field are generated from multiple (differently named) user-selected fields.
• The first input feature class' fields will appear first as sub fields in the Field Map.
• The data type of an output field will default to the same as the data type of the first input field (of that name) it encounters. The data type may be changed manually at any time to any valid data type. All valid data types will be listed if the tools dialog box is used.
• When using the Merge rule, you can specify your own delimiter such as a space, comma, period, dash, and so on. If you want to use a space, make sure your mouse pointer is at the start of the input box and click the space bar once.
• Concatenation can happen only if the fields chosen are from the same input feature class.
• There are a number of Merge rules available: first, last, join, sum, mean, median, min, max and standard deviation.
• Format options are only available on input fields of type text (and in conjunction with the Join merge rule). You can specify start point, end point, and so on. Format allows you to apply your changes to the selected input field or to apply them to all occurrences of the same input field.
• Standard deviation should not be performed on a single input because values can't be divided by zero, so standard deviation is not a valid option for single inputs. The Merge tool, however, will not fail if standard deviation is chosen for an output field that only has a single input field. In this instance, a value of zero (0) will be entered in the rows of the output field.
• Learn more about how to perform field mapping;
• Learn more about mapping fields in scripts.;
• The configuration keyword specifies the default storage parameters (configurations) for geodatabases in a relational database management system (RDBMS). This setting is applicable only when using ArcSDE. For more on configuration keyword, see CONFIG keyword;
• The following environments affect this tool: configKeyword; extent; MDomain; outputCoordinateSystem; outputMFlag; outputZFlag; scratchWorkspace; spatialGrid1; spatialGrid2; spatialGrid3; workspace; XYDomain; , and ZDomain;

Field Summary

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

vals

Constructor Summary

FeatureClassToFeatureClass()
Creates the Feature Class to Feature Class tool with defaults.

FeatureClassToFeatureClass(Object inFeatures, Object outPath, String outName)
Creates the Feature Class to Feature Class tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
Object	getFieldMapping() Returns the Field Map 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 (Read only).
String	getOutName() Returns the Output Feature Class parameter of this tool .
Object	getOutPath() Returns the Output Location 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.
Object	getWhereClause() Returns the Expression parameter of this tool .
void	setConfigKeyword(String configKeyword) Sets the Configuration Keyword parameter of this tool .
void	setFieldMapping(Object fieldMapping) Sets the Field Map parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutName(String outName) Sets the Output Feature Class parameter of this tool .
void	setOutPath(Object outPath) Sets the Output Location parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression 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

FeatureClassToFeatureClass

public FeatureClassToFeatureClass()

Creates the Feature Class to Feature Class tool with defaults.

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

FeatureClassToFeatureClass

public FeatureClassToFeatureClass(Object inFeatures,
                                  Object outPath,
                                  String outName)

Creates the Feature Class to Feature Class 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 - null

outPath - Workspace | Feature Dataset, the location in which the Output Feature Class will be created. This can be either a geodatabase or a folder. If the Output Location is a folder, the output will be a shapefile.

outName - String, the name of the output feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This is a required parameter.

Parameters:

inFeatures - null

getOutPath

public Object getOutPath()

Returns the Output Location parameter of this tool . This parameter is Workspace | Feature Dataset, the location in which the Output Feature Class will be created. This can be either a geodatabase or a folder. If the Output Location is a folder, the output will be a shapefile. This is a required parameter.

Returns:

the Output Location

setOutPath

public void setOutPath(Object outPath)

Sets the Output Location parameter of this tool . This parameter is Workspace | Feature Dataset, the location in which the Output Feature Class will be created. This can be either a geodatabase or a folder. If the Output Location is a folder, the output will be a shapefile. This is a required parameter.

Parameters:

outPath - Workspace | Feature Dataset, the location in which the Output Feature Class will be created. This can be either a geodatabase or a folder. If the Output Location is a folder, the output will be a shapefile.

getOutName

public String getOutName()

Returns the Output Feature Class parameter of this tool . This parameter is String, the name of the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutName

public void setOutName(String outName)

Sets the Output Feature Class parameter of this tool . This parameter is String, the name of the output feature class. This is a required parameter.

Parameters:

outName - String, the name of the output feature class.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Parameters:

whereClause - SQL Expression, for more information on SQL syntax and how it differs between data sources, see

getFieldMapping

public Object getFieldMapping()

Returns the Field Map parameter of this tool . This parameter is Field Mappings, for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's sub fields, and you can format any output field's values if the data type is text. This is an optional parameter.

Returns:

the Field Map

setFieldMapping

public void setFieldMapping(Object fieldMapping)

Sets the Field Map parameter of this tool . This parameter is Field Mappings, for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's sub fields, and you can format any output field's values if the data type is text. This is an optional parameter.

Parameters:

fieldMapping - Field Mappings, for each Field Map, you can add, rename, or delete output fields as well as set properties such as data type and merge rule. You can also delete an output field's sub fields, and you can format any output field's values if the data type is text.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is String, arcSDE configuration keywords for ArcSDE Enterprise Edition are set up by your database administrator. 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, arcSDE configuration keywords for ArcSDE Enterprise Edition are set up by your database administrator. This is an optional parameter.

Parameters:

configKeyword - String, arcSDE configuration keywords for ArcSDE Enterprise Edition are set up by your database administrator.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output 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