Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IMapCooker

All Superinterfaces:
Serializable
All Known Subinterfaces:
IMapCooker2
All Known Implementing Classes:
ImageCooker, MapCooker, MapCookerX
public interface IMapCooker
extends Serializable

Provides access to members that controls a map cache generator.

Superseded By

IMapCooker2

Product Availability

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

Method Summary
 void addCachedLayers(IMap pMap)
          Adds all cached layers in the map cache.
 void addLayer(String name, ILayer pLayer)
          Adds a layer to the map cache.
 void clear(ILayer pLayer, IEnvelope pExtent)
          Clears cache for a given layer within a given extent.
 void clearAll()
          Clears cache for all layers.
 void connect(String location, String name, IMap pMap)
          Connects to a given map and its cache.
 void delete()
          Deletes map service cache directory.
 void draw(ILayer pLayer, IDisplay pDisplay, ITrackCancel pTrackCancel)
          Draws a given layer to the specified display.
 void exit()
          Exits the map cache generator host process.
 void generate(IMap pMap, ILayer pLayer, IDisplay pDisplay, ITrackCancel pTrackCancel)
          Fully generates cache for a given layer.
 String getCacheDirectory(ILayer pLayer)
          Gets cache directory for a given layer.
 IEnvelope getExtent()
          The map cache extent.
 String getFormat()
          The tile cache format.
 int getMaxTileCount()
          The maximum number of map tiles to be generated.
 int getNumLevels()
          The number of map cache levels.
 String getPath()
          The map cache path.
 byte[] getTile(ILayer pLayer, int level, int row, int column)
          Gets a tile for a given tile location from a given layer.
 ITileCacheInfo getTileCacheInfo()
          The tile cache info.
 boolean hasCache()
          Indicates if there is any cache.
 boolean hasLayerCache(ILayer pLayer)
          Indicates if there is a cache for a given layer.
 boolean isAntialiasing()
          Indicates if antialiasing should be used.
 void putTile(ILayer pLayer, int level, int row, int column, byte[] ppTile)
          Puts a tile for a given tile location for a given layer.
 void putTilePosition(int level, int row, int column)
          Sets the current map tile position.
 void queryTilePosition(int[] pLevel, int[] pRow, int[] pColumn)
          Queries for the current map tile position.
 void setAntialiasing(boolean pAntialiasing)
          Indicates if antialiasing should be used.
 void setDefaultLODInfos(int numLevels)
          Sets default LOD Info for a given number of levels.
 void setExtent(IEnvelope ppExtent)
          The map cache extent.
 void setFormat(String pFormat)
          The tile cache format.
 void setMaxTileCount(int pNumTiles)
          The maximum number of map tiles to be generated.
 void setPath(String pPath)
          The map cache path.
 void setTileCacheInfoByRef(ITileCacheInfo ppCacheInfo)
          The tile cache info.
 void snap(IDisplay pDisplay, IEnvelope pExtent)
          Snaps a view extent to one of map cache levels.
 void update(IMap pMap, ILayer pLayer, IDisplay pDisplay, IEnvelope pExtent, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel)
          Updates cache for a given layer within a given extent.
 

Method Detail

getPath

String getPath()
               throws IOException,
                      AutomationException
The map cache path.

Product Availability

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

Returns:
The pPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPath

void setPath(String pPath)
             throws IOException,
                    AutomationException
The map cache path.

Product Availability

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

Parameters:
pPath - The pPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The map cache extent.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope ppExtent)
               throws IOException,
                      AutomationException
The map cache extent.

Product Availability

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

Parameters:
ppExtent - 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.

getFormat

String getFormat()
                 throws IOException,
                        AutomationException
The tile cache format.

Product Availability

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

Returns:
The pFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(String pFormat)
               throws IOException,
                      AutomationException
The tile cache format.

Product Availability

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

Parameters:
pFormat - The pFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAntialiasing

boolean isAntialiasing()
                       throws IOException,
                              AutomationException
Indicates if antialiasing should be used.

Product Availability

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

Returns:
The pAntialiasing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAntialiasing

void setAntialiasing(boolean pAntialiasing)
                     throws IOException,
                            AutomationException
Indicates if antialiasing should be used.

Product Availability

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

Parameters:
pAntialiasing - The pAntialiasing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileCacheInfo

ITileCacheInfo getTileCacheInfo()
                                throws IOException,
                                       AutomationException
The tile cache info.

Product Availability

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

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

void setTileCacheInfoByRef(ITileCacheInfo ppCacheInfo)
                           throws IOException,
                                  AutomationException
The tile cache info.

Product Availability

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

Parameters:
ppCacheInfo - 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.

getNumLevels

int getNumLevels()
                 throws IOException,
                        AutomationException
The number of map cache levels.

Product Availability

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

Returns:
The pNumLevels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

void connect(String location,
             String name,
             IMap pMap)
             throws IOException,
                    AutomationException
Connects to a given map and its cache.

Product Availability

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

Parameters:
location - The location (in)
name - The name (in)
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addCachedLayers

void addCachedLayers(IMap pMap)
                     throws IOException,
                            AutomationException
Adds all cached layers in the map cache.

Product Availability

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

Parameters:
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(String name,
              ILayer pLayer)
              throws IOException,
                     AutomationException
Adds a layer to the map cache.

Product Availability

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

Parameters:
name - The name (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear(ILayer pLayer,
           IEnvelope pExtent)
           throws IOException,
                  AutomationException
Clears cache for a given layer within a given extent.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (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.

clearAll

void clearAll()
              throws IOException,
                     AutomationException
Clears cache for all layers.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

snap

void snap(IDisplay pDisplay,
          IEnvelope pExtent)
          throws IOException,
                 AutomationException
Snaps a view extent to one of map cache levels.

Product Availability

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

Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (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.

draw

void draw(ILayer pLayer,
          IDisplay pDisplay,
          ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException
Draws a given layer to the specified display.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (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.

setDefaultLODInfos

void setDefaultLODInfos(int numLevels)
                        throws IOException,
                               AutomationException
Sets default LOD Info for a given number of levels.

Product Availability

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

Parameters:
numLevels - The numLevels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generate

void generate(IMap pMap,
              ILayer pLayer,
              IDisplay pDisplay,
              ITrackCancel pTrackCancel)
              throws IOException,
                     AutomationException
Fully generates cache for a given layer.

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

hasCache

boolean hasCache()
                 throws IOException,
                        AutomationException
Indicates if there is any cache.

Product Availability

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

Returns:
The pHasCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasLayerCache

boolean hasLayerCache(ILayer pLayer)
                      throws IOException,
                             AutomationException
Indicates if there is a cache for a given layer.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The pHasCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTile

byte[] getTile(ILayer pLayer,
               int level,
               int row,
               int column)
               throws IOException,
                      AutomationException
Gets a tile for a given tile location from a given layer.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (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.

putTile

void putTile(ILayer pLayer,
             int level,
             int row,
             int column,
             byte[] ppTile)
             throws IOException,
                    AutomationException
Puts a tile for a given tile location for a given layer.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (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.

getCacheDirectory

String getCacheDirectory(ILayer pLayer)
                         throws IOException,
                                AutomationException
Gets cache directory for a given layer.

Product Availability

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

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The pCacheDir
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTilePosition

void queryTilePosition(int[] pLevel,
                       int[] pRow,
                       int[] pColumn)
                       throws IOException,
                              AutomationException
Queries for the current map tile position.

Product Availability

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

Parameters:
pLevel - The pLevel (out: use single element array)
pRow - The pRow (out: use single element array)
pColumn - The pColumn (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putTilePosition

void putTilePosition(int level,
                     int row,
                     int column)
                     throws IOException,
                            AutomationException
Sets the current map tile position.

Product Availability

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

Parameters:
level - The level (in)
row - The row (in)
column - The column (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxTileCount

int getMaxTileCount()
                    throws IOException,
                           AutomationException
The maximum number of map tiles to be generated.

Product Availability

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

Returns:
The pNumTiles
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxTileCount

void setMaxTileCount(int pNumTiles)
                     throws IOException,
                            AutomationException
The maximum number of map tiles to be generated.

Product Availability

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

Parameters:
pNumTiles - The pNumTiles (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exit

void exit()
          throws IOException,
                 AutomationException
Exits the map cache generator host process.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

void update(IMap pMap,
            ILayer pLayer,
            IDisplay pDisplay,
            IEnvelope pExtent,
            ILongArray pLevels,
            int updateMode,
            ITrackCancel pTrackCancel)
            throws IOException,
                   AutomationException
Updates 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)
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.

delete

void delete()
            throws IOException,
                   AutomationException
Deletes map service cache directory.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD