com.esri.arcgis.spatialanalyst
Class GPSAStringRemap

java.lang.Object
  com.esri.arcgis.spatialanalyst.GPSAStringRemap

All Implemented Interfaces:

IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPSARemap, IGPSAStringRemap, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPSAStringRemap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSARemap, IGPSAStringRemap, IGPValue, IClone, IXMLSerialize, IPersistStream, Externalizable

GeoProcessor Spatial StringRemap object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPSAStringRemap()
Constructs a GPSAStringRemap using ArcGIS Engine.

GPSAStringRemap(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSAStringRemap theGPSAStringRemap = (GPSAStringRemap) 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(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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	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.
void	readExternal(ObjectInput in)
ITable	representAsTable() Stores the remap records in an ITable.
void	save(IStream pstm, int fClearDirty) save
void	saveAsTable(String tableName) Saves the remap records to a table.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(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, String[] sErrorInfo) Validates the remap records.
void	writeExternal(ObjectOutput out)

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

GPSAStringRemap

public GPSAStringRemap()
                throws IOException,
                       UnknownHostException

Constructs a GPSAStringRemap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPSAStringRemap

public GPSAStringRemap(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSAStringRemap theGPSAStringRemap = (GPSAStringRemap) obj;

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

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. Requires Spatial Analyst Extension.

Specified by:

getRecordCount in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

setNoDataTo in interface IGPSARemap

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. Requires Spatial Analyst Extension.

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:

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. Requires Spatial Analyst Extension.

Specified by:

queryNoDataTo in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

validate in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

deleteRecord in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

clear in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

loadFromTable in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

saveAsTable in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

representAsTable in interface IGPSARemap

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. Requires Spatial Analyst Extension.

Specified by:

getMinOutputValue in interface IGPSARemap

Returns:

The minValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasValueToNoData

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

Specified by:

hasValueToNoData in interface IGPSARemap

Returns:

The hasToNodata

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemap

public IRemap getRemap()
                throws IOException,
                       AutomationException

The remap.

Product Availability

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

Specified by:

getRemap in interface IGPSARemap

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

public void setRemapByRef(IRemap remap)
                   throws IOException,
                          AutomationException

The remap.

Product Availability

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

Specified by:

setRemapByRef in interface IGPSARemap

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.

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. Requires Spatial Analyst Extension.

Specified by:

mapString in interface IGPSAStringRemap

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. Requires Spatial Analyst Extension.

Specified by:

mapStringToNoData in interface IGPSAStringRemap

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. Requires Spatial Analyst Extension.

Specified by:

queryStringRecord in interface IGPSAStringRemap

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. Requires Spatial Analyst Extension.

Specified by:

queryStringValue in interface IGPSAStringRemap

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. Requires Spatial Analyst Extension.

Specified by:

loadStringsFromTable in interface IGPSAStringRemap

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.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

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

Indicates if 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

Indicates if 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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException