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 an ArcSDE, file, or personal geodatabase; in a folder it creates a shapefile. The Create Feature Class tool is contained in the Data Management Tools tool box.

Usage tips:

• The Output Location (geodatabase or folder) must already exist.
• This tool creates only simple feature classes such as point, multipoint, polygon, and polyline. Custom feature classes such as annotation, dimensions, and relationship class are created in the Catalog window or in ArcCatalog by right-clicking a Geodatabase and selecting the New...
• A shapefile created by this tool has a field named ID of type integer. The ID field is not created when you provide a Template Feature Class.

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 - the ArcSDE, file, or personal geodatabase, or the folder in which the output feature class will be created. This workspace must already exist.

outName - 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 the ArcSDE, file, or personal geodatabase, or the 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 the ArcSDE, file, or personal geodatabase, or the folder in which the output feature class will be created. This workspace must already exist. This is a required parameter.

Parameters:

outPath - the ArcSDE, file, or personal geodatabase, or the 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 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 the name of the feature class to be created. This is a required parameter.

Parameters:

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

getGeometryType

public String getGeometryType()

Returns the Geometry Type parameter of this tool . This parameter is the geometry type of the 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 the geometry type of the feature class. This is an optional parameter.

Parameters:

geometryType - the geometry type of the feature class.

getTemplate

public Object getTemplate()

Returns the Template Feature Class parameter of this tool . This parameter is the feature class used as a template to define the attribute schema of the 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 the feature class used as a template to define the attribute schema of the feature class. This is an optional parameter.

Parameters:

template - the feature class used as a template to define the attribute schema of the feature class.

getHasM

public String getHasM()

Returns the Has M parameter of this tool . This parameter is 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 determines if the feature class contains linear measurement values (m-values). This is an optional parameter.

Parameters:

hasM - 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 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 determines if the feature class contains elevation values (z-values). This is an optional parameter.

Parameters:

hasZ - 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 the spatial reference of the output feature class. You can specify the spatial reference in several ways: when you use a Template Feature Class its spatial reference is ignored. 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 the spatial reference of the output feature class. You can specify the spatial reference in several ways: when you use a Template Feature Class its spatial reference is ignored. This is an optional parameter.

Parameters:

spatialReference - the spatial reference of the output feature class. You can specify the spatial reference in several ways: when you use a Template Feature Class its spatial reference is ignored.

• By entering the path to a .prj file, such as C:/workspace/watershed.prj.
• By referencing a feature class whose spatial reference you want to apply, such as C:/workspace/myproject.gdb/landuse/grassland .
• By defining a spatial reference object prior to defining the Create Feature Class function, such as sr = arcpy.SpatialReference("C:/data/Africa/Carthage.prj") which you then call in the Create Feature Class tool. Refer to the Stand-alone Code Sample below.

getConfigKeyword

public String getConfigKeyword()

Returns the Configuration Keyword parameter of this tool . This parameter is the configuration keyword applies to ArcSDE data only. It determines the storage parameters of the database table. 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 the configuration keyword applies to ArcSDE data only. It determines the storage parameters of the database table. This is an optional parameter.

Parameters:

configKeyword - the configuration keyword applies to ArcSDE data only. It determines the storage parameters of the database table.

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 are used to compute a spatial index and only apply 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. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. 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 are used to compute a spatial index and only apply 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. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. 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 are used to compute a spatial index and only apply 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. Since no features are written by this tool, the spatial index will be in an unbuilt state. The index will be built when features are written to the feature class such as by the Append tool or editing operations. 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.

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