com.esri.arcgis.carto
Interface IMapCooker2

All Superinterfaces:

IMapCooker, Serializable

All Known Implementing Classes:

MapCooker, MapCookerX

public interface IMapCooker2
extends IMapCooker, Serializable

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

Description

This interface is new at ArcGIS 9.3. It supersedes IMapCooker.

Product Availability

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

Method Summary

void	deleteByExtent(IMap pMap, ILayer pLayer, IEnvelope pExtent, ILongArray pLevels, ITrackCancel pTrackCancel) Deletes cache for a given layer within a given extent.
void	getStatusTileCount(int[] pTileCount) number of tiles processed in the current job
ITileImageInfo	getTileImageInfo() The map cache tile image info.
boolean	isCacheOnDemand() Indicates if the service is cached on demand.
void	setCacheOnDemand(boolean pCacheOnDemand) Indicates if the service is cached on demand.
void	setTileImageInfoByRef(ITileImageInfo ppInfo) The map cache tile image info.
void	updateByGeometry(IMap pMap, ILayer pLayer, IDisplay pDisplay, IGeometry pGeometry, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Deletes cache for a given layer within a given extent.
void	updateMapServerCacheScales(IDoubleArray pScales) Updates Map Server's Cache Scales.
void	writeTilingScheme(ITileCacheInfo pCacheInfo, ITileImageInfo pTileImageInfo, String cacheDir, String layerName) Writes the tiling scheme for the service.

Methods inherited from interface com.esri.arcgis.carto.IMapCooker

addCachedLayers, addLayer, clear, clearAll, connect, delete, draw, exit, generate, getCacheDirectory, getExtent, getFormat, getMaxTileCount, getNumLevels, getPath, getTile, getTileCacheInfo, hasCache, hasLayerCache, isAntialiasing, putTile, putTilePosition, queryTilePosition, setAntialiasing, setDefaultLODInfos, setExtent, setFormat, setMaxTileCount, setPath, setTileCacheInfoByRef, snap, update

Method Detail

getTileImageInfo

ITileImageInfo getTileImageInfo()
                                throws IOException,
                                       AutomationException

The map cache tile image info.

Product Availability

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

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

void setTileImageInfoByRef(ITileImageInfo ppInfo)
                           throws IOException,
                                  AutomationException

The map cache tile image info.

Product Availability

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

Parameters:

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

setCacheOnDemand

void setCacheOnDemand(boolean pCacheOnDemand)
                      throws IOException,
                             AutomationException

Indicates if the service is cached on demand.

Product Availability

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

Parameters:

pCacheOnDemand - The pCacheOnDemand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheOnDemand

boolean isCacheOnDemand()
                        throws IOException,
                               AutomationException

Indicates if the service is cached on demand.

Product Availability

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

Returns:

The pCacheOnDemand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeTilingScheme

void writeTilingScheme(ITileCacheInfo pCacheInfo,
                       ITileImageInfo pTileImageInfo,
                       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)

cacheDir - The cacheDir (in)

layerName - The layerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateMapServerCacheScales

void updateMapServerCacheScales(IDoubleArray pScales)
                                throws IOException,
                                       AutomationException

Updates Map Server's Cache Scales.

Product Availability

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

Parameters:

pScales - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteByExtent

void deleteByExtent(IMap pMap,
                    ILayer pLayer,
                    IEnvelope pExtent,
                    ILongArray pLevels,
                    ITrackCancel pTrackCancel)
                    throws IOException,
                           AutomationException

Deletes cache for a given layer within a given extent.

Product Availability

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

Parameters:

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

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

updateByGeometry

void updateByGeometry(IMap pMap,
                      ILayer pLayer,
                      IDisplay pDisplay,
                      IGeometry pGeometry,
                      ILongArray pLevels,
                      int updateMode,
                      ITrackCancel pTrackCancel)
                      throws IOException,
                             AutomationException

Deletes cache for a given layer within a given extent.

Product Availability

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

Parameters:

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

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

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

updateMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (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.

getStatusTileCount

void getStatusTileCount(int[] pTileCount)
                        throws IOException,
                               AutomationException

number of tiles processed in the current job

Product Availability

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

Parameters:

pTileCount - The pTileCount (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.