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

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

public class SelectByDimension
extends AbstractGPTool

Updates the netCDF layer display or netCDF table view based on the dimension value. The Select by Dimension 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
SelectByDimension()
          Creates the Select by Dimension tool with defaults.
SelectByDimension(Object inLayerOrTable)
          Creates the Select by Dimension tool with the required parameters.
 
Method Summary
 Object getDimensionValues()
          Returns the Dimension Values parameter of this tool .
 Object getInLayerOrTable()
          Returns the Input Layer or Table parameter of this tool .
 Object getOutputLayerOrTable()
          Returns the Output Layer or Table 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.
 String getValueSelectionMethod()
          Returns the Value Selection Method parameter of this tool .
 void setDimensionValues(Object dimensionValues)
          Sets the Dimension Values parameter of this tool .
 void setInLayerOrTable(Object inLayerOrTable)
          Sets the Input Layer or Table parameter of this tool .
 void setValueSelectionMethod(String valueSelectionMethod)
          Sets the Value Selection Method 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

SelectByDimension

public SelectByDimension()
Creates the Select by Dimension tool with defaults.

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


SelectByDimension

public SelectByDimension(Object inLayerOrTable)
Creates the Select by Dimension 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:
inLayerOrTable - Raster Layer | Feature Layer | Table View, the input netCDF raster layer, netCDF feature layer, or netCDF table view.
Method Detail

getInLayerOrTable

public Object getInLayerOrTable()
Returns the Input Layer or Table parameter of this tool . This parameter is Raster Layer | Feature Layer | Table View, the input netCDF raster layer, netCDF feature layer, or netCDF table view. This is a required parameter.

Returns:
the Input Layer or Table

setInLayerOrTable

public void setInLayerOrTable(Object inLayerOrTable)
Sets the Input Layer or Table parameter of this tool . This parameter is Raster Layer | Feature Layer | Table View, the input netCDF raster layer, netCDF feature layer, or netCDF table view. This is a required parameter.

Parameters:
inLayerOrTable - Raster Layer | Feature Layer | Table View, the input netCDF raster layer, netCDF feature layer, or netCDF table view.

getDimensionValues

public Object getDimensionValues()
Returns the Dimension Values parameter of this tool . This parameter is (String String; String String;...), a set of dimensionvalue 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 dimensionvalue pairs used to specify a slice of a multidimensional variable. This is an optional parameter.

Parameters:
dimensionValues - (String String; String String;...), a set of dimensionvalue 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.

getOutputLayerOrTable

public Object getOutputLayerOrTable()
Returns the Output Layer or Table parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Layer or Table

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