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.

Usage tips:

• The Field Map parameter controls how the input fields in the Input Features will be written to the Output Features.
  • To drop fields during the conversion, delete input fields from the Field Map. This will not affect the input feature class.
  • A single output field can be generated from multiple input fields. if a new field is created and the contents of the output field are generated from multiple (differently named) fields.
  • 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.
  • 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 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.
• An SQL expression can be used to select a subset of features. For further details on the syntax for the Expression parameter, see or .

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 - the feature class or feature layer that will be converted.

outPath - 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 - the name of the output feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the feature class or feature layer that will be converted. 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 feature class or feature layer that will be converted. This is a required parameter.

Parameters:

inFeatures - the feature class or feature layer that will be converted.

getOutPath

public Object getOutPath()

Returns the Output Location parameter of this tool . This parameter is 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 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 - 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 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 the name of the output feature class. This is a required parameter.

Parameters:

outName - the name of the output feature class.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is an SQL expression used to select a subset of features. The syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is an SQL expression used to select a subset of features. The syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Parameters:

whereClause - an SQL expression used to select a subset of features. The syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference.

getFieldMapping

public Object getFieldMapping()

Returns the Field Map parameter of this tool . This parameter is the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. 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 subfields, and you can format any output field's values if the data type is text. learn more about choosing and setting the output fields. 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 the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. 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 subfields, and you can format any output field's values if the data type is text. learn more about choosing and setting the output fields. This is an optional parameter.

Parameters:

fieldMapping - the fields and field contents chosen from the inputs. Each of the unique input fields will be listed on the Field Map window and when expanded, you will see a list of all the input field occurrences (subfields). New fields can also be added. 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 subfields, and you can format any output field's values if the data type is text. learn more about choosing and setting the output fields.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is specifies the storage parameters (configuration) for geodatabases in file and ArcSDE geodatabases. Personal geodatabases do not use configuration keywords. 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 specifies the storage parameters (configuration) for geodatabases in file and ArcSDE geodatabases. Personal geodatabases do not use configuration keywords. arcSDE configuration keywords for ArcSDE Enterprise Edition are set up by your database administrator. This is an optional parameter.

Parameters:

configKeyword - specifies the storage parameters (configuration) for geodatabases in file and ArcSDE geodatabases. Personal geodatabases do not use configuration keywords. 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