com.esri.arcgis.cartox
Interface IMapCookerX

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapCookerX

public interface IMapCookerX
extends Serializable

Provides access to map cooker.

Method Summary

void	addLayerX(String name, IMapLayerInfo pMapLayerInfo) Adds a layer to the map cache.
void	clearX(IMapLayerInfo pMapLayerInfo, IEnvelope pExtent) Clears cache for a given layer within a given extent.
void	connectX(String location, String name, IMapServer pMapServer) Connects to a given map service and its cache.
void	generateX(IMapServer pMapServer, IMapLayerInfo pMapLayerInfo, String mapName, ITrackCancel pTrackCancel) Fully generates cache for a given layer.
String	getCacheDirectoryX(IMapLayerInfo pMapLayerInfo) Gets cache directory for a given layer.
byte[]	getTileX(IMapLayerInfo pMapLayerInfo, int level, int row, int column) Gets a tile for a given tile location from a given layer.
boolean	hasLayerCacheX(IMapLayerInfo pMapLayerInfo) Indicates if there is a cache for a given layer.
void	putTileX(IMapLayerInfo pMapLayerInfo, int level, int row, int column, byte[] ppTile) Puts a tile for a given tile location for a given layer.
void	updateByGeometryX(IMapServer pMapServer, IMapLayerInfo pMapLayerInfo, String mapName, IGeometry pGeometry, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Deletes cache for a given layer within a given extent.
void	updateX(IMapServer pMapServer, IMapLayerInfo pMapLayerInfo, String mapName, IEnvelope pExtent, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Updates cache for a given layer within a given extent.

Method Detail

connectX

void connectX(String location,
              String name,
              IMapServer pMapServer)
              throws IOException,
                     AutomationException

Connects to a given map service and its cache.

Parameters:

location - The location (in)

name - The name (in)

pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerX

void addLayerX(String name,
               IMapLayerInfo pMapLayerInfo)
               throws IOException,
                      AutomationException

Adds a layer to the map cache.

Parameters:

name - The name (in)

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearX

void clearX(IMapLayerInfo pMapLayerInfo,
            IEnvelope pExtent)
            throws IOException,
                   AutomationException

Clears cache for a given layer within a given extent.

Parameters:

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasLayerCacheX

boolean hasLayerCacheX(IMapLayerInfo pMapLayerInfo)
                       throws IOException,
                              AutomationException

Indicates if there is a cache for a given layer.

Parameters:

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

Returns:

The pHasCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateX

void generateX(IMapServer pMapServer,
               IMapLayerInfo pMapLayerInfo,
               String mapName,
               ITrackCancel pTrackCancel)
               throws IOException,
                      AutomationException

Fully generates cache for a given layer.

Parameters:

pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

mapName - The mapName (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.

getTileX

byte[] getTileX(IMapLayerInfo pMapLayerInfo,
                int level,
                int row,
                int column)
                throws IOException,
                       AutomationException

Gets a tile for a given tile location from a given layer.

Parameters:

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

level - The level (in)

row - The row (in)

column - The column (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTileX

void putTileX(IMapLayerInfo pMapLayerInfo,
              int level,
              int row,
              int column,
              byte[] ppTile)
              throws IOException,
                     AutomationException

Puts a tile for a given tile location for a given layer.

Parameters:

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

level - The level (in)

row - The row (in)

column - The column (in)

ppTile - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheDirectoryX

String getCacheDirectoryX(IMapLayerInfo pMapLayerInfo)
                          throws IOException,
                                 AutomationException

Gets cache directory for a given layer.

Parameters:

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

Returns:

The pCacheDir

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateX

void updateX(IMapServer pMapServer,
             IMapLayerInfo pMapLayerInfo,
             String mapName,
             IEnvelope pExtent,
             ILongArray pLevels,
             int updateMode,
             ITrackCancel pTrackCancel)
             throws IOException,
                    AutomationException

Updates cache for a given layer within a given extent.

Parameters:

pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

mapName - The mapName (in)

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

updateByGeometryX

void updateByGeometryX(IMapServer pMapServer,
                       IMapLayerInfo pMapLayerInfo,
                       String mapName,
                       IGeometry pGeometry,
                       ILongArray pLevels,
                       int updateMode,
                       ITrackCancel pTrackCancel)
                       throws IOException,
                              AutomationException

Deletes cache for a given layer within a given extent.

Parameters:

pMapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

pMapLayerInfo - A reference to a com.esri.arcgis.carto.IMapLayerInfo (in)

mapName - The mapName (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.