com.esri.arcgis.carto
Interface IMapCooker3

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapCooker, MapCookerX

public interface IMapCooker3
extends Serializable

Provides access to more members that controls a map cache generator.

Product Availability

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

Method Summary

void	cleanUPState(Object pMapOrMapServerInfo, Object pLayerOrMapLayerInfo, IGeometry pGeometry, ILongArray pLevels, ITrackCancel pTrackCancel) Cleans up the state of current caching job.
ICacheDatasetInfo	getCacheDatasetInfo() The map cache dataset info.
ICacheStorageInfo	getCacheStorageInfo() The map cache storage info.
void	setCacheDatasetInfoByRef(ICacheDatasetInfo ppInfo) The map cache dataset info.
void	setCacheStorageInfoByRef(ICacheStorageInfo ppInfo) The map cache storage info.
void	writeTilingSchemeEx(ITileCacheInfo pCacheInfo, ITileImageInfo pTileImageInfo, ICacheStorageInfo pCacheStorageInfo, ICacheDatasetInfo pCacheDatasetInfo, String cacheDir, String layerName) Writes the tiling scheme for the service.

Method Detail

getCacheStorageInfo

ICacheStorageInfo getCacheStorageInfo()
                                      throws IOException,
                                             AutomationException

The map cache storage info.

Product Availability

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

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

void setCacheStorageInfoByRef(ICacheStorageInfo ppInfo)
                              throws IOException,
                                     AutomationException

The map cache storage info.

Product Availability

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

Parameters:

ppInfo - 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.

getCacheDatasetInfo

ICacheDatasetInfo getCacheDatasetInfo()
                                      throws IOException,
                                             AutomationException

The map cache dataset info.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheDatasetInfoByRef

void setCacheDatasetInfoByRef(ICacheDatasetInfo ppInfo)
                              throws IOException,
                                     AutomationException

The map cache dataset info.

Product Availability

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

Parameters:

ppInfo - A reference to a com.esri.arcgis.carto.ICacheDatasetInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeTilingSchemeEx

void writeTilingSchemeEx(ITileCacheInfo pCacheInfo,
                         ITileImageInfo pTileImageInfo,
                         ICacheStorageInfo pCacheStorageInfo,
                         ICacheDatasetInfo pCacheDatasetInfo,
                         String cacheDir,
                         String layerName)
                         throws IOException,
                                AutomationException

Writes the tiling scheme for the service.

Product Availability

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

Parameters:

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

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

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

pCacheDatasetInfo - A reference to a com.esri.arcgis.carto.ICacheDatasetInfo (in)

cacheDir - The cacheDir (in)

layerName - The layerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cleanUPState

void cleanUPState(Object pMapOrMapServerInfo,
                  Object pLayerOrMapLayerInfo,
                  IGeometry pGeometry,
                  ILongArray pLevels,
                  ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException

Cleans up the state of current caching job.

Product Availability

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

Parameters:

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

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

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

pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.