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

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

All Implemented Interfaces:

GPTool

public class CreateFeatureclass
extends AbstractGPTool

Creates an empty feature class in a geodatabase, or shapefile in a folder. The Create Feature Class tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The type of a feature class created depends on the format of the pathname specified: a geodatabase feature class for ArcSDE and personal or file geodatabase pathnames, or a shapefile feature class for a file system folder.
• The Create Feature Class function only creates simple feature classes. Custom feature classes (annotation, dimensions, and so on) can be created in ArcCatalog by right clicking the Geodatabase and selecting the "New..." option.
• A new output shapefile created by the Create Feature Class function will include a field named ID of type integer, unless you provide a template.
• Learn more about Geodatabase items - Spatial index grid size;
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: Extent; M Domain; Configuration Keyword; Coordinate System; Output has M Values; Output Spatial Grid; Output has Z Values; Default Z Value; Output XY Domain; , and Output Z Domain;

Field Summary

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

vals

Constructor Summary

CreateFeatureclass()
Creates the Create Feature Class tool with defaults.

CreateFeatureclass(Object outPath, String outName)
Creates the Create Feature Class tool with the required parameters.

Method Summary

String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
String	getGeometryType() Returns the Geometry Type parameter of this tool .
String	getHasM() Returns the Has M parameter of this tool .
String	getHasZ() Returns the Has Z parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
String	getOutName() Returns the Feature Class Name parameter of this tool .
Object	getOutPath() Returns the Feature Class Location 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 .
Object	getSpatialReference() Returns the Coordinate System parameter of this tool .
Object	getTemplate() Returns the Template Feature Class 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	setGeometryType(String geometryType) Sets the Geometry Type parameter of this tool .
void	setHasM(String hasM) Sets the Has M parameter of this tool .
void	setHasZ(String hasZ) Sets the Has Z parameter of this tool .
void	setOutName(String outName) Sets the Feature Class Name parameter of this tool .
void	setOutPath(Object outPath) Sets the Feature Class Location 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 .
void	setSpatialReference(Object spatialReference) Sets the Coordinate System parameter of this tool .
void	setTemplate(Object template) Sets the Template Feature Class 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

CreateFeatureclass

public CreateFeatureclass()

Creates the Create Feature Class tool with defaults.

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

CreateFeatureclass

public CreateFeatureclass(Object outPath,
                          String outName)

Creates the Create 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:

outPath - Workspace | Feature Dataset, the ArcSDE, personal or file geodatabase, or folder in which the output feature class will be created. This workspace must already exist.

outName - String, the name of the feature class to be created.

Method Detail

getOutPath

public Object getOutPath()

Returns the Feature Class Location parameter of this tool . This parameter is Workspace | Feature Dataset, the ArcSDE, personal or file geodatabase, or folder in which the output feature class will be created. This workspace must already exist. This is a required parameter.

Returns:

the Feature Class Location

setOutPath

public void setOutPath(Object outPath)

Sets the Feature Class Location parameter of this tool . This parameter is Workspace | Feature Dataset, the ArcSDE, personal or file geodatabase, or folder in which the output feature class will be created. This workspace must already exist. This is a required parameter.

Parameters:

outPath - Workspace | Feature Dataset, the ArcSDE, personal or file geodatabase, or folder in which the output feature class will be created. This workspace must already exist.

getOutName

public String getOutName()

Returns the Feature Class Name parameter of this tool . This parameter is String, the name of the feature class to be created. This is a required parameter.

Returns:

the Feature Class Name

setOutName

public void setOutName(String outName)

Sets the Feature Class Name parameter of this tool . This parameter is String, the name of the feature class to be created. This is a required parameter.

Parameters:

outName - String, the name of the feature class to be created.

getGeometryType

public String getGeometryType()

Returns the Geometry Type parameter of this tool . This parameter is String, the geometry type for the input feature class. This is an optional parameter.

Returns:

the Geometry Type

setGeometryType

public void setGeometryType(String geometryType)

Sets the Geometry Type parameter of this tool . This parameter is String, the geometry type for the input feature class. This is an optional parameter.

Parameters:

geometryType - String, the geometry type for the input feature class.

getTemplate

public Object getTemplate()

Returns the Template Feature Class parameter of this tool . This parameter is Feature Layer, the feature class used as a template to define the attribute schema of the output feature class. This is an optional parameter.

Returns:

the Template Feature Class

setTemplate

public void setTemplate(Object template)

Sets the Template Feature Class parameter of this tool . This parameter is Feature Layer, the feature class used as a template to define the attribute schema of the output feature class. This is an optional parameter.

Parameters:

template - Feature Layer, the feature class used as a template to define the attribute schema of the output feature class.

getHasM

public String getHasM()

Returns the Has M parameter of this tool . This parameter is String, determines if the feature class contains linear measurement values (m-values). This is an optional parameter.

Returns:

the Has M

setHasM

public void setHasM(String hasM)

Sets the Has M parameter of this tool . This parameter is String, determines if the feature class contains linear measurement values (m-values). This is an optional parameter.

Parameters:

hasM - String, determines if the feature class contains linear measurement values (m-values).

getHasZ

public String getHasZ()

Returns the Has Z parameter of this tool . This parameter is String, determines if the feature class contains elevation values (z-values). This is an optional parameter.

Returns:

the Has Z

setHasZ

public void setHasZ(String hasZ)

Sets the Has Z parameter of this tool . This parameter is String, determines if the feature class contains elevation values (z-values). This is an optional parameter.

Parameters:

hasZ - String, determines if the feature class contains elevation values (z-values).

getSpatialReference

public Object getSpatialReference()

Returns the Coordinate System parameter of this tool . This parameter is Spatial Reference, the spatial reference of the output feature class. The dialog allows you to pick a coordinate system. If you wish to control other aspects of the spatial reference (ie the xy, z, m domains, resolutions, tolerances) use the relevant environments (click the environments button). If you choose the "Import..." option on the dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used. This is an optional parameter.

Returns:

the Coordinate System

setSpatialReference

public void setSpatialReference(Object spatialReference)

Sets the Coordinate System parameter of this tool . This parameter is Spatial Reference, the spatial reference of the output feature class. The dialog allows you to pick a coordinate system. If you wish to control other aspects of the spatial reference (ie the xy, z, m domains, resolutions, tolerances) use the relevant environments (click the environments button). If you choose the "Import..." option on the dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used. This is an optional parameter.

Parameters:

spatialReference - Spatial Reference, the spatial reference of the output feature class. The dialog allows you to pick a coordinate system. If you wish to control other aspects of the spatial reference (ie the xy, z, m domains, resolutions, tolerances) use the relevant environments (click the environments button). If you choose the "Import..." option on the dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is String, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)ArcSDE only. 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, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)ArcSDE only. This is an optional parameter.

Parameters:

configKeyword - String, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)ArcSDE only.

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.

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