com.esri.arcgis.spatialanalyst
Interface IGPSAStringRemap

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPSAStringRemap

public interface IGPSAStringRemap
extends Serializable

Provides access to StringRemap control for GP Spatial Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Method Summary

void	loadStringsFromTable(ITable remapTable, String outFieldName, String inFieldName, Object mappingFieldName) Loads string remap records from a table object.
void	mapString(String inputString, int outputValue) Maps a string entry to the remap object.
void	mapStringToNoData(String inputString) Maps a string entry to nodata.
void	queryStringRecord(int index, String[] inString, int[] outValue, boolean[] mappedToNoData) Returns string record information by index.
void	queryStringValue(String inString, int[] outValue, boolean[] isNodata) Returns the mapped value for a string remap entry.

Method Detail

mapString

void mapString(String inputString,
               int outputValue)
               throws IOException,
                      AutomationException

Maps a string entry to the remap object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

inputString - The inputString (in)

outputValue - The outputValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapStringToNoData

void mapStringToNoData(String inputString)
                       throws IOException,
                              AutomationException

Maps a string entry to nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

inputString - The inputString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryStringRecord

void queryStringRecord(int index,
                       String[] inString,
                       int[] outValue,
                       boolean[] mappedToNoData)
                       throws IOException,
                              AutomationException

Returns string record information by index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

index - The index (in)

inString - The inString (out: use single element array)

outValue - The outValue (out: use single element array)

mappedToNoData - The mappedToNoData (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryStringValue

void queryStringValue(String inString,
                      int[] outValue,
                      boolean[] isNodata)
                      throws IOException,
                             AutomationException

Returns the mapped value for a string remap entry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

inString - The inString (in)

outValue - The outValue (out: use single element array)

isNodata - The isNodata (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadStringsFromTable

void loadStringsFromTable(ITable remapTable,
                          String outFieldName,
                          String inFieldName,
                          Object mappingFieldName)
                          throws IOException,
                                 AutomationException

Loads string remap records from a table object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

remapTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

outFieldName - The outFieldName (in)

inFieldName - The inFieldName (in)

mappingFieldName - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.