com.esri.arcgis.datasourcesraster
Class CachedRasterFunctionArguments

java.lang.Object
  com.esri.arcgis.datasourcesraster.CachedRasterFunctionArguments

All Implemented Interfaces:

ICachedRasterFunctionArguments, IRasterCacheArguments, IRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class CachedRasterFunctionArguments
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, ICachedRasterFunctionArguments, IRasterCacheArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

The cached raster function arguments.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CachedRasterFunctionArguments()
Constructs a CachedRasterFunctionArguments using ArcGIS Engine.

CachedRasterFunctionArguments(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CachedRasterFunctionArguments theCachedRasterFunctionArguments = (CachedRasterFunctionArguments) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
String	getCacheBaseName() Name used for generating the CacheFileName.
IName	getCacheLocation() Location where the item cache gets generated.
void	getClassID(GUID[] pClassID) getClassID
IGeometry	getClippingGeometry() The clipping geometry that defines regions of valid pixels.
static String	getClsid() getClsid.
int	getCompressionQuality() The compression quality.
int	getCompressionType() The compression type.
IStringArray	getFileList() The list of all files associated with the arguments.
int	getMaxAllowedInputCols() The maximum number of cols allowed in the input raster for generating the cache.
int	getMaxAllowedInputRows() The maximum number of rows allowed in the input raster for generating the cache.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IStringArray	getNames() The list of all argument names.
Object	getRaster() The input raster.
double	getRequestSize() The request size used for resampling the item cache.
int	getRequestSizeType() The unit of the request size is determined by request size type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
Object	getValue(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(String name, Object value) Puts a named argument value.
void	readExternal(ObjectInput in)
void	remove(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	setCacheBaseName(String pCacheBaseName) Name used for generating the CacheFileName.
void	setCacheLocationByRef(IName ppName) Location where the item cache gets generated.
void	setClippingGeometryByRef(IGeometry ppClippingGeometry) The clipping geometry that defines regions of valid pixels.
void	setCompressionQuality(int value) The compression quality.
void	setCompressionType(int pType) The compression type.
void	setMaxAllowedInputCols(int pCols) The maximum number of cols allowed in the input raster for generating the cache.
void	setMaxAllowedInputRows(int pRows) The maximum number of rows allowed in the input raster for generating the cache.
void	setRasterByRef(Object ppRaster) The input raster.
void	setRequestSize(double pRequestSize) The request size used for resampling the item cache.
void	setRequestSizeType(int pRequestSizeType) The unit of the request size is determined by request size type.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

CachedRasterFunctionArguments

public CachedRasterFunctionArguments()
                              throws IOException,
                                     UnknownHostException

Constructs a CachedRasterFunctionArguments using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CachedRasterFunctionArguments

public CachedRasterFunctionArguments(Object obj)
                              throws IOException

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

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

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

getValue

public Object getValue(String name)
                throws IOException,
                       AutomationException

Gets a named argument value.

Product Availability

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

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(String name,
                     Object value)
              throws IOException,
                     AutomationException

Puts a named argument value.

Product Availability

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

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String name)
            throws IOException,
                   AutomationException

Removes a named argument value.

Product Availability

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

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all argument values.

Product Availability

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

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws IOException,
                             AutomationException

The list of all argument names.

Product Availability

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

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws IOException,
                               AutomationException

The list of all arguments.

Product Availability

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

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws IOException,
                                AutomationException

The list of all files associated with the arguments.

Product Availability

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

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

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

Resolves function variables using a row and set of properties.

Product Availability

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

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:

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 IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

public Object getRaster()
                 throws IOException,
                        AutomationException

The input raster.

Product Availability

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

Specified by:

getRaster in interface ICachedRasterFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The input raster.

Product Availability

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

Specified by:

setRasterByRef in interface ICachedRasterFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

public void setCompressionType(int pType)
                        throws IOException,
                               AutomationException

The compression type.

Product Availability

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

Specified by:

setCompressionType in interface ICachedRasterFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

public int getCompressionType()
                       throws IOException,
                              AutomationException

The compression type.

Product Availability

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

Specified by:

getCompressionType in interface ICachedRasterFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriCachedRasterCompressionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

public void setCompressionQuality(int value)
                           throws IOException,
                                  AutomationException

The compression quality.

Product Availability

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

Specified by:

setCompressionQuality in interface ICachedRasterFunctionArguments

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionQuality

public int getCompressionQuality()
                          throws IOException,
                                 AutomationException

The compression quality.

Product Availability

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

Specified by:

getCompressionQuality in interface ICachedRasterFunctionArguments

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputCols

public int getMaxAllowedInputCols()
                           throws IOException,
                                  AutomationException

The maximum number of cols allowed in the input raster for generating the cache.

Product Availability

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

Specified by:

getMaxAllowedInputCols in interface ICachedRasterFunctionArguments

Returns:

The pCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputCols

public void setMaxAllowedInputCols(int pCols)
                            throws IOException,
                                   AutomationException

The maximum number of cols allowed in the input raster for generating the cache.

Product Availability

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

Specified by:

setMaxAllowedInputCols in interface ICachedRasterFunctionArguments

Parameters:

pCols - The pCols (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxAllowedInputRows

public int getMaxAllowedInputRows()
                           throws IOException,
                                  AutomationException

The maximum number of rows allowed in the input raster for generating the cache.

Product Availability

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

Specified by:

getMaxAllowedInputRows in interface ICachedRasterFunctionArguments

Returns:

The pRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxAllowedInputRows

public void setMaxAllowedInputRows(int pRows)
                            throws IOException,
                                   AutomationException

The maximum number of rows allowed in the input raster for generating the cache.

Product Availability

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

Specified by:

setMaxAllowedInputRows in interface ICachedRasterFunctionArguments

Parameters:

pRows - The pRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheBaseName

public String getCacheBaseName()
                        throws IOException,
                               AutomationException

Name used for generating the CacheFileName. GUID is used if this is not specified.

Product Availability

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

Specified by:

getCacheBaseName in interface ICachedRasterFunctionArguments

Returns:

The pCacheBaseName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheBaseName

public void setCacheBaseName(String pCacheBaseName)
                      throws IOException,
                             AutomationException

Name used for generating the CacheFileName. GUID is used if this is not specified.

Product Availability

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

Specified by:

setCacheBaseName in interface ICachedRasterFunctionArguments

Parameters:

pCacheBaseName - The pCacheBaseName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClippingGeometry

public IGeometry getClippingGeometry()
                              throws IOException,
                                     AutomationException

The clipping geometry that defines regions of valid pixels. This geometry may have a coordinate system different from the corresponding dataset.

Product Availability

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

Specified by:

getClippingGeometry in interface ICachedRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClippingGeometryByRef

public void setClippingGeometryByRef(IGeometry ppClippingGeometry)
                              throws IOException,
                                     AutomationException

The clipping geometry that defines regions of valid pixels. This geometry may have a coordinate system different from the corresponding dataset.

Product Availability

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

Specified by:

setClippingGeometryByRef in interface ICachedRasterFunctionArguments

Parameters:

ppClippingGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestSize

public double getRequestSize()
                      throws IOException,
                             AutomationException

The request size used for resampling the item cache.

Product Availability

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

Specified by:

getRequestSize in interface ICachedRasterFunctionArguments

Returns:

The pRequestSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSize

public void setRequestSize(double pRequestSize)
                    throws IOException,
                           AutomationException

The request size used for resampling the item cache.

Product Availability

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

Specified by:

setRequestSize in interface ICachedRasterFunctionArguments

Parameters:

pRequestSize - The pRequestSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestSizeType

public int getRequestSizeType()
                       throws IOException,
                              AutomationException

The unit of the request size is determined by request size type.

Product Availability

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

Specified by:

getRequestSizeType in interface ICachedRasterFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSizeType

public void setRequestSizeType(int pRequestSizeType)
                        throws IOException,
                               AutomationException

The unit of the request size is determined by request size type.

Product Availability

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

Specified by:

setRequestSizeType in interface ICachedRasterFunctionArguments

Parameters:

pRequestSizeType - A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheLocation

public IName getCacheLocation()
                       throws IOException,
                              AutomationException

Location where the item cache gets generated. This could be a workspace name or a table name

Product Availability

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

Specified by:

getCacheLocation in interface IRasterCacheArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheLocationByRef

public void setCacheLocationByRef(IName ppName)
                           throws IOException,
                                  AutomationException

Location where the item cache gets generated. This could be a workspace name or a table name

Product Availability

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

Specified by:

setCacheLocationByRef in interface IRasterCacheArguments

Parameters:

ppName - A reference to a com.esri.arcgis.system.IName (in)

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.

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.

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.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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