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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.multidimensiontools.TableToNetCDF

All Implemented Interfaces:

GPTool

public class TableToNetCDF
extends AbstractGPTool

Converts a table to a netCDF file. The Table to NetCDF tool is contained in the Multidimension Tools tool box.

Usage tips:

• The default variable name is the same as the field name specified in the Fields to Variables parameter.
• The type of variable is the same as the type of field.
• The default dimension name is the same as the field name specified in the Fields to Dimensions parameter.
• The size of a dimension equals the number of unique values in the respective field.
• If no field is specified as dimension, then a dimension named RecordID is created in the output netCDF file.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

TableToNetCDF()
Creates the Table to NetCDF tool with defaults.

TableToNetCDF(Object inTable, Object fieldsToVariables, Object outNetCDFFile)
Creates the Table to NetCDF tool with the required parameters.

Method Summary

Object	getFieldsToDimensions() Returns the Fields to Dimensions parameter of this tool .
Object	getFieldsToVariables() Returns the Fields to Variables parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutNetCDFFile() Returns the Output netCDF File 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	setFieldsToDimensions(Object fieldsToDimensions) Sets the Fields to Dimensions parameter of this tool .
void	setFieldsToVariables(Object fieldsToVariables) Sets the Fields to Variables parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutNetCDFFile(Object outNetCDFFile) Sets the Output netCDF File 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

TableToNetCDF

public TableToNetCDF()

Creates the Table to NetCDF tool with defaults.

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

TableToNetCDF

public TableToNetCDF(Object inTable,
                     Object fieldsToVariables,
                     Object outNetCDFFile)

Creates the Table to NetCDF 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:

inTable - the input table.

fieldsToVariables - the field or fields used to create variables in the netCDF file.

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the input table. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is the input table. This is a required parameter.

Parameters:

inTable - the input table.

getFieldsToVariables

public Object getFieldsToVariables()

Returns the Fields to Variables parameter of this tool . This parameter is the field or fields used to create variables in the netCDF file. This is a required parameter.

Returns:

the Fields to Variables

setFieldsToVariables

public void setFieldsToVariables(Object fieldsToVariables)

Sets the Fields to Variables parameter of this tool . This parameter is the field or fields used to create variables in the netCDF file. This is a required parameter.

Parameters:

fieldsToVariables - the field or fields used to create variables in the netCDF file.

getOutNetCDFFile

public Object getOutNetCDFFile()

Returns the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Returns:

the Output netCDF File

setOutNetCDFFile

public void setOutNetCDFFile(Object outNetCDFFile)

Sets the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Parameters:

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

getFieldsToDimensions

public Object getFieldsToDimensions()

Returns the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Returns:

the Fields to Dimensions

setFieldsToDimensions

public void setFieldsToDimensions(Object fieldsToDimensions)

Sets the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Parameters:

fieldsToDimensions - the field or fields used to create dimensions in the netCDF file.

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