com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class BuildRasterAttributeTable

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.BuildRasterAttributeTable

All Implemented Interfaces:

GPTool

public class BuildRasterAttributeTable
extends AbstractGPTool

Adds a raster attribute table to a raster dataset or updates an existing one. The Build Raster Attribute Table tool is contained in the Data Management Tools tool box.

Usage tips:

• If you want to delete an existing table and create a new one, check Overwrite. A new raster attribute table will be created, and the old one will be deleted.
• If you have an existing table and you do not check Overwrite, the table will be updated. No fields will be deleted, but the values in the table will be up to date.
• It is not possible to build a raster attribute table for a raster dataset that is a pixel type of 32-bit floating point.

Field Summary

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

vals

Constructor Summary

BuildRasterAttributeTable()
Creates the Build Raster Attribute Table tool with defaults.

BuildRasterAttributeTable(Object inRaster)
Creates the Build Raster Attribute Table 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 (Read only).
String	getOverwrite() Returns the Overwrite 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	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setOverwrite(String overwrite) Sets the Overwrite 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

BuildRasterAttributeTable

public BuildRasterAttributeTable()

Creates the Build Raster Attribute Table tool with defaults.

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

BuildRasterAttributeTable

public BuildRasterAttributeTable(Object inRaster)

Creates the Build Raster Attribute 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 dataset. this must be a raster dataset with only a single band. It is not possible to build a raster attribute table for a raster dataset that has a pixel type of 32-bit floating point.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster dataset. this must be a raster dataset with only a single band. It is not possible to build a raster attribute table for a raster dataset that has a pixel type of 32-bit floating point. 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 dataset. this must be a raster dataset with only a single band. It is not possible to build a raster attribute table for a raster dataset that has a pixel type of 32-bit floating point. This is a required parameter.

Parameters:

inRaster - the input raster dataset. this must be a raster dataset with only a single band. It is not possible to build a raster attribute table for a raster dataset that has a pixel type of 32-bit floating point.

getOverwrite

public String getOverwrite()

Returns the Overwrite parameter of this tool . This parameter is this allows you to overwrite any existing raster attribute table that might exist. This is an optional parameter.

Returns:

the Overwrite

setOverwrite

public void setOverwrite(String overwrite)

Sets the Overwrite parameter of this tool . This parameter is this allows you to overwrite any existing raster attribute table that might exist. This is an optional parameter.

Parameters:

overwrite - this allows you to overwrite any existing raster attribute table that might exist.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Raster

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