com.esri.arcgis.datasourcesraster

Class RasterInfoFunction

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterInfoFunction

All Implemented Interfaces:

IRasterFunction, IRasterFunction2, IRasterKeyProperties, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class RasterInfoFunction
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunction, IRasterFunction2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, IRasterKeyProperties, java.io.Externalizable

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

Description 'The raster info function for modifying raster properties.' 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.IRasterFunction

IID, IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e, xxDummy

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

IID, IIDcb7476d9_8621_4a5e_a693_adba10f25308, 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.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

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

IID, IID01002227_f833_40aa_a0c9_429ea383c51f, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.Object pArguments) Binds function arguments to this raster function.
void	clearCache(java.lang.Object pArguments) Clear the cache.
IGeometry	computeFootprint(int maximumVertices) Computes the footprint.
void	computeFootprintAndCenter(int maximumVertices, IGeometry[] ppFootprint, IGeometry[] ppCenter) Computes the footprint and center.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getAllBandProperties(int bandIndex, IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available band-specific key properties.
void	getAllProperties(IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available key properties.
java.lang.Object	getBandProperty(java.lang.String sName, int bandIndex) Returns the requested key property by name for a given band.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() The raster function description.
void	getFiles(IGeometry pGeometry, IStringArray ppFiles) Gets source files within a given clipping geometry.
int	getInvalidDatasetProperties() The properties to be invalidated when a function raster dataset is initialized.
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).
java.lang.String	getName() The raster function name.
int	getPixelType() The output pixel type.
void	getProcessingCost(double[] pProcessingCost) getProcessingCost
java.lang.Object	getProperty(java.lang.String sName) Returns the requested key property by name.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isActive() Indicates if the function is actively participating in the chain.
boolean	isCacheStale() Indicates if the raster cache is stale and needs to be refreshed.
void	isDirty() isDirty
boolean	isValid() Indicates if this function is valid, e.g.
void	load(IStream pstm) load
void	read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	readExternal(java.io.ObjectInput in)
void	refreshCache() Refresh raster cache.
void	release() Release this COM object reference
void	removeBandProperty(java.lang.String sName, int bandIndex) Removes all occurrences of the specified key property for a given band.
void	removeProperty(java.lang.String sName) Removes all occurrences of the specified key property.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBandProperty(java.lang.String sName, int bandIndex, java.lang.Object vtValue) Updates the value of the specified key property by name for a given band.
void	setDescription(java.lang.String pDescription) The raster function description.
void	setInvalidDatasetProperties(int pDatasetProperties) The properties to be invalidated when a function raster dataset is initialized.
void	setName(java.lang.String pName) The raster function name.
void	setPixelType(int pPixelType) The output pixel type.
void	setProperty(java.lang.String sName, java.lang.Object vtValue) Updates the value of the specified key property by name.
void	update() Updates using newly available information from bound object.
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

RasterInfoFunction

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

Constructs a RasterInfoFunction using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterInfoFunction

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

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

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

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

getName

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

The raster function name.

Specified by:

getName in interface IRasterFunction

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException

The raster function name.

Specified by:

setName in interface IRasterFunction

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The raster function description.

Specified by:

getDescription in interface IRasterFunction

Returns:

The pDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pDescription)
                    throws java.io.IOException,
                           AutomationException

The raster function description.

Specified by:

setDescription in interface IRasterFunction

Parameters:

pDescription - The pDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

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

The output pixel type.

Specified by:

getPixelType in interface IRasterFunction

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int pPixelType)
                  throws java.io.IOException,
                         AutomationException

The output pixel type.

Specified by:

setPixelType in interface IRasterFunction

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bind

public void bind(java.lang.Object pArguments)
          throws java.io.IOException,
                 AutomationException

Binds function arguments to this raster function.

Specified by:

bind in interface IRasterFunction

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if this function is valid, e.g. bound to an object, and etc.

Specified by:

isValid in interface IRasterFunction

Returns:

The pValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates using newly available information from bound object.

Specified by:

update in interface IRasterFunction

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

public IRasterInfo getRasterInfo()
                          throws java.io.IOException,
                                 AutomationException

The raster information after this function is applied to an object.

Specified by:

getRasterInfo in interface IRasterFunction

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

read

public void read(IPnt pTlc,
                 IRaster pRaster,
                 IPixelBlock pPixelBlock)
          throws java.io.IOException,
                 AutomationException

Reads a pixel block starting from the top left corner.

Specified by:

read in interface IRasterFunction

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

computeFootprint

public IGeometry computeFootprint(int maximumVertices)
                           throws java.io.IOException,
                                  AutomationException

Computes the footprint.

Specified by:

computeFootprint in interface IRasterFunction2

Parameters:

maximumVertices - The maximumVertices (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshCache

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

Refresh raster cache.

Specified by:

refreshCache in interface IRasterFunction2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearCache

public void clearCache(java.lang.Object pArguments)
                throws java.io.IOException,
                       AutomationException

Clear the cache.

Specified by:

clearCache in interface IRasterFunction2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFiles

public void getFiles(IGeometry pGeometry,
                     IStringArray ppFiles)
              throws java.io.IOException,
                     AutomationException

Gets source files within a given clipping geometry.

Specified by:

getFiles in interface IRasterFunction2

Parameters:

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

ppFiles - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProcessingCost

public void getProcessingCost(double[] pProcessingCost)
                       throws java.io.IOException,
                              AutomationException

getProcessingCost

Specified by:

getProcessingCost in interface IRasterFunction2

Parameters:

pProcessingCost - The pProcessingCost (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCacheStale

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

Indicates if the raster cache is stale and needs to be refreshed.

Specified by:

isCacheStale in interface IRasterFunction2

Returns:

The pIsStale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isActive

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

Indicates if the function is actively participating in the chain.

Specified by:

isActive in interface IRasterFunction2

Returns:

The pIsActive

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInvalidDatasetProperties

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

The properties to be invalidated when a function raster dataset is initialized.

Specified by:

getInvalidDatasetProperties in interface IRasterFunction2

Returns:

The pDatasetProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInvalidDatasetProperties

public void setInvalidDatasetProperties(int pDatasetProperties)
                                 throws java.io.IOException,
                                        AutomationException

The properties to be invalidated when a function raster dataset is initialized.

Specified by:

setInvalidDatasetProperties in interface IRasterFunction2

Parameters:

pDatasetProperties - The pDatasetProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

computeFootprintAndCenter

public void computeFootprintAndCenter(int maximumVertices,
                                      IGeometry[] ppFootprint,
                                      IGeometry[] ppCenter)
                               throws java.io.IOException,
                                      AutomationException

Computes the footprint and center.

Specified by:

computeFootprintAndCenter in interface IRasterFunction2

Parameters:

maximumVertices - The maximumVertices (in)

ppFootprint - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

ppCenter - A reference to a com.esri.arcgis.geometry.IGeometry (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.

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.

getProperty

public java.lang.Object getProperty(java.lang.String sName)
                             throws java.io.IOException,
                                    AutomationException

Returns the requested key property by name.

Specified by:

getProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(java.lang.String sName,
                        java.lang.Object vtValue)
                 throws java.io.IOException,
                        AutomationException

Updates the value of the specified key property by name.

Specified by:

setProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

vtValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeProperty

public void removeProperty(java.lang.String sName)
                    throws java.io.IOException,
                           AutomationException

Removes all occurrences of the specified key property.

Specified by:

removeProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllProperties

public void getAllProperties(IStringArray[] ppNames,
                             IVariantArray[] ppValues)
                      throws java.io.IOException,
                             AutomationException

Queries all available key properties.

Specified by:

getAllProperties in interface IRasterKeyProperties

Parameters:

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandProperty

public java.lang.Object getBandProperty(java.lang.String sName,
                                        int bandIndex)
                                 throws java.io.IOException,
                                        AutomationException

Returns the requested key property by name for a given band.

Specified by:

getBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandProperty

public void setBandProperty(java.lang.String sName,
                            int bandIndex,
                            java.lang.Object vtValue)
                     throws java.io.IOException,
                            AutomationException

Updates the value of the specified key property by name for a given band.

Specified by:

setBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

vtValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeBandProperty

public void removeBandProperty(java.lang.String sName,
                               int bandIndex)
                        throws java.io.IOException,
                               AutomationException

Removes all occurrences of the specified key property for a given band.

Specified by:

removeBandProperty in interface IRasterKeyProperties

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllBandProperties

public void getAllBandProperties(int bandIndex,
                                 IStringArray[] ppNames,
                                 IVariantArray[] ppValues)
                          throws java.io.IOException,
                                 AutomationException

Queries all available band-specific key properties.

Specified by:

getAllBandProperties in interface IRasterKeyProperties

Parameters:

bandIndex - The bandIndex (in)

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

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