com.esri.arcgis.spatialanalyst
Class GPRasterCalculatorExpression

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.GPRasterCalculatorExpression
All Implemented Interfaces:
IGPToolTip, IGPValue, IGPValueExpression, IGPValueTable, com.esri.arcgis.interop.RemoteObjRef, IGPRasterCalculatorExpression, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPRasterCalculatorExpression
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPRasterCalculatorExpression, IGPValueTable, IGPValueExpression, IClone, IXMLSerialize, IPersistStream, IGPToolTip, java.io.Externalizable

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

Description 'GeoProcessor Spatial Analyst GPRasterCalculatorExpression 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.geodatabase.IGPValue
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy
 
Fields inherited from interface com.esri.arcgis.spatialanalyst.IGPRasterCalculatorExpression
IID, IID02435abd_2531_456c_8811_374b5212c197, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPValueTable
IID, IID270e32ad_b10d_4de0_8664_688062ba1846, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPValueExpression
IID, IID1ac0728d_8da6_4592_bcf9_7c3027f51f38, 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
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPToolTip
IID, IID4d95bfa9_aa3f_416a_a4a9_6b6b2cf66f2b, xxDummy
 
Constructor Summary
GPRasterCalculatorExpression()
          Constructs a GPRasterCalculatorExpression using ArcGIS Engine.
GPRasterCalculatorExpression(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPRasterCalculatorExpression theGPRasterCalculatorExpression = (GPRasterCalculatorExpression) obj;
 
Method Summary
 void addDataType(IGPDataType pDataType)
          Adds the data type as a column to the value table.
 void addRecord(IArray pValues)
          Adds a record to the value table.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 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.
 java.lang.String getAsText(IGPVariableManager pVariableManager)
          Gets the text value of the variable value.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IGPDataType getDataType(int index)
          The data type object of the given column index.
 int getDataTypeCount()
          The number of data types/columns of the value table.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IArray getRecord(int index)
          Returns the array of values of the specified record in the value table.
 int getRecordCount()
          The number of rows in the value table.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getToolTip()
          Creates a tool tip string for the value.
 IGPValue getValue(int row, int col)
          Returns the value of the given row/column.
 IStringArray getVariableNames()
          Returns a string array of the variable names.
 IArray getVariables()
          Returns an array of variables.
 int hashCode()
          the hashcode for this object
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 void insertRecord(int index, IArray pValues)
          Inserts a record in the value table at the specified index.
 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.
 boolean isResolved()
          Gets the resolved state.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a GPRasterCalculatorExpression.
 void removeDataType(int index)
          Removes the given column from the value table.
 void removeRecord(int index)
          Removes the specified record from the value table.
 void removeValue(IGPValue pValue)
          Removes the given value from the value table.
 void replaceRecord(int index, IArray pValues)
          Replaces the record in the value table at the specified index.
 IGPValue resolveValue(IGPVariableManager pVariableManager)
          Resolves a given variable value.
 void save(IStream pstm, int fClearDirty)
          save
 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 setResolved(boolean pResolved)
          Gets the resolved state.
 void setValue(int row, int col, IGPValue ppValue)
          Sets the vlaue of the given row/column.
 void setVariablesByRef(IArray ppVariables)
          Returns an array of variables.
 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

GPRasterCalculatorExpression

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

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

GPRasterCalculatorExpression

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

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

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

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

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.

getDataTypeCount

public int getDataTypeCount()
                     throws java.io.IOException,
                            AutomationException
The number of data types/columns of the value table.

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

getDataType

public IGPDataType getDataType(int index)
                        throws java.io.IOException,
                               AutomationException
The data type object of the given column index.

Specified by:
getDataType in interface IGPValueTable
Parameters:
index - The index (in)
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.

addDataType

public void addDataType(IGPDataType pDataType)
                 throws java.io.IOException,
                        AutomationException
Adds the data type as a column to the value table.

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

removeDataType

public void removeDataType(int index)
                    throws java.io.IOException,
                           AutomationException
Removes the given column from the value table.

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

getRecordCount

public int getRecordCount()
                   throws java.io.IOException,
                          AutomationException
The number of rows in the value table.

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

getValue

public IGPValue getValue(int row,
                         int col)
                  throws java.io.IOException,
                         AutomationException
Returns the value of the given row/column.

Specified by:
getValue in interface IGPValueTable
Parameters:
row - The row (in)
col - The col (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int row,
                     int col,
                     IGPValue ppValue)
              throws java.io.IOException,
                     AutomationException
Sets the vlaue of the given row/column.

Specified by:
setValue in interface IGPValueTable
Parameters:
row - The row (in)
col - The col (in)
ppValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRecord

public void addRecord(IArray pValues)
               throws java.io.IOException,
                      AutomationException
Adds a record to the value table.

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

insertRecord

public void insertRecord(int index,
                         IArray pValues)
                  throws java.io.IOException,
                         AutomationException
Inserts a record in the value table at the specified index.

Specified by:
insertRecord in interface IGPValueTable
Parameters:
index - The index (in)
pValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceRecord

public void replaceRecord(int index,
                          IArray pValues)
                   throws java.io.IOException,
                          AutomationException
Replaces the record in the value table at the specified index.

Specified by:
replaceRecord in interface IGPValueTable
Parameters:
index - The index (in)
pValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeRecord

public void removeRecord(int index)
                  throws java.io.IOException,
                         AutomationException
Removes the specified record from the value table.

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

getRecord

public IArray getRecord(int index)
                 throws java.io.IOException,
                        AutomationException
Returns the array of values of the specified record in the value table.

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

removeValue

public void removeValue(IGPValue pValue)
                 throws java.io.IOException,
                        AutomationException
Removes the given value from the value table.

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

isResolved

public boolean isResolved()
                   throws java.io.IOException,
                          AutomationException
Gets the resolved state.

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

setResolved

public void setResolved(boolean pResolved)
                 throws java.io.IOException,
                        AutomationException
Gets the resolved state.

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

resolveValue

public IGPValue resolveValue(IGPVariableManager pVariableManager)
                      throws java.io.IOException,
                             AutomationException
Resolves a given variable value.

Specified by:
resolveValue in interface IGPValueExpression
Parameters:
pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVariableNames

public IStringArray getVariableNames()
                              throws java.io.IOException,
                                     AutomationException
Returns a string array of the variable names.

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

getVariables

public IArray getVariables()
                    throws java.io.IOException,
                           AutomationException
Returns an array of variables.

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

setVariablesByRef

public void setVariablesByRef(IArray ppVariables)
                       throws java.io.IOException,
                              AutomationException
Returns an array of variables.

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

getAsText

public java.lang.String getAsText(IGPVariableManager pVariableManager)
                           throws java.io.IOException,
                                  AutomationException
Gets the text value of the variable value.

Specified by:
getAsText in interface IGPValueExpression
Parameters:
pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)
Returns:
The pText
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.

getToolTip

public java.lang.String getToolTip()
                            throws java.io.IOException,
                                   AutomationException
Creates a tool tip string for the value.

Specified by:
getToolTip in interface IGPToolTip
Returns:
The toolTip
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