com.esri.arcgis.carto
Interface ITiledMapServer2

All Superinterfaces:

ITiledMapServer, Serializable

All Known Implementing Classes:

MapServer, MapServerIP, MapServerLP

public interface ITiledMapServer2
extends ITiledMapServer, Serializable

Provides access to members that serve tiled maps.

Description

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

Remarks

ITiledMapServer2 allows clients to retrieve information regarding the storage format of images in the cache. This information is needed to construct urls to images in jpeg and other formats. ITiledMapServer2 also has a GetCacheDescriptionInfo method that allows a client to efficiently retrieve information about a tiled map service using fewer round trip calls.

Product Availability

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

Method Summary

ICacheControlInfo	getCacheControlInfo(String mapName) Gets the cache description information for a given map.
ICacheDescriptionInfo	getCacheDescriptionInfo(String mapName) Gets the cache description information for a given map.
byte[]	getLayerTileEx(String mapName, int layerID, int level, int row, int column, int cacheFormat) Gets a tile for a given tile location from a given layer.
byte[]	getMapTileEx(String mapName, int level, int row, int column, int cacheFormat) Gets a tile for a given tile location from a given map.
ITileImageInfo	getTileImageInfo(String mapName) Gets the cache tile image information for a given map.

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

getCacheName, getLayerTile, getMapTile, getTileCacheInfo, getVirtualCacheDirectory, hasLayerCache, hasSingleFusedMapCache, isFixedScaleMap

Method Detail

getMapTileEx

byte[] getMapTileEx(String mapName,
                    int level,
                    int row,
                    int column,
                    int cacheFormat)
                    throws IOException,
                           AutomationException

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

Remarks

This call gets the specified tile from a map service that has a single fused cache.

Product Availability

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

Parameters:

mapName - The mapName (in)

level - The level (in)

row - The row (in)

column - The column (in)

cacheFormat - The cacheFormat (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerTileEx

byte[] getLayerTileEx(String mapName,
                      int layerID,
                      int level,
                      int row,
                      int column,
                      int cacheFormat)
                      throws IOException,
                             AutomationException

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

Remarks

This call gets the specified tile from the specified layer for a map service that has a multi layer cache.

Product Availability

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

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

level - The level (in)

row - The row (in)

column - The column (in)

cacheFormat - The cacheFormat (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileImageInfo

ITileImageInfo getTileImageInfo(String mapName)
                                throws IOException,
                                       AutomationException

Gets the cache tile image information for a given map.

Remarks

GetTileIMageInfo returns information describing the image format for the cached tiles. TileImageInfo has two main properties Format and Compression quality. Format can have values (PNG8, PNG24, PNG32 and JPEG). If the selected format is JPEG, then the compression quality can have a value from 0 to 100. The value of format must be used in constructing the url to the tile.

Product Availability

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

Parameters:

mapName - The mapName (in)

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.

getCacheDescriptionInfo

ICacheDescriptionInfo getCacheDescriptionInfo(String mapName)
                                              throws IOException,
                                                     AutomationException

Gets the cache description information for a given map.

Remarks

GetCacheDescriptionInfo returns information on a cached map service in one call including its cache type, its tiling scheme (TileCacheInfo), image information (TileImageInfo) and control information (TileControlInfo). The cache description also includes an array of layer cache infos that can be used to determine if a specific layer has a cache in the case of map services that have a multi layer cache.

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

ICacheControlInfo getCacheControlInfo(String mapName)
                                      throws IOException,
                                             AutomationException

Gets the cache description information for a given map.

Remarks

Returns cache control information that allows clients to discover information such as if client caching is allowed.

Product Availability

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

Parameters:

mapName - The mapName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.