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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• Inputs for this tool can be created using the Make NetCDF Feature Layer, Make NetCDF Raster Layer, or Make NetCDF Table View tools.
• If a dimension is not specified, its value is set to the first value. The first value is considered the default value.
• Auxiliary coordinate variables are not listed in the Dimension Values parameter drop-down list and cannot be set as the value of this parameter in a script.
• The BY_INDEX option matches the input value with the position or index of a dimension value. The index is 1 based, that is, the position starts at 1.
• This tool updates the input. In ModelBuilder, an output variable appears that can chain the updated input as input to another tool in the model, but the tool does not produce a new output.

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 - 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 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 the input netCDF raster layer, netCDF feature layer, or netCDF table view. This is a required parameter.

Parameters:

inLayerOrTable - 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 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 a set of dimension–value pairs used to specify a slice of a multidimensional variable. This is an optional parameter.

Parameters:

dimensionValues - 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 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 specifies the dimension value selection method. This is an optional parameter.

Parameters:

valueSelectionMethod - 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