com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class Test

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.Test

All Implemented Interfaces:

GPTool

public class Test
extends AbstractGPTool

Performs a Boolean evaluation of the input raster using a logical expression. The Test tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The test is specified by an SQL expression in the Where clause.

Field Summary

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

vals

Constructor Summary

Test()
Creates the Test tool with defaults.

Test(Object inRaster, Object whereClause, Object outRaster)
Creates the Test tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRaster() Returns the Output raster 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.
Object	getWhereClause() Returns the Where clause parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Where clause 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

Test

public Test()

Creates the Test tool with defaults.

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

Test

public Test(Object inRaster,
            Object whereClause,
            Object outRaster)

Creates the Test 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:

inRaster - the input raster on which the Boolean evaluation is performed, based on a logical expression.

whereClause - a logical expression that selects a subset of raster cells. an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference.

outRaster - the output raster. the output values will be either 0 or 1.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster on which the Boolean evaluation is performed, based on a logical expression. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input raster on which the Boolean evaluation is performed, based on a logical expression. This is a required parameter.

Parameters:

inRaster - the input raster on which the Boolean evaluation is performed, based on a logical expression.

getWhereClause

public Object getWhereClause()

Returns the Where clause parameter of this tool . This parameter is a logical expression that selects a subset of raster cells. an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference. This is a required parameter.

Returns:

the Where clause

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Where clause parameter of this tool . This parameter is a logical expression that selects a subset of raster cells. an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference. This is a required parameter.

Parameters:

whereClause - a logical expression that selects a subset of raster cells. an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the output values will be either 0 or 1. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. the output values will be either 0 or 1. This is a required parameter.

Parameters:

outRaster - the output raster. the output values will be either 0 or 1.

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