com.esri.arcgis.carto
Interface IMapCacheStorageFormatConvertor

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapCacheStorageFormatConvertor

public interface IMapCacheStorageFormatConvertor
extends Serializable

Provides access to methods that convert cache format.

Product Availability

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

Method Summary

void	compress(int numThreads, String layerName, ITrackCancel pTrackCancel, boolean overwrite) The target cache location.
void	decompress(int numThreads, String layerName, ITrackCancel pTrackCancel, boolean overwrite) The target cache location.
IEnvelope	getCacheExtent() The target cache location.
String	getCompressedCachePath() The target cache location.
String	getDataframe() Dataframe name.
String	getHost() Server machine name.
int	getPacketSize() Packet Size
String	getService() Service name.
String	getTileCachePath() The source cache location.
void	setCacheExtentByRef(IEnvelope ppExtent) The target cache location.
void	setCompressedCachePath(String ppTargetCacheLocation) The target cache location.
void	setDataframe(String pDataframe) Dataframe name.
void	setHost(String pHost) Server machine name.
void	setPacketSize(int pPacketSize) Packet Size
void	setService(String pService) Service name.
void	setTileCachePath(String ppCacheLocation) The source cache location.

Method Detail

getTileCachePath

String getTileCachePath()
                        throws IOException,
                               AutomationException

The source cache location.

Product Availability

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

Returns:

The ppCacheLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileCachePath

void setTileCachePath(String ppCacheLocation)
                      throws IOException,
                             AutomationException

The source cache location.

Product Availability

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

Parameters:

ppCacheLocation - The ppCacheLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressedCachePath

String getCompressedCachePath()
                              throws IOException,
                                     AutomationException

The target cache location.

Product Availability

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

Returns:

The ppTargetCacheLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressedCachePath

void setCompressedCachePath(String ppTargetCacheLocation)
                            throws IOException,
                                   AutomationException

The target cache location.

Product Availability

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

Parameters:

ppTargetCacheLocation - The ppTargetCacheLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheExtent

IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException

The target cache location.

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.

setCacheExtentByRef

void setCacheExtentByRef(IEnvelope ppExtent)
                         throws IOException,
                                AutomationException

The target cache location.

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.

compress

void compress(int numThreads,
              String layerName,
              ITrackCancel pTrackCancel,
              boolean overwrite)
              throws IOException,
                     AutomationException

The target cache location.

Product Availability

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

Parameters:

numThreads - The numThreads (in)

layerName - The layerName (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

overwrite - The overwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decompress

void decompress(int numThreads,
                String layerName,
                ITrackCancel pTrackCancel,
                boolean overwrite)
                throws IOException,
                       AutomationException

The target cache location.

Product Availability

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

Parameters:

numThreads - The numThreads (in)

layerName - The layerName (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

overwrite - The overwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHost

String getHost()
               throws IOException,
                      AutomationException

Server machine name.

Product Availability

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

Returns:

The pHost

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHost

void setHost(String pHost)
             throws IOException,
                    AutomationException

Server machine name.

Product Availability

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

Parameters:

pHost - The pHost (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getService

String getService()
                  throws IOException,
                         AutomationException

Service name.

Product Availability

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

Returns:

The pService

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setService

void setService(String pService)
                throws IOException,
                       AutomationException

Service name.

Product Availability

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

Parameters:

pService - The pService (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataframe

String getDataframe()
                    throws IOException,
                           AutomationException

Dataframe name.

Product Availability

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

Returns:

The pDataframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataframe

void setDataframe(String pDataframe)
                  throws IOException,
                         AutomationException

Dataframe name.

Product Availability

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

Parameters:

pDataframe - The pDataframe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPacketSize

int getPacketSize()
                  throws IOException,
                         AutomationException

Packet Size

Product Availability

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

Returns:

The pPacketSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPacketSize

void setPacketSize(int pPacketSize)
                   throws IOException,
                          AutomationException

Packet Size

Product Availability

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

Parameters:

pPacketSize - The pPacketSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.