com.esri.arcgis.datasourcesraster

Class ObjectMemoizer

java.lang.Object

com.esri.arcgis.datasourcesraster.ObjectMemoizer

All Implemented Interfaces:

IObjectMemoizer, IObjectMemoizer2, IObjectMemoizerDiskCache, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class ObjectMemoizer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectMemoizer, IObjectMemoizer2, IObjectMemoizerDiskCache, IPersistStream, IPersist, java.io.Externalizable

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

Description 'A basic LRU-based object memoizer.' 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.IObjectMemoizer2

IID, IID5efa79c4_5bbc_4461_98b9_ce8341e4ccd9, xxDummy

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

IID70e17160_11c3_40f5_87fd_3e58826b3b3a

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

IID, IIDab74228b_3792_4d42_9118_1a1c46a7c2e9, 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object vtKey, java.lang.Object ppObject) Memoizes an object uniquely associated with the specified key.
void	clear() Clears the object cache associated with the memoizer.
boolean	equals(java.lang.Object o) Compare this object with another
boolean	exists(java.lang.Object vtKey) Returns TRUE if a previously memoized object associated with the specified key is found.
java.lang.Object	get(java.lang.Object vtKey) Retrieves the previously memoized object associated with the specified key and increments its usage count.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() The number of object currently held by the memoizer.
java.lang.String	getFolderPath() The path to the parent folder for storing cached objects.
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.
IVariantArray	getKeys() The set of keys associated with this object memoizer.
int	getMaximumSize() The maximum allowed number of objects held by the memoizer.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isCacheEnabled() Indicates whether disk-based caching is enabled.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.Object vtKey) Removes the previously memoized object associated with the specified key.
void	save(IStream pstm, int fClearDirty) save
void	setCacheEnabled(boolean pbCacheEnabled) Indicates whether disk-based caching is enabled.
void	setFolderPath(java.lang.String pbsFolderPath) The path to the parent folder for storing cached objects.
void	setMaximumSize(int pMaximumSize) The maximum allowed number of objects held by the memoizer.
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

ObjectMemoizer

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

Constructs a ObjectMemoizer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ObjectMemoizer

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

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

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

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

add

public void add(java.lang.Object vtKey,
                java.lang.Object ppObject)
         throws java.io.IOException,
                AutomationException

Memoizes an object uniquely associated with the specified key. Adding more objects than allowed (as indicated by the .MaximumSize property) would cause one or more previously memoized items to be removed based on an implementation-specific eviction strategy.

Specified by:

add in interface IObjectMemoizer

Parameters:

vtKey - A Variant (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

get

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

Retrieves the previously memoized object associated with the specified key and increments its usage count.

Specified by:

get in interface IObjectMemoizer

Parameters:

vtKey - A Variant (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists(java.lang.Object vtKey)
               throws java.io.IOException,
                      AutomationException

Returns TRUE if a previously memoized object associated with the specified key is found.

Specified by:

exists in interface IObjectMemoizer

Parameters:

vtKey - A Variant (in)

Returns:

The pbExists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Clears the object cache associated with the memoizer.

Specified by:

clear in interface IObjectMemoizer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of object currently held by the memoizer.

Specified by:

getCount in interface IObjectMemoizer

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumSize

public void setMaximumSize(int pMaximumSize)
                    throws java.io.IOException,
                           AutomationException

The maximum allowed number of objects held by the memoizer.

Specified by:

setMaximumSize in interface IObjectMemoizer

Parameters:

pMaximumSize - The pMaximumSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumSize

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

The maximum allowed number of objects held by the memoizer.

Specified by:

getMaximumSize in interface IObjectMemoizer

Returns:

The pMaximumSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.Object vtKey)
            throws java.io.IOException,
                   AutomationException

Removes the previously memoized object associated with the specified key.

Specified by:

remove in interface IObjectMemoizer

Parameters:

vtKey - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeys

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

The set of keys associated with this object memoizer.

Specified by:

getKeys in interface IObjectMemoizer2

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.

isCacheEnabled

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

Indicates whether disk-based caching is enabled.

Specified by:

isCacheEnabled in interface IObjectMemoizerDiskCache

Returns:

The pbCacheEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheEnabled

public void setCacheEnabled(boolean pbCacheEnabled)
                     throws java.io.IOException,
                            AutomationException

Indicates whether disk-based caching is enabled.

Specified by:

setCacheEnabled in interface IObjectMemoizerDiskCache

Parameters:

pbCacheEnabled - The pbCacheEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolderPath

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

The path to the parent folder for storing cached objects.

Specified by:

getFolderPath in interface IObjectMemoizerDiskCache

Returns:

The pbsFolderPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFolderPath

public void setFolderPath(java.lang.String pbsFolderPath)
                   throws java.io.IOException,
                          AutomationException

The path to the parent folder for storing cached objects.

Specified by:

setFolderPath in interface IObjectMemoizerDiskCache

Parameters:

pbsFolderPath - The pbsFolderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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