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

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

public class CreateArcInfoWorkspace
extends AbstractGPTool

Creates a The Create ArcInfo Workspace tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateArcInfoWorkspace()
          Creates the Create ArcInfo Workspace tool with defaults.
CreateArcInfoWorkspace(Object outFolderPath, String outName)
          Creates the Create ArcInfo Workspace tool with the required parameters.
 
Method Summary
 Object getOutFolderPath()
          Returns the ArcInfo Workspace Location parameter of this tool .
 String getOutName()
          Returns the ArcInfo Workspace Name parameter of this tool .
 Object getOutWorkspace()
          Returns the Output ArcInfo Workspace parameter of this tool (Read only).
 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 ArcInfo Workspace Location parameter of this tool .
 void setOutName(String outName)
          Sets the ArcInfo Workspace 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

CreateArcInfoWorkspace

public CreateArcInfoWorkspace()
Creates the Create ArcInfo Workspace tool with defaults.

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


CreateArcInfoWorkspace

public CreateArcInfoWorkspace(Object outFolderPath,
                              String outName)
Creates the Create ArcInfo Workspace 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, location where the ArcInfo workspace will be created.
outName - String, name of the ArcInfo workspace to be created.
Method Detail

getOutFolderPath

public Object getOutFolderPath()
Returns the ArcInfo Workspace Location parameter of this tool . This parameter is Folder, location where the ArcInfo workspace will be created. This is a required parameter.

Returns:
the ArcInfo Workspace Location

setOutFolderPath

public void setOutFolderPath(Object outFolderPath)
Sets the ArcInfo Workspace Location parameter of this tool . This parameter is Folder, location where the ArcInfo workspace will be created. This is a required parameter.

Parameters:
outFolderPath - Folder, location where the ArcInfo workspace will be created.

getOutName

public String getOutName()
Returns the ArcInfo Workspace Name parameter of this tool . This parameter is String, name of the ArcInfo workspace to be created. This is a required parameter.

Returns:
the ArcInfo Workspace Name

setOutName

public void setOutName(String outName)
Sets the ArcInfo Workspace Name parameter of this tool . This parameter is String, name of the ArcInfo workspace to be created. This is a required parameter.

Parameters:
outName - String, name of the ArcInfo workspace to be created.

getOutWorkspace

public Object getOutWorkspace()
Returns the Output ArcInfo Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output ArcInfo Workspace

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