com.esri.arcgis.carto
Class CacheDescriptionInfo

java.lang.Object
  com.esri.arcgis.carto.CacheDescriptionInfo

All Implemented Interfaces:

ICacheDescriptionInfo, ICacheDescriptionInfo2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class CacheDescriptionInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICacheDescriptionInfo, ICacheDescriptionInfo2, IXMLSerialize, IPersistStream, IPersist, IDocumentVersionSupportGEN, IXMLVersionSupport, Externalizable

Cache description info object.

Remarks

CacheDescriptionInfo includes information on a cached map service. This includes its cache type, its tiling scheme (TileCacheInfo), image information (TileImageInfo) and control information (TileControlInfo). The cache description also includes an array of layer cache infos that can be used to determine if a specific layer has a cache in the case of map services that have a multi layer cache.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CacheDescriptionInfo()
Constructs a CacheDescriptionInfo using ArcGIS Engine.

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

Method Summary

Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
ICacheControlInfo	getCacheControlInfo() CacheControlInfo object.
ICacheStorageInfo	getCacheStorageInfo() CacheStorageInfo object.
int	getCacheType() Cache type.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ILayerCacheInfos	getLayerCacheInfos() LayerCacheInfos object.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITileCacheInfo	getTileCacheInfo() TileCacheInfo object.
ITileImageInfo	getTileImageInfo() TileImageInfo object.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCacheControlInfoByRef(ICacheControlInfo ppCacheControlInfo) CacheControlInfo object.
void	setCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo) CacheStorageInfo object.
void	setCacheType(int pServiceType) Cache type.
void	setLayerCacheInfosByRef(ILayerCacheInfos ppLayerCacheInfos) LayerCacheInfos object.
void	setTileCacheInfoByRef(ITileCacheInfo ppTileCacheInfo) TileCacheInfo object.
void	setTileImageInfoByRef(ITileImageInfo ppTileIamgeInfo) TileImageInfo object.
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

CacheDescriptionInfo

public CacheDescriptionInfo()
                     throws IOException,
                            UnknownHostException

Constructs a CacheDescriptionInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CacheDescriptionInfo

public CacheDescriptionInfo(Object obj)
                     throws IOException

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

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

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

getTileCacheInfo

public ITileCacheInfo getTileCacheInfo()
                                throws IOException,
                                       AutomationException

TileCacheInfo object.

Product Availability

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

Specified by:

getTileCacheInfo in interface ICacheDescriptionInfo

Returns:

A reference to a com.esri.arcgis.carto.ITileCacheInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileCacheInfoByRef

public void setTileCacheInfoByRef(ITileCacheInfo ppTileCacheInfo)
                           throws IOException,
                                  AutomationException

TileCacheInfo object.

Product Availability

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

Specified by:

setTileCacheInfoByRef in interface ICacheDescriptionInfo

Parameters:

ppTileCacheInfo - A reference to a com.esri.arcgis.carto.ITileCacheInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileImageInfo

public ITileImageInfo getTileImageInfo()
                                throws IOException,
                                       AutomationException

TileImageInfo object.

Product Availability

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

Specified by:

getTileImageInfo in interface ICacheDescriptionInfo

Returns:

A reference to a com.esri.arcgis.carto.ITileImageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileImageInfoByRef

public void setTileImageInfoByRef(ITileImageInfo ppTileIamgeInfo)
                           throws IOException,
                                  AutomationException

TileImageInfo object.

Product Availability

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

Specified by:

setTileImageInfoByRef in interface ICacheDescriptionInfo

Parameters:

ppTileIamgeInfo - A reference to a com.esri.arcgis.carto.ITileImageInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

public ICacheControlInfo getCacheControlInfo()
                                      throws IOException,
                                             AutomationException

CacheControlInfo object.

Product Availability

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

Specified by:

getCacheControlInfo in interface ICacheDescriptionInfo

Returns:

A reference to a com.esri.arcgis.carto.ICacheControlInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheControlInfoByRef

public void setCacheControlInfoByRef(ICacheControlInfo ppCacheControlInfo)
                              throws IOException,
                                     AutomationException

CacheControlInfo object.

Product Availability

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

Specified by:

setCacheControlInfoByRef in interface ICacheDescriptionInfo

Parameters:

ppCacheControlInfo - A reference to a com.esri.arcgis.carto.ICacheControlInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCacheInfos

public ILayerCacheInfos getLayerCacheInfos()
                                    throws IOException,
                                           AutomationException

LayerCacheInfos object.

Product Availability

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

Specified by:

getLayerCacheInfos in interface ICacheDescriptionInfo

Returns:

A reference to a com.esri.arcgis.carto.ILayerCacheInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerCacheInfosByRef

public void setLayerCacheInfosByRef(ILayerCacheInfos ppLayerCacheInfos)
                             throws IOException,
                                    AutomationException

LayerCacheInfos object.

Product Availability

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

Specified by:

setLayerCacheInfosByRef in interface ICacheDescriptionInfo

Parameters:

ppLayerCacheInfos - A reference to a com.esri.arcgis.carto.ILayerCacheInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheType

public int getCacheType()
                 throws IOException,
                        AutomationException

Cache type.

Product Availability

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

Specified by:

getCacheType in interface ICacheDescriptionInfo

Returns:

A com.esri.arcgis.carto.esriCachedMapServiceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheType

public void setCacheType(int pServiceType)
                  throws IOException,
                         AutomationException

Cache type.

Product Availability

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

Specified by:

setCacheType in interface ICacheDescriptionInfo

Parameters:

pServiceType - A com.esri.arcgis.carto.esriCachedMapServiceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheStorageInfo

public ICacheStorageInfo getCacheStorageInfo()
                                      throws IOException,
                                             AutomationException

CacheStorageInfo object.

Product Availability

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

Specified by:

getCacheStorageInfo in interface ICacheDescriptionInfo2

Returns:

A reference to a com.esri.arcgis.carto.ICacheStorageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheStorageInfoByRef

public void setCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
                              throws IOException,
                                     AutomationException

CacheStorageInfo object.

Product Availability

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

Specified by:

setCacheStorageInfoByRef in interface ICacheDescriptionInfo2

Parameters:

ppCacheStorageInfo - A reference to a com.esri.arcgis.carto.ICacheStorageInfo (in)

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.

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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