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

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

public class ReclassByTable
extends AbstractGPTool

Reclassifies or changes the values of the input cells of a raster using a remap table. The Reclass by Table tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ReclassByTable()
          Creates the Reclass by Table tool with defaults.
ReclassByTable(Object inRaster, Object inRemapTable, Object fromValueField, Object toValueField, Object outputValueField, Object outRaster)
          Creates the Reclass by Table tool with the required parameters.
 
Method Summary
 Object getFromValueField()
          Returns the From value field parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 Object getInRemapTable()
          Returns the Input remap table parameter of this tool .
 String getMissingValues()
          Returns the Change missing values to NoData parameter of this tool .
 Object getOutputValueField()
          Returns the Output value field 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 getToValueField()
          Returns the To value field parameter of this tool .
 void setFromValueField(Object fromValueField)
          Sets the From value field parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setInRemapTable(Object inRemapTable)
          Sets the Input remap table parameter of this tool .
 void setMissingValues(String missingValues)
          Sets the Change missing values to NoData parameter of this tool .
 void setOutputValueField(Object outputValueField)
          Sets the Output value field parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setToValueField(Object toValueField)
          Sets the To value field 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

ReclassByTable

public ReclassByTable()
Creates the Reclass by Table tool with defaults.

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


ReclassByTable

public ReclassByTable(Object inRaster,
                      Object inRemapTable,
                      Object fromValueField,
                      Object toValueField,
                      Object outputValueField,
                      Object outRaster)
Creates the Reclass by Table 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 to be reclassified.
inRemapTable - table holding fields defining value ranges to be reclassified and the values they will become.
fromValueField - field holding the beginning value for each value range to be reclassified. this is a numeric field of the input remap table.
toValueField - field holding the ending value for each value range to be reclassified. this is a numeric field of the input remap table.
outputValueField - field holding the integer values to which each range should be changed. this is an integer field of the input remap table.
outRaster - the output reclassified raster. the output will always be of integer type.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is the input raster to be reclassified. 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 to be reclassified. This is a required parameter.

Parameters:
inRaster - the input raster to be reclassified.

getInRemapTable

public Object getInRemapTable()
Returns the Input remap table parameter of this tool . This parameter is table holding fields defining value ranges to be reclassified and the values they will become. This is a required parameter.

Returns:
the Input remap table

setInRemapTable

public void setInRemapTable(Object inRemapTable)
Sets the Input remap table parameter of this tool . This parameter is table holding fields defining value ranges to be reclassified and the values they will become. This is a required parameter.

Parameters:
inRemapTable - table holding fields defining value ranges to be reclassified and the values they will become.

getFromValueField

public Object getFromValueField()
Returns the From value field parameter of this tool . This parameter is field holding the beginning value for each value range to be reclassified. this is a numeric field of the input remap table. This is a required parameter.

Returns:
the From value field

setFromValueField

public void setFromValueField(Object fromValueField)
Sets the From value field parameter of this tool . This parameter is field holding the beginning value for each value range to be reclassified. this is a numeric field of the input remap table. This is a required parameter.

Parameters:
fromValueField - field holding the beginning value for each value range to be reclassified. this is a numeric field of the input remap table.

getToValueField

public Object getToValueField()
Returns the To value field parameter of this tool . This parameter is field holding the ending value for each value range to be reclassified. this is a numeric field of the input remap table. This is a required parameter.

Returns:
the To value field

setToValueField

public void setToValueField(Object toValueField)
Sets the To value field parameter of this tool . This parameter is field holding the ending value for each value range to be reclassified. this is a numeric field of the input remap table. This is a required parameter.

Parameters:
toValueField - field holding the ending value for each value range to be reclassified. this is a numeric field of the input remap table.

getOutputValueField

public Object getOutputValueField()
Returns the Output value field parameter of this tool . This parameter is field holding the integer values to which each range should be changed. this is an integer field of the input remap table. This is a required parameter.

Returns:
the Output value field

setOutputValueField

public void setOutputValueField(Object outputValueField)
Sets the Output value field parameter of this tool . This parameter is field holding the integer values to which each range should be changed. this is an integer field of the input remap table. This is a required parameter.

Parameters:
outputValueField - field holding the integer values to which each range should be changed. this is an integer field of the input remap table.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output reclassified raster. the output will always be of integer type. 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 reclassified raster. the output will always be of integer type. This is a required parameter.

Parameters:
outRaster - the output reclassified raster. the output will always be of integer type.

getMissingValues

public String getMissingValues()
Returns the Change missing values to NoData parameter of this tool . This parameter is denotes whether missing values in the reclass table retain their value or get mapped to NoData. This is an optional parameter.

Returns:
the Change missing values to NoData

setMissingValues

public void setMissingValues(String missingValues)
Sets the Change missing values to NoData parameter of this tool . This parameter is denotes whether missing values in the reclass table retain their value or get mapped to NoData. This is an optional parameter.

Parameters:
missingValues - denotes whether missing values in the reclass table retain their value or get mapped to NoData.

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