com.esri.arcgis.geoprocessing.tools.multidimensiontools
Class MakeNetCDFTableView

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

public class MakeNetCDFTableView
extends AbstractGPTool

Makes a table view from a netCDF file. The Make NetCDF Table View tool is contained in the Multidimension Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeNetCDFTableView()
          Creates the Make NetCDF Table View tool with defaults.
MakeNetCDFTableView(Object inNetCDFFile, Object variable, Object outTableView)
          Creates the Make NetCDF Table View tool with the required parameters.
 
Method Summary
 Object getDimensionValues()
          Returns the Dimension Values parameter of this tool .
 Object getInNetCDFFile()
          Returns the Input netCDF File parameter of this tool .
 Object getOutTableView()
          Returns the Output Table View parameter of this tool .
 Object getRowDimension()
          Returns the Row Dimensions 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.
 String getValueSelectionMethod()
          Returns the Value Selection Method parameter of this tool .
 Object getVariable()
          Returns the Variables parameter of this tool .
 void setDimensionValues(Object dimensionValues)
          Sets the Dimension Values parameter of this tool .
 void setInNetCDFFile(Object inNetCDFFile)
          Sets the Input netCDF File parameter of this tool .
 void setOutTableView(Object outTableView)
          Sets the Output Table View parameter of this tool .
 void setRowDimension(Object rowDimension)
          Sets the Row Dimensions parameter of this tool .
 void setValueSelectionMethod(String valueSelectionMethod)
          Sets the Value Selection Method parameter of this tool .
 void setVariable(Object variable)
          Sets the Variables 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

MakeNetCDFTableView

public MakeNetCDFTableView()
Creates the Make NetCDF Table View tool with defaults.

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


MakeNetCDFTableView

public MakeNetCDFTableView(Object inNetCDFFile,
                           Object variable,
                           Object outTableView)
Creates the Make NetCDF Table View 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:
inNetCDFFile - null
variable - String, the netCDF variable, or variables used to create fields in the table view.
outTableView - Table View, the name of the output table view.
Method Detail

getInNetCDFFile

public Object getInNetCDFFile()
Returns the Input netCDF File parameter of this tool . This is a required parameter.

Returns:
the Input netCDF File

setInNetCDFFile

public void setInNetCDFFile(Object inNetCDFFile)
Sets the Input netCDF File parameter of this tool . This is a required parameter.

Parameters:
inNetCDFFile - null

getVariable

public Object getVariable()
Returns the Variables parameter of this tool . This parameter is String, the netCDF variable, or variables used to create fields in the table view. This is a required parameter.

Returns:
the Variables

setVariable

public void setVariable(Object variable)
Sets the Variables parameter of this tool . This parameter is String, the netCDF variable, or variables used to create fields in the table view. This is a required parameter.

Parameters:
variable - String, the netCDF variable, or variables used to create fields in the table view.

getOutTableView

public Object getOutTableView()
Returns the Output Table View parameter of this tool . This parameter is Table View, the name of the output table view. This is a required parameter.

Returns:
the Output Table View

setOutTableView

public void setOutTableView(Object outTableView)
Sets the Output Table View parameter of this tool . This parameter is Table View, the name of the output table view. This is a required parameter.

Parameters:
outTableView - Table View, the name of the output table view.

getRowDimension

public Object getRowDimension()
Returns the Row Dimensions parameter of this tool . This parameter is String, for instance, if stationID is a dimension in the netCDF file and has 10 values, by setting stationID as the dimension to use, 10 rows will be created in the table view. If stationID and time are used and there are 3 time slices, 30 rows will be created in the table view. This is an optional parameter.

Returns:
the Row Dimensions

setRowDimension

public void setRowDimension(Object rowDimension)
Sets the Row Dimensions parameter of this tool . This parameter is String, for instance, if stationID is a dimension in the netCDF file and has 10 values, by setting stationID as the dimension to use, 10 rows will be created in the table view. If stationID and time are used and there are 3 time slices, 30 rows will be created in the table view. This is an optional parameter.

Parameters:
rowDimension - String, for instance, if stationID is a dimension in the netCDF file and has 10 values, by setting stationID as the dimension to use, 10 rows will be created in the table view. If stationID and time are used and there are 3 time slices, 30 rows will be created in the table view.

getDimensionValues

public Object getDimensionValues()
Returns the Dimension Values parameter of this tool . This parameter is (String String; String String;...), a set of dimension-value pairs used to specify a slice of a multidimensional variable. This is an optional parameter.

Returns:
the Dimension Values

setDimensionValues

public void setDimensionValues(Object dimensionValues)
Sets the Dimension Values parameter of this tool . This parameter is (String String; String String;...), a set of dimension-value pairs used to specify a slice of a multidimensional variable. This is an optional parameter.

Parameters:
dimensionValues - (String String; String String;...), a set of dimension-value pairs used to specify a slice of a multidimensional variable.

getValueSelectionMethod

public String getValueSelectionMethod()
Returns the Value Selection Method parameter of this tool . This parameter is String, specifies the dimension value selection method. This is an optional parameter.

Returns:
the Value Selection Method

setValueSelectionMethod

public void setValueSelectionMethod(String valueSelectionMethod)
Sets the Value Selection Method parameter of this tool . This parameter is String, specifies the dimension value selection method. This is an optional parameter.

Parameters:
valueSelectionMethod - String, specifies the dimension value selection method.

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