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, java.io.Serializable

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

COM Class 'StringRemap'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoAnalyst.olb'

Description 'GeoAnalyst String remap object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geoanalyst.IRemap
IID, IID2b1e876d_0be8_11d4_80d6_00c04fa0702c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoanalyst.IStringRemap
IID, IID2b1e876e_0be8_11d4_80d6_00c04fa0702c, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
StringRemap()
          Constructs a StringRemap using ArcGIS Engine.
StringRemap(java.lang.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(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if 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, java.lang.String outFieldName, java.lang.String inFieldName, java.lang.Object mappingFieldName)
          Loads string remap records from a table object.
 void mapString(java.lang.String inputString, int outputValue)
          Maps a string entry to the remap object.
 void mapStringToNoData(java.lang.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, java.lang.String[] sInValue, java.lang.String[] sOutValue)
          Returns info for a remap record by index.
 void queryStringRecord(int index, java.lang.String[] inString, int[] outValue, boolean[] mappedToNoData)
          Returns string record information by index.
 void queryStringValue(java.lang.String inString, int[] outValue, boolean[] isNodata)
          Returns the mapped value for a string remap entry.
 void release()
          Release a StringRemap.
 ITable representAsTable()
          Stores the remap records in an ITable.
 void saveAsTable(java.lang.String tableName)
          Saves the remap records to a table.
 void setNoDataTo(int rhs1)
          The nodata value.
 void validate(boolean[] bIsValid, java.lang.String[] sErrorInfo)
          Validates the remap records.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringRemap

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

StringRemap

public StringRemap(java.lang.Object obj)
            throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a StringRemap.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getRecordCount

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

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

setNoDataTo

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

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

queryRecord

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNoDataTo

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

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

validate

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

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

deleteRecord

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

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

clear

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

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

loadFromTable

public void loadFromTable(ITable remapTable)
                   throws java.io.IOException,
                          AutomationException
Loads remap records from an ITable and creates the relevant remap object.

Specified by:
loadFromTable in interface IRemap
Parameters:
remapTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAsTable

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

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

representAsTable

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

Specified by:
representAsTable in interface IRemap
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinOutputValue

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

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

hasValueToNoData

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

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

mapString

public void mapString(java.lang.String inputString,
                      int outputValue)
               throws java.io.IOException,
                      AutomationException
Maps a string entry to the remap object.

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

mapStringToNoData

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

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

queryStringRecord

public void queryStringRecord(int index,
                              java.lang.String[] inString,
                              int[] outValue,
                              boolean[] mappedToNoData)
                       throws java.io.IOException,
                              AutomationException
Returns string record information by index.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryStringValue

public void queryStringValue(java.lang.String inString,
                             int[] outValue,
                             boolean[] isNodata)
                      throws java.io.IOException,
                             AutomationException
Returns the mapped value for a string remap entry.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadStringsFromTable

public void loadStringsFromTable(ITable remapTable,
                                 java.lang.String outFieldName,
                                 java.lang.String inFieldName,
                                 java.lang.Object mappingFieldName)
                          throws java.io.IOException,
                                 AutomationException
Loads string remap records from a table object.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

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

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

assign

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

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

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