com.esri.arcgis.carto
Class ImageCooker

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

All Implemented Interfaces:

IImageCooker, IMapCooker, IMapCooker2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ImageCooker
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageCooker, IMapCooker, IMapCooker2

ImageCooker Class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ImageCooker()
Constructs a ImageCooker using ArcGIS Engine.

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

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(IEnvelope pExtent, ITrackCancel pTrackCancel) Clears cache tiles with a given extent.
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, IImageServer pImageServer) Connects an image server object to its cache location.
void	connect(String location, String name, IMap pMap) Connects to a given map and its cache.
void	delete() Deletes map service cache directory.
void	deleteByExtent(IMap pMap, ILayer pLayer, IEnvelope pExtent, ILongArray pLevels, ITrackCancel pTrackCancel) Deletes cache for a given layer within a given extent.
void	draw(ILayer pLayer, IDisplay pDisplay, ITrackCancel pTrackCancel) Draws a given layer to the specified display.
boolean	equals(Object o) Compare this object with another
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.
void	getCacheDirectory(String[] pCacheDir) Gets the cache directory/location.
static String	getClsid() getClsid.
IEnvelope	getExtent() The map cache extent.
String	getFormat() The tile cache format.
double	getMaximumImageCellsize() The maximum source image cellsize below which data are available.
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.
IName	getServerObjectName() The ArcGIS server object to run the image cooker.
void	getStatusTileCount(int[] pTileCount) number of tiles processed in the current job
int	getThreadCount() The number of Image Cooker instances for building tile cache.
byte[]	getTile(ILayer pLayer, int level, int row, int column) Gets a tile for a given tile location from a given layer.
byte[]	getTile(int level, int row, int column) Gets a tile at a given LOD, and column and row location.
ITileCacheInfo	getTileCacheInfo() The tile cache info.
ITileImageInfo	getTileImageInfo() The map cache tile image info.
boolean	hasCache() Indicates if there is any cache.
int	hashCode() the hashcode for this object
boolean	hasLayerCache(ILayer pLayer) Indicates if there is a cache for a given layer.
boolean	isAntialiasing() Indicates if antialiasing should be used.
boolean	isCacheOnDemand() Indicates if the service is cached on demand.
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	putTile(int level, int row, int column, byte[] ppTile) Puts a tile at a given LOD, and column and row location.
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	setCacheOnDemand(boolean pCacheOnDemand) Indicates if the service is cached on demand.
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	setMaximumImageCellsize(double pMaxPS) The maximum source image cellsize below which data are available.
void	setMaxTileCount(int pNumTiles) The maximum number of map tiles to be generated.
void	setPath(String pPath) The map cache path.
void	setServerObjectNameByRef(IName ppName) The ArcGIS server object to run the image cooker.
void	setThreadCount(int pThreadCount) The number of Image Cooker instances for building tile cache.
void	setTileCacheInfoByRef(ITileCacheInfo ppCacheInfo) The tile cache info.
void	setTileImageInfoByRef(ITileImageInfo ppInfo) The map cache tile image info.
void	snap(IDisplay pDisplay, IEnvelope pExtent) Snaps a view extent to one of map cache levels.
void	update(IImageServer pImageServer, IEnvelope pExtent, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Updates cache within a given extent.
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.
void	updateByGeometry(IImageServer pImageServer, IGeometry pGeometry, ILongArray pLevels, int updateMode, ITrackCancel pTrackCancel) Updates cache within an area of interest defined by a given geometry.
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 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

ImageCooker

public ImageCooker()
            throws IOException,
                   UnknownHostException

Constructs a ImageCooker using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImageCooker

public ImageCooker(Object obj)
            throws IOException

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

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

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

connect

public void connect(String location,
                    IImageServer pImageServer)
             throws IOException,
                    AutomationException

Connects an image server object to its cache location.

Product Availability

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

Specified by:

connect in interface IImageCooker

Parameters:

location - The location (in)

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear(IEnvelope pExtent,
                  ITrackCancel pTrackCancel)
           throws IOException,
                  AutomationException

Clears cache tiles with a given extent.

Product Availability

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

Specified by:

clear in interface IImageCooker

Parameters:

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

getTile

public byte[] getTile(int level,
                      int row,
                      int column)
               throws IOException,
                      AutomationException

Gets a tile at a given LOD, and column and row location.

Product Availability

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

Specified by:

getTile in interface IImageCooker

Parameters:

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

public void putTile(int level,
                    int row,
                    int column,
                    byte[] ppTile)
             throws IOException,
                    AutomationException

Puts a tile at a given LOD, and column and row location.

Product Availability

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

Specified by:

putTile in interface IImageCooker

Parameters:

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

public void getCacheDirectory(String[] pCacheDir)
                       throws IOException,
                              AutomationException

Gets the cache directory/location.

Product Availability

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

Specified by:

getCacheDirectory in interface IImageCooker

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IImageServer pImageServer,
                   IEnvelope pExtent,
                   ILongArray pLevels,
                   int updateMode,
                   ITrackCancel pTrackCancel)
            throws IOException,
                   AutomationException

Updates cache within a given extent.

Product Availability

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

Specified by:

update in interface IImageCooker

Parameters:

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (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.

updateByGeometry

public void updateByGeometry(IImageServer pImageServer,
                             IGeometry pGeometry,
                             ILongArray pLevels,
                             int updateMode,
                             ITrackCancel pTrackCancel)
                      throws IOException,
                             AutomationException

Updates cache within an area of interest defined by a given geometry.

Product Availability

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

Specified by:

updateByGeometry in interface IImageCooker

Parameters:

pImageServer - A reference to a com.esri.arcgis.carto.IImageServer (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.

getThreadCount

public int getThreadCount()
                   throws IOException,
                          AutomationException

The number of Image Cooker instances for building tile cache.

Product Availability

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

Specified by:

getThreadCount in interface IImageCooker

Returns:

The pThreadCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThreadCount

public void setThreadCount(int pThreadCount)
                    throws IOException,
                           AutomationException

The number of Image Cooker instances for building tile cache.

Product Availability

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

Specified by:

setThreadCount in interface IImageCooker

Parameters:

pThreadCount - The pThreadCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumImageCellsize

public double getMaximumImageCellsize()
                               throws IOException,
                                      AutomationException

The maximum source image cellsize below which data are available.

Product Availability

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

Specified by:

getMaximumImageCellsize in interface IImageCooker

Returns:

The pMaxPS

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumImageCellsize

public void setMaximumImageCellsize(double pMaxPS)
                             throws IOException,
                                    AutomationException

The maximum source image cellsize below which data are available.

Product Availability

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

Specified by:

setMaximumImageCellsize in interface IImageCooker

Parameters:

pMaxPS - The pMaxPS (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerObjectName

public IName getServerObjectName()
                          throws IOException,
                                 AutomationException

The ArcGIS server object to run the image cooker.

Product Availability

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

Specified by:

getServerObjectName in interface IImageCooker

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerObjectNameByRef

public void setServerObjectNameByRef(IName ppName)
                              throws IOException,
                                     AutomationException

The ArcGIS server object to run the image cooker.

Product Availability

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

Specified by:

setServerObjectNameByRef in interface IImageCooker

Parameters:

ppName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The map cache path.

Product Availability

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

Specified by:

getPath in interface IMapCooker

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String pPath)
             throws IOException,
                    AutomationException

The map cache path.

Product Availability

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

Specified by:

setPath in interface IMapCooker

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The map cache extent.

Product Availability

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

Specified by:

getExtent in interface IMapCooker

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

public void setExtent(IEnvelope ppExtent)
               throws IOException,
                      AutomationException

The map cache extent.

Product Availability

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

Specified by:

setExtent in interface IMapCooker

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

public String getFormat()
                 throws IOException,
                        AutomationException

The tile cache format.

Product Availability

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

Specified by:

getFormat in interface IMapCooker

Returns:

The pFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(String pFormat)
               throws IOException,
                      AutomationException

The tile cache format.

Product Availability

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

Specified by:

setFormat in interface IMapCooker

Parameters:

pFormat - The pFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAntialiasing

public boolean isAntialiasing()
                       throws IOException,
                              AutomationException

Indicates if antialiasing should be used.

Product Availability

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

Specified by:

isAntialiasing in interface IMapCooker

Returns:

The pAntialiasing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAntialiasing

public void setAntialiasing(boolean pAntialiasing)
                     throws IOException,
                            AutomationException

Indicates if antialiasing should be used.

Product Availability

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

Specified by:

setAntialiasing in interface IMapCooker

Parameters:

pAntialiasing - The pAntialiasing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileCacheInfo

public ITileCacheInfo getTileCacheInfo()
                                throws IOException,
                                       AutomationException

The tile cache info.

Product Availability

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

Specified by:

getTileCacheInfo in interface IMapCooker

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 ppCacheInfo)
                           throws IOException,
                                  AutomationException

The tile cache info.

Product Availability

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

Specified by:

setTileCacheInfoByRef in interface IMapCooker

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

public int getNumLevels()
                 throws IOException,
                        AutomationException

The number of map cache levels.

Product Availability

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

Specified by:

getNumLevels in interface IMapCooker

Returns:

The pNumLevels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

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

Specified by:

connect in interface IMapCooker

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

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

Specified by:

addCachedLayers in interface IMapCooker

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

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

Specified by:

addLayer in interface IMapCooker

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

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

Specified by:

clear in interface IMapCooker

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

public void clearAll()
              throws IOException,
                     AutomationException

Clears cache for all layers.

Product Availability

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

Specified by:

clearAll in interface IMapCooker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snap

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

Specified by:

snap in interface IMapCooker

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

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

Specified by:

draw in interface IMapCooker

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

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

Specified by:

setDefaultLODInfos in interface IMapCooker

Parameters:

numLevels - The numLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generate

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

Specified by:

generate in interface IMapCooker

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

public boolean hasCache()
                 throws IOException,
                        AutomationException

Indicates if there is any cache.

Product Availability

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

Specified by:

hasCache in interface IMapCooker

Returns:

The pHasCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasLayerCache

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

Specified by:

hasLayerCache in interface IMapCooker

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

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

Specified by:

getTile in interface IMapCooker

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

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

Specified by:

putTile in interface IMapCooker

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

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

Specified by:

getCacheDirectory in interface IMapCooker

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

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

Specified by:

queryTilePosition in interface IMapCooker

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

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

Specified by:

putTilePosition in interface IMapCooker

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

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

Specified by:

getMaxTileCount in interface IMapCooker

Returns:

The pNumTiles

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxTileCount

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

Specified by:

setMaxTileCount in interface IMapCooker

Parameters:

pNumTiles - The pNumTiles (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exit

public void exit()
          throws IOException,
                 AutomationException

Exits the map cache generator host process.

Product Availability

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

Specified by:

exit in interface IMapCooker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

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

Specified by:

update in interface IMapCooker

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

public void delete()
            throws IOException,
                   AutomationException

Deletes map service cache directory.

Product Availability

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

Specified by:

delete in interface IMapCooker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileImageInfo

public ITileImageInfo getTileImageInfo()
                                throws IOException,
                                       AutomationException

The map cache tile image info.

Product Availability

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

Specified by:

getTileImageInfo in interface IMapCooker2

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 ppInfo)
                           throws IOException,
                                  AutomationException

The map cache tile image info.

Product Availability

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

Specified by:

setTileImageInfoByRef in interface IMapCooker2

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

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

Specified by:

setCacheOnDemand in interface IMapCooker2

Parameters:

pCacheOnDemand - The pCacheOnDemand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheOnDemand

public boolean isCacheOnDemand()
                        throws IOException,
                               AutomationException

Indicates if the service is cached on demand.

Product Availability

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

Specified by:

isCacheOnDemand in interface IMapCooker2

Returns:

The pCacheOnDemand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeTilingScheme

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

Specified by:

writeTilingScheme in interface IMapCooker2

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

public void updateMapServerCacheScales(IDoubleArray pScales)
                                throws IOException,
                                       AutomationException

Updates Map Server's Cache Scales.

Product Availability

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

Specified by:

updateMapServerCacheScales in interface IMapCooker2

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

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

Specified by:

deleteByExtent in interface IMapCooker2

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

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

Specified by:

updateByGeometry in interface IMapCooker2

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

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

Specified by:

getStatusTileCount in interface IMapCooker2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.