com.esri.arcgis.geoprocessing.tools.coveragetools
Class Generate

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

public class Generate
extends AbstractGPTool

Generates a coverage from coordinates stored in a file. The Generate tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Generate()
          Creates the Generate tool with defaults.
Generate(Object inFile, Object outCover, String featureType)
          Creates the Generate tool with the required parameters.
 
Method Summary
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 Object getInFile()
          Returns the Input File parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setInFile(Object inFile)
          Sets the Input File parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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

Generate

public Generate()
Creates the Generate tool with defaults.

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


Generate

public Generate(Object inFile,
                Object outCover,
                String featureType)
Creates the Generate 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:
inFile - the file containing feature coordinates that will be used to generate a coverage.
outCover - the coverage to be generated.
featureType - the type of features to create:
Method Detail

getInFile

public Object getInFile()
Returns the Input File parameter of this tool . This parameter is the file containing feature coordinates that will be used to generate a coverage. This is a required parameter.

Returns:
the Input File

setInFile

public void setInFile(Object inFile)
Sets the Input File parameter of this tool . This parameter is the file containing feature coordinates that will be used to generate a coverage. This is a required parameter.

Parameters:
inFile - the file containing feature coordinates that will be used to generate a coverage.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the coverage to be generated. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is the coverage to be generated. This is a required parameter.

Parameters:
outCover - the coverage to be generated.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is the type of features to create: This is a required parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is the type of features to create: This is a required parameter.

Parameters:
featureType - the type of features to create:

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