com.esri.arcgis.spatialanalyst
Class GPSANumberRemap

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.GPSANumberRemap
All Implemented Interfaces:
IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPSANumberRemap, IGPSARemap, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPSANumberRemap
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSARemap, IGPSANumberRemap, IGPValue, IClone, IXMLSerialize, IPersistStream, java.io.Externalizable

COM Class 'GPSANumberRemap'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description 'GeoProcessor Spatial NumberRemap 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.spatialanalyst.IGPSARemap
IID, IIDb60af0d2_4c41_4b41_bb28_c37728ba1fbb, xxDummy
 
Fields inherited from interface com.esri.arcgis.spatialanalyst.IGPSANumberRemap
IID, IID5dd43eeb_3de8_481f_b5db_2b66997757c9, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, 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.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
GPSANumberRemap()
          Constructs a GPSANumberRemap using ArcGIS Engine.
GPSANumberRemap(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSANumberRemap theGPSANumberRemap = (GPSANumberRemap) 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.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 java.lang.String getAsText()
          Provides the value of the value object.
 void getClassID(GUID[] pClassID)
          getClassID
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.
 IRemap getRemap()
          The remap.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean hasValueToNoData()
          Returns whether any record is mapped to nodata.
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 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 load(IStream pstm)
          load
 void loadFromTable(ITable remapTable)
          Loads remap records from an ITable and creates the relevant remap object.
 void loadNumbersFromASCIIFile(java.lang.String remapFile)
          Loads the information from an ArcGRID ASCII remap file into a remap object.
 void loadNumbersFromTable(ITable remapTable, java.lang.String outFieldName, java.lang.String fromFieldName, java.lang.Object toFieldName, java.lang.Object mappingFieldName)
          Load number remap records from a table object.
 void mapRange(double minValue, double maxValue, int outputValue)
          Maps a range entry to the remap object.
 void mapRangeToNoData(double minValue, double maxValue)
          Maps a range entry to nodata.
 void mapValue(double value, int outputValue)
          Maps a single value entry to the remap object.
 void mapValueToNoData(double value)
          Maps a single value entry to nodata.
 void queryNoDataTo(boolean[] isMapped, int[] outValue)
          Returns whether nodata is mapped and if so, the mapped value.
 void queryNumberRecord(int index, double[] minValue, double[] maxValue, int[] outValue, boolean[] mappedToNoData)
          Returns number record information by index.
 void queryNumberValue(double inValue, int[] outValue, boolean[] isNodata)
          Returns the mapped value for a number remap entry.
 void queryRecord(int recordIndex, java.lang.String[] sInValue, java.lang.String[] sOutValue)
          Returns info for a remap record by index.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GPSANumberRemap.
 ITable representAsTable()
          Stores the remap records in an ITable.
 void save(IStream pstm, int fClearDirty)
          save
 void saveAsTable(java.lang.String tableName)
          Saves the remap records to a table.
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 IGPMessage setAsText(java.lang.String text)
          Provides the value of the value object with the given string value.
 void setNoDataTo(int rhs1)
          The nodata value.
 void setRemapByRef(IRemap remap)
          The remap.
 void validate(boolean[] bIsValid, java.lang.String[] sErrorInfo)
          Validates the remap records.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

GPSANumberRemap

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

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

GPSANumberRemap

public GPSANumberRemap(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSANumberRemap theGPSANumberRemap = (GPSANumberRemap) obj;

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

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

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

hasValueToNoData

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

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

getRemap

public IRemap getRemap()
                throws java.io.IOException,
                       AutomationException
The remap.

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

setRemapByRef

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

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

mapValue

public void mapValue(double value,
                     int outputValue)
              throws java.io.IOException,
                     AutomationException
Maps a single value entry to the remap object.

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

mapRange

public void mapRange(double minValue,
                     double maxValue,
                     int outputValue)
              throws java.io.IOException,
                     AutomationException
Maps a range entry to the remap object.

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

mapValueToNoData

public void mapValueToNoData(double value)
                      throws java.io.IOException,
                             AutomationException
Maps a single value entry to nodata.

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

mapRangeToNoData

public void mapRangeToNoData(double minValue,
                             double maxValue)
                      throws java.io.IOException,
                             AutomationException
Maps a range entry to nodata.

Specified by:
mapRangeToNoData in interface IGPSANumberRemap
Parameters:
minValue - The minValue (in)
maxValue - The maxValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNumberRecord

public void queryNumberRecord(int index,
                              double[] minValue,
                              double[] maxValue,
                              int[] outValue,
                              boolean[] mappedToNoData)
                       throws java.io.IOException,
                              AutomationException
Returns number record information by index.

Specified by:
queryNumberRecord in interface IGPSANumberRemap
Parameters:
index - The index (in)
minValue - The minValue (out: use single element array)
maxValue - The maxValue (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.

queryNumberValue

public void queryNumberValue(double inValue,
                             int[] outValue,
                             boolean[] isNodata)
                      throws java.io.IOException,
                             AutomationException
Returns the mapped value for a number remap entry.

Specified by:
queryNumberValue in interface IGPSANumberRemap
Parameters:
inValue - The inValue (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.

loadNumbersFromTable

public void loadNumbersFromTable(ITable remapTable,
                                 java.lang.String outFieldName,
                                 java.lang.String fromFieldName,
                                 java.lang.Object toFieldName,
                                 java.lang.Object mappingFieldName)
                          throws java.io.IOException,
                                 AutomationException
Load number remap records from a table object.

Specified by:
loadNumbersFromTable in interface IGPSANumberRemap
Parameters:
remapTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
outFieldName - The outFieldName (in)
fromFieldName - The fromFieldName (in)
toFieldName - A Variant (in, optional, pass null if not required)
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.

loadNumbersFromASCIIFile

public void loadNumbersFromASCIIFile(java.lang.String remapFile)
                              throws java.io.IOException,
                                     AutomationException
Loads the information from an ArcGRID ASCII remap file into a remap object.

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

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException
The data type of the value object.

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

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException
Indicates if the value object is empty.

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

empty

public void empty()
           throws java.io.IOException,
                  AutomationException
Clears the value object.

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

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException
Provides the value of the value object.

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

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException