com.esri.arcgis.datasourcesraster

Class ComputeChangeFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.ComputeChangeFunctionArguments

All Implemented Interfaces:

IComputeChangeFunctionArguments, IComputeChangeFunctionArguments2, IRasterFunctionArguments, IRasterFunctionArguments2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class ComputeChangeFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterFunctionArguments2, IComputeChangeFunctionArguments, IComputeChangeFunctionArguments2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'ComputeChangeFunctionArguments'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for compute change function arguments.' 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

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments2

IID, IIDfd4f0d2d_1f81_4b2d_8ae5_90cef59c3cfe, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments

IID04aa081e_28b0_47e4_b375_f367046da924

Fields inherited from interface com.esri.arcgis.datasourcesraster.IComputeChangeFunctionArguments2

IID, IIDffeb7f86_181e_4029_b36b_c5dc5f3d1daf, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IComputeChangeFunctionArguments

IID15eefed5_7e6a_4055_9b2a_5dd84435cbfc

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.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
ComputeChangeFunctionArguments() Constructs a ComputeChangeFunctionArguments using ArcGIS Engine.
ComputeChangeFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ComputeChangeFunctionArguments theComputeChangeFunctionArguments = (ComputeChangeFunctionArguments) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) Loads raster function arguments from JSON.
int	getCellsizeType() The different ways for estimating cellsize.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getExtentType() The different ways for estimating extent.
IStringArray	getFileList() The list of all files associated with the arguments.
ILongArray	getFromClassValues() The list of class values to be selected from the from raster.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getKeepMethod() The Compute Change Keep Method.
int	getMethod() The Compute Change Method.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IStringArray	getNames() The list of all argument names.
java.lang.Object	getRaster() The source raster object.
java.lang.Object	getRaster2() The second source raster object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ILongArray	getToClassValues() The list of class values to be selected from the to raster.
int	getUseColorMethod() The Compute Change Use Color Method.
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	putValue(java.lang.String name, java.lang.Object value) Puts a named argument value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.String name) Removes a named argument value.
void	removeAll() Removes all argument values.
void	resolve(IRow pRow, IPropertySet pPropertySet) Resolves function variables using a row and set of properties.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCellsizeType(int pType) The different ways for estimating cellsize.
void	setExtentType(int pType) The different ways for estimating extent.
void	setFromClassValuesByRef(ILongArray ppClassValues) The list of class values to be selected from the from raster.
void	setKeepMethod(int pMethod) The Compute Change Keep Method.
void	setMethod(int pMethod) The Compute Change Method.
void	setRaster2ByRef(java.lang.Object ppRaster2) The second source raster object.
void	setRasterByRef(java.lang.Object ppRaster) The source raster object.
void	setToClassValuesByRef(ILongArray ppClassValues) The list of class values to be selected from the to raster.
void	setUseColorMethod(int pMethod) The Compute Change Use Color Method.
IJSONObject	toJSON() Saves raster function arguments to JSON.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

ComputeChangeFunctionArguments

public ComputeChangeFunctionArguments()
                               throws java.io.IOException,
                                      java.net.UnknownHostException

Constructs a ComputeChangeFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ComputeChangeFunctionArguments

public ComputeChangeFunctionArguments(java.lang.Object obj)
                               throws java.io.IOException

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Gets a named argument value.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Puts a named argument value.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Removes a named argument value.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all argument values.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException

The list of all argument names.

Specified by:

getNames in interface IRasterFunctionArguments

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.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException

The list of all arguments.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IVariantArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException

The list of all files associated with the arguments.

Specified by:

getFileList in interface IRasterFunctionArguments

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.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

Specified by:

resolve in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws java.io.IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Specified by:

update in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toJSON

public IJSONObject toJSON()
                   throws java.io.IOException,
                          AutomationException

Saves raster function arguments to JSON.

Specified by:

toJSON in interface IRasterFunctionArguments2

Returns:

A reference to a com.esri.arcgis.system.IJSONObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fromJSON

public void fromJSON(IJSONObject pJSON,
                     IRasterFunctionTemplateMapper pOptRFTMapper)
              throws java.io.IOException,
                     AutomationException

Loads raster function arguments from JSON.

Specified by:

fromJSON in interface IRasterFunctionArguments2

Parameters:

pJSON - A reference to a com.esri.arcgis.system.IJSONObject (in)

pOptRFTMapper - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

public java.lang.Object getRaster()
                           throws java.io.IOException,
                                  AutomationException

The source raster object.

Specified by:

getRaster in interface IComputeChangeFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(java.lang.Object ppRaster)
                    throws java.io.IOException,
                           AutomationException

The source raster object.

Specified by:

setRasterByRef in interface IComputeChangeFunctionArguments

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster2

public java.lang.Object getRaster2()
                            throws java.io.IOException,
                                   AutomationException

The second source raster object.

Specified by:

getRaster2 in interface IComputeChangeFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRaster2ByRef

public void setRaster2ByRef(java.lang.Object ppRaster2)
                     throws java.io.IOException,
                            AutomationException

The second source raster object.

Specified by:

setRaster2ByRef in interface IComputeChangeFunctionArguments

Parameters:

ppRaster2 - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMethod

public int getMethod()
              throws java.io.IOException,
                     AutomationException

The Compute Change Method.

Specified by:

getMethod in interface IComputeChangeFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriComputeChangeMethod constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMethod

public void setMethod(int pMethod)
               throws java.io.IOException,
                      AutomationException

The Compute Change Method.

Specified by:

setMethod in interface IComputeChangeFunctionArguments

Parameters:

pMethod - A com.esri.arcgis.datasourcesraster.esriComputeChangeMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromClassValues

public ILongArray getFromClassValues()
                              throws java.io.IOException,
                                     AutomationException

The list of class values to be selected from the from raster. Empty means all classes.

Specified by:

getFromClassValues in interface IComputeChangeFunctionArguments2

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromClassValuesByRef

public void setFromClassValuesByRef(ILongArray ppClassValues)
                             throws java.io.IOException,
                                    AutomationException

The list of class values to be selected from the from raster. Empty means all classes.

Specified by:

setFromClassValuesByRef in interface IComputeChangeFunctionArguments2

Parameters:

ppClassValues - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToClassValues

public ILongArray getToClassValues()
                            throws java.io.IOException,
                                   AutomationException

The list of class values to be selected from the to raster. Empty means all classes.

Specified by:

getToClassValues in interface IComputeChangeFunctionArguments2

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToClassValuesByRef

public void setToClassValuesByRef(ILongArray ppClassValues)
                           throws java.io.IOException,
                                  AutomationException

The list of class values to be selected from the to raster. Empty means all classes.

Specified by:

setToClassValuesByRef in interface IComputeChangeFunctionArguments2

Parameters:

ppClassValues - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeepMethod

public int getKeepMethod()
                  throws java.io.IOException,
                         AutomationException

The Compute Change Keep Method.

Specified by:

getKeepMethod in interface IComputeChangeFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriComputeChangeKeepMethod constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepMethod

public void setKeepMethod(int pMethod)
                   throws java.io.IOException,
                          AutomationException

The Compute Change Keep Method.

Specified by:

setKeepMethod in interface IComputeChangeFunctionArguments2

Parameters:

pMethod - A com.esri.arcgis.datasourcesraster.esriComputeChangeKeepMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUseColorMethod

public int getUseColorMethod()
                      throws java.io.IOException,
                             AutomationException

The Compute Change Use Color Method.

Specified by:

getUseColorMethod in interface IComputeChangeFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriComputeChangeUseColorMethod constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseColorMethod

public void setUseColorMethod(int pMethod)
                       throws java.io.IOException,
                              AutomationException

The Compute Change Use Color Method.

Specified by:

setUseColorMethod in interface IComputeChangeFunctionArguments2

Parameters:

pMethod - A com.esri.arcgis.datasourcesraster.esriComputeChangeUseColorMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtentType

public int getExtentType()
                  throws java.io.IOException,
                         AutomationException

The different ways for estimating extent.

Specified by:

getExtentType in interface IComputeChangeFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriExtentType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentType

public void setExtentType(int pType)
                   throws java.io.IOException,
                          AutomationException

The different ways for estimating extent.

Specified by:

setExtentType in interface IComputeChangeFunctionArguments2

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriExtentType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellsizeType

public int getCellsizeType()
                    throws java.io.IOException,
                           AutomationException

The different ways for estimating cellsize.

Specified by:

getCellsizeType in interface IComputeChangeFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriCellsizeType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellsizeType

public void setCellsizeType(int pType)
                     throws java.io.IOException,
                            AutomationException

The different ways for estimating cellsize.

Specified by:

setCellsizeType in interface IComputeChangeFunctionArguments2

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriCellsizeType constant (in)

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.

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.

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.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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