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

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

public class CreateFeatureDataset
extends AbstractGPTool

Creates an empty feature dataset in the output locationan existing ArcSDE, file or personal geodatabase. The Create Feature Dataset 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
CreateFeatureDataset()
          Creates the Create Feature Dataset tool with defaults.
CreateFeatureDataset(Object outDatasetPath, String outName)
          Creates the Create Feature Dataset tool with the required parameters.
 
Method Summary
 Object getOutDataset()
          Returns the Output Feature Dataset parameter of this tool (Read only).
 Object getOutDatasetPath()
          Returns the Feature Dataset Location parameter of this tool .
 String getOutName()
          Returns the Feature Dataset Name parameter of this tool .
 Object getSpatialReference()
          Returns the Coordinate System 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 setOutDatasetPath(Object outDatasetPath)
          Sets the Feature Dataset Location parameter of this tool .
 void setOutName(String outName)
          Sets the Feature Dataset Name parameter of this tool .
 void setSpatialReference(Object spatialReference)
          Sets the Coordinate System 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

CreateFeatureDataset

public CreateFeatureDataset()
Creates the Create Feature Dataset tool with defaults.

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


CreateFeatureDataset

public CreateFeatureDataset(Object outDatasetPath,
                            String outName)
Creates the Create Feature Dataset 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:
outDatasetPath - Workspace, the ArcSDE, file or personal geodatabase (it must already exist) in which the Output Feature Dataset will be created.
outName - String, the name of the feature dataset to be created.
Method Detail

getOutDatasetPath

public Object getOutDatasetPath()
Returns the Feature Dataset Location parameter of this tool . This parameter is Workspace, the ArcSDE, file or personal geodatabase (it must already exist) in which the Output Feature Dataset will be created. This is a required parameter.

Returns:
the Feature Dataset Location

setOutDatasetPath

public void setOutDatasetPath(Object outDatasetPath)
Sets the Feature Dataset Location parameter of this tool . This parameter is Workspace, the ArcSDE, file or personal geodatabase (it must already exist) in which the Output Feature Dataset will be created. This is a required parameter.

Parameters:
outDatasetPath - Workspace, the ArcSDE, file or personal geodatabase (it must already exist) in which the Output Feature Dataset will be created.

getOutName

public String getOutName()
Returns the Feature Dataset Name parameter of this tool . This parameter is String, the name of the feature dataset to be created. This is a required parameter.

Returns:
the Feature Dataset Name

setOutName

public void setOutName(String outName)
Sets the Feature Dataset Name parameter of this tool . This parameter is String, the name of the feature dataset to be created. This is a required parameter.

Parameters:
outName - String, the name of the feature dataset to be created.

getSpatialReference

public Object getSpatialReference()
Returns the Coordinate System parameter of this tool . This parameter is Spatial Reference, the spatial reference of the output feature dataset. 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 spatial reference properties dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used. The recommended way to specify the coordinate system at the command line is to create a variable. Right click and choose insert variable. This will allow you to use the spatial reference properties dialog to set the coordinate system. 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 dataset. 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 spatial reference properties dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used. The recommended way to specify the coordinate system at the command line is to create a variable. Right click and choose insert variable. This will allow you to use the spatial reference properties dialog to set the coordinate system. This is an optional parameter.

Parameters:
spatialReference - Spatial Reference, the spatial reference of the output feature dataset. 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 spatial reference properties dialog and select an existing dataset, all spatial reference properties from that dataset (coordinate system, domains and tolerances) will be used. The recommended way to specify the coordinate system at the command line is to create a variable. Right click and choose insert variable. This will allow you to use the spatial reference properties dialog to set the coordinate system.

getOutDataset

public Object getOutDataset()
Returns the Output Feature Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Feature Dataset

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