com.esri.arcgis.datasourcesraster

Class ArgStatisticsFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.ArgStatisticsFunctionArguments

All Implemented Interfaces:

IArgStatisticsFunctionArguments, IArgStatisticsFunctionArguments2, IRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class ArgStatisticsFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IArgStatisticsFunctionArguments, IArgStatisticsFunctionArguments2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'ArgStatisticsFunctionArguments'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for a function raster dataset.' 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.IRasterFunctionArguments

IID, IID04aa081e_28b0_47e4_b375_f367046da924, xxDummy

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

IID, IIDde592077_599e_436d_a66d_1dae75412399, xxDummy

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

IID01319911_4c27_4043_b374_47402bafe762

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
ArgStatisticsFunctionArguments() Constructs a ArgStatisticsFunctionArguments using ArcGIS Engine.
ArgStatisticsFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ArgStatisticsFunctionArguments theArgStatisticsFunctionArguments = (ArgStatisticsFunctionArguments) 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
int	getArgStatisticsType() The arg statistics type.
int	getCellsizeType() The different ways for estimating cellsize.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getComparisonType() The different comparison types for argument value statistic type.
double	getDurationMaximum() Duration's maximum value.
double	getDurationMinimum() Duration's minimum value.
int	getExtentType() The different ways for estimating extent.
IStringArray	getFileList() The list of all files associated with the arguments.
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.
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	getRasters() The input rasters.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getUndefinedClass() Undefined class value.
double	getValue() Value to be found in input raster(s).
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
boolean	isUseLastOccurrence() Return last occurrence value in case of ties.
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	setArgStatisticsType(int pType) The arg statistics type.
void	setCellsizeType(int pType) The different ways for estimating cellsize.
void	setComparisonType(int pType) The different comparison types for argument value statistic type.
void	setDurationMaximum(double max) Duration's maximum value.
void	setDurationMinimum(double min) Duration's minimum value.
void	setExtentType(int pType) The different ways for estimating extent.
void	setRastersByRef(java.lang.Object ppRasters) The input rasters.
void	setUndefinedClass(int undefinedClass) Undefined class value.
void	setUseLastOccurrence(boolean pbUseLastOccurrence) Return last occurrence value in case of ties.
void	setValue(double value) Value to be found in input raster(s).
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

ArgStatisticsFunctionArguments

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

Constructs a ArgStatisticsFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ArgStatisticsFunctionArguments

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

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

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

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.

getRasters

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

The input rasters.

Specified by:

getRasters in interface IArgStatisticsFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRastersByRef

public void setRastersByRef(java.lang.Object ppRasters)
                     throws java.io.IOException,
                            AutomationException

The input rasters.

Specified by:

setRastersByRef in interface IArgStatisticsFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgStatisticsType

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

The arg statistics type.

Specified by:

getArgStatisticsType in interface IArgStatisticsFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriArgStatisticsType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setArgStatisticsType

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

The arg statistics type.

Specified by:

setArgStatisticsType in interface IArgStatisticsFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUndefinedClass

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

Undefined class value.

Specified by:

getUndefinedClass in interface IArgStatisticsFunctionArguments

Returns:

The undefinedClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUndefinedClass

public void setUndefinedClass(int undefinedClass)
                       throws java.io.IOException,
                              AutomationException

Undefined class value.

Specified by:

setUndefinedClass in interface IArgStatisticsFunctionArguments

Parameters:

undefinedClass - The undefinedClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDurationMinimum

public double getDurationMinimum()
                          throws java.io.IOException,
                                 AutomationException

Duration's minimum value.

Specified by:

getDurationMinimum in interface IArgStatisticsFunctionArguments

Returns:

The min

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDurationMinimum

public void setDurationMinimum(double min)
                        throws java.io.IOException,
                               AutomationException

Duration's minimum value.

Specified by:

setDurationMinimum in interface IArgStatisticsFunctionArguments

Parameters:

min - The min (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDurationMaximum

public double getDurationMaximum()
                          throws java.io.IOException,
                                 AutomationException

Duration's maximum value.

Specified by:

getDurationMaximum in interface IArgStatisticsFunctionArguments

Returns:

The max

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDurationMaximum

public void setDurationMaximum(double max)
                        throws java.io.IOException,
                               AutomationException

Duration's maximum value.

Specified by:

setDurationMaximum in interface IArgStatisticsFunctionArguments

Parameters:

max - The max (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 IArgStatisticsFunctionArguments2

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 IArgStatisticsFunctionArguments2

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 IArgStatisticsFunctionArguments2

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 IArgStatisticsFunctionArguments2

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.

getValue

public double getValue()
                throws java.io.IOException,
                       AutomationException

Value to be found in input raster(s).

Specified by:

getValue in interface IArgStatisticsFunctionArguments2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(double value)
              throws java.io.IOException,
                     AutomationException

Value to be found in input raster(s).

Specified by:

setValue in interface IArgStatisticsFunctionArguments2

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseLastOccurrence

public boolean isUseLastOccurrence()
                            throws java.io.IOException,
                                   AutomationException

Return last occurrence value in case of ties.

Specified by:

isUseLastOccurrence in interface IArgStatisticsFunctionArguments2

Returns:

The pbUseLastOccurrence

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseLastOccurrence

public void setUseLastOccurrence(boolean pbUseLastOccurrence)
                          throws java.io.IOException,
                                 AutomationException

Return last occurrence value in case of ties.

Specified by:

setUseLastOccurrence in interface IArgStatisticsFunctionArguments2

Parameters:

pbUseLastOccurrence - The pbUseLastOccurrence (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getComparisonType

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

The different comparison types for argument value statistic type.

Specified by:

getComparisonType in interface IArgStatisticsFunctionArguments2

Returns:

A com.esri.arcgis.datasourcesraster.esriArgStatisticsComparisonType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComparisonType

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

The different comparison types for argument value statistic type.

Specified by:

setComparisonType in interface IArgStatisticsFunctionArguments2

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriArgStatisticsComparisonType 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