com.esri.arcgis.geoanalyst
Class StringRemap

java.lang.Object
  extended by com.esri.arcgis.geoanalyst.StringRemap
All Implemented Interfaces:
IRemap, IStringRemap, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, Serializable

public class StringRemap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRemap, IStringRemap, IClone, ISupportErrorInfo

GeoAnalyst String remap object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
StringRemap()
          Constructs a StringRemap using ArcGIS Engine.
StringRemap(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StringRemap theStringRemap = (StringRemap) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clear()
          Clears the remap object.
 void deleteRecord(int recordIndex)
          Deletes a remap record by index.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
static String getClsid()
          getClsid.
 int getMinOutputValue()
          The minimum output value.
 int getRecordCount()
          The number of remap records.
 int hashCode()
          the hashcode for this object
 void hasValueToNoData(boolean[] hasToNodata)
          Returns whether any record is mapped to nodata.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void loadFromTable(ITable remapTable)
          Loads remap records from an ITable and creates the relevant remap object.
 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 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.
 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.
 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 validate(boolean[] bIsValid, String[] sErrorInfo)
          Validates the remap records.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

StringRemap

public StringRemap()
            throws IOException,
                   UnknownHostException
Constructs a StringRemap using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

StringRemap

public StringRemap(Object obj)
            throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StringRemap theStringRemap = (StringRemap) obj;

Construct a StringRemap using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to StringRemap.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getRecordCount

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRecordCount in interface IRemap
Returns:
The recordCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoDataTo

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

queryRecord

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryRecord in interface IRemap
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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryNoDataTo in interface IRemap
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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
validate in interface IRemap
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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

clear

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface IRemap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadFromTable

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
loadFromTable in interface IRemap
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

public 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.

Supported Platforms

Windows, Solaris, Linux

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

representAsTable

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
representAsTable in interface IRemap
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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinOutputValue in interface IRemap
Returns:
The minValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasValueToNoData

public void hasValueToNoData(boolean[] hasToNodata)
                      throws IOException,
                             AutomationException
Returns whether any record is mapped to nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
hasValueToNoData in interface IRemap
Parameters:
hasToNodata - The hasToNodata (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapString

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
mapString in interface IStringRemap
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

public void mapStringToNoData(String inputString)
                       throws IOException,
                              AutomationException
Maps a string entry to nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
mapStringToNoData in interface IStringRemap
Parameters:
inputString - The inputString (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryStringRecord

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryStringRecord in interface IStringRemap
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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryStringValue in interface IStringRemap
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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
loadStringsFromTable in interface IStringRemap
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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.