com.esri.arcgis.spatialanalyst
Interface IGPSARemap

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPSANumberRemap, GPSAStringRemap

public interface IGPSARemap
extends Serializable

Provides access to Remap control for GP Spatial Analyst.

Product Availability

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


Method Summary
 void clear()
          Clears the remap object.
 void deleteRecord(int recordIndex)
          Deletes a remap record by index.
 int getMinOutputValue()
          The minimum output value.
 int getRecordCount()
          The number of remap records.
 IRemap getRemap()
          The remap.
 boolean hasValueToNoData()
          Returns whether any record is mapped to nodata.
 void loadFromTable(ITable remapTable)
          Loads remap records from an ITable and creates the relevant remap object.
 void queryNoDataTo(boolean[] isMapped, int[] outValue)
          Returns whether nodata is mapped and if so, the mapped value.
 void queryRecord(int recordIndex, String[] sInValue, String[] sOutValue)
          Returns info for a remap record by index.
 ITable representAsTable()
          Stores the remap records in an ITable.
 void saveAsTable(String tableName)
          Saves the remap records to a table.
 void setNoDataTo(int rhs1)
          The nodata value.
 void setRemapByRef(IRemap remap)
          The remap.
 void validate(boolean[] bIsValid, String[] sErrorInfo)
          Validates the remap records.
 

Method Detail

getRecordCount

int getRecordCount()
                   throws IOException,
                          AutomationException
The number of remap records.

Product Availability

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

Returns:
The recordCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoDataTo

void setNoDataTo(int rhs1)
                 throws IOException,
                        AutomationException
The nodata value.

Product Availability

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

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRecord

void queryRecord(int recordIndex,
                 String[] sInValue,
                 String[] sOutValue)
                 throws IOException,
                        AutomationException
Returns info for a remap record by index.

Product Availability

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

Parameters:
recordIndex - The recordIndex (in)
sInValue - The sInValue (out: use single element array)
sOutValue - The sOutValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNoDataTo

void queryNoDataTo(boolean[] isMapped,
                   int[] outValue)
                   throws IOException,
                          AutomationException
Returns whether nodata is mapped and if so, the mapped value.

Product Availability

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

Parameters:
isMapped - The isMapped (out: use single element array)
outValue - The outValue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

void validate(boolean[] bIsValid,
              String[] sErrorInfo)
              throws IOException,
                     AutomationException
Validates the remap records.

Product Availability

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

Parameters:
bIsValid - The bIsValid (out: use single element array)
sErrorInfo - The sErrorInfo (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRecord

void deleteRecord(int recordIndex)
                  throws IOException,
                         AutomationException
Deletes a remap record by index.

Product Availability

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

Parameters:
recordIndex - The recordIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException
Clears the remap object.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadFromTable

void loadFromTable(ITable remapTable)
                   throws IOException,
                          AutomationException
Loads remap records from an ITable and creates the relevant remap 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)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAsTable

void saveAsTable(String tableName)
                 throws IOException,
                        AutomationException
Saves the remap records to a table.

Product Availability

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

Parameters:
tableName - The tableName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

representAsTable

ITable representAsTable()
                        throws IOException,
                               AutomationException
Stores the remap records in an ITable.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinOutputValue

int getMinOutputValue()
                      throws IOException,
                             AutomationException
The minimum output value.

Product Availability

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

Returns:
The minValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasValueToNoData

boolean hasValueToNoData()
                         throws IOException,
                                AutomationException
Returns whether any record is mapped to nodata.

Product Availability

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

Returns:
The hasToNodata
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemap

IRemap getRemap()
                throws IOException,
                       AutomationException
The remap.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geoanalyst.IRemap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRemapByRef

void setRemapByRef(IRemap remap)
                   throws IOException,
                          AutomationException
The remap.

Product Availability

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

Parameters:
remap - A reference to a com.esri.arcgis.geoanalyst.IRemap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.