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

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

public class CreateFileGDB
extends AbstractGPTool

Creates a file geodatabase, stored as a series of folders in a file system. The Create File GDB 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
CreateFileGDB()
          Creates the Create File GDB tool with defaults.
CreateFileGDB(Object outFolderPath, String outName)
          Creates the Create File GDB tool with the required parameters.
 
Method Summary
 Object getOutFileGdb()
          Returns the Output File GDB parameter of this tool (Read only).
 Object getOutFolderPath()
          Returns the File GDB Location parameter of this tool .
 String getOutName()
          Returns the File GDB Name 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 setOutFolderPath(Object outFolderPath)
          Sets the File GDB Location parameter of this tool .
 void setOutName(String outName)
          Sets the File GDB Name 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

CreateFileGDB

public CreateFileGDB()
Creates the Create File GDB tool with defaults.

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


CreateFileGDB

public CreateFileGDB(Object outFolderPath,
                     String outName)
Creates the Create File GDB 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:
outFolderPath - Folder, the location where the new file geodatabase will be created.
outName - String, the name of the file geodatabase to be created.
Method Detail

getOutFolderPath

public Object getOutFolderPath()
Returns the File GDB Location parameter of this tool . This parameter is Folder, the location where the new file geodatabase will be created. This is a required parameter.

Returns:
the File GDB Location

setOutFolderPath

public void setOutFolderPath(Object outFolderPath)
Sets the File GDB Location parameter of this tool . This parameter is Folder, the location where the new file geodatabase will be created. This is a required parameter.

Parameters:
outFolderPath - Folder, the location where the new file geodatabase will be created.

getOutName

public String getOutName()
Returns the File GDB Name parameter of this tool . This parameter is String, the name of the file geodatabase to be created. This is a required parameter.

Returns:
the File GDB Name

setOutName

public void setOutName(String outName)
Sets the File GDB Name parameter of this tool . This parameter is String, the name of the file geodatabase to be created. This is a required parameter.

Parameters:
outName - String, the name of the file geodatabase to be created.

getOutFileGdb

public Object getOutFileGdb()
Returns the Output File GDB parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output File GDB

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