com.esri.arcgis.carto
Interface IConvertCacheStorageFormatJob

All Superinterfaces:
IThreadedJob, Serializable
All Known Implementing Classes:
ConvertCacheStorageFormatJob

public interface IConvertCacheStorageFormatJob
extends IThreadedJob, Serializable

Executes in parallel and performs the job.

Product Availability

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


Method Summary
 int getBundleSize()
          Bundle Size.
 IEnvelope getCacheExtent()
          Cache Extent.
 String getCacheFormat()
          Cancel the current job.
 int getConversionMode()
          Set the conversion mode.
 String getDataframe()
          Dataframe name.
 int getLevel()
          Cancel the current job.
 ITileCacheInfo getTileCacheInfo()
          TileCacheInfo.
 void getTileRangeX(int[] pTileXMin, int[] pTileXMax)
          Cancel the current job.
 void getTileRangeY(int[] pTileYMin, int[] pTileYMax)
          Cancel the current job.
 boolean isCleanUP()
          Cancel the current job.
 void setBundleSize(int pBundleSize)
          Bundle Size.
 void setCacheExtentByRef(IEnvelope ppCacheExtent)
          Cache Extent.
 void setCacheFormat(String pCacheFormat)
          Cancel the current job.
 void setCleanUP(boolean pOverwrite)
          Cancel the current job.
 void setCompressedLevelCacheDirectory(String compressedCacheDir)
          Cancel the current job.
 void setConversionMode(int pMode)
          Set the conversion mode.
 void setDataframe(String pDataframe)
          Dataframe name.
 void setLevel(int pLevel)
          Cancel the current job.
 void setTileCacheInfoByRef(ITileCacheInfo ppTileCacheInfo)
          TileCacheInfo.
 void setTileLevelCacheDirectory(String tileCacheDir)
          Cancel the current job.
 void setTileRangeX(int tileXMin, int tileXMax)
          Cancel the current job.
 void setTileRangeY(int tileYMin, int tileYMax)
          Cancel the current job.
 
Methods inherited from interface com.esri.arcgis.datasourcesraster.IThreadedJob
cancel, execute, getResult, setThreadNumber
 

Method Detail

setTileRangeX

void setTileRangeX(int tileXMin,
                   int tileXMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

setTileRangeY

void setTileRangeY(int tileYMin,
                   int tileYMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

getTileRangeX

void getTileRangeX(int[] pTileXMin,
                   int[] pTileXMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

getTileRangeY

void getTileRangeY(int[] pTileYMin,
                   int[] pTileYMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

setBundleSize

void setBundleSize(int pBundleSize)
                   throws IOException,
                          AutomationException
Bundle Size.

Product Availability

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

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

getBundleSize

int getBundleSize()
                  throws IOException,
                         AutomationException
Bundle Size.

Product Availability

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

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

setLevel

void setLevel(int pLevel)
              throws IOException,
                     AutomationException
Cancel the current job.

Product Availability

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

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

getLevel

int getLevel()
             throws IOException,
                    AutomationException
Cancel the current job.

Product Availability

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

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

setCleanUP

void setCleanUP(boolean pOverwrite)
                throws IOException,
                       AutomationException
Cancel the current job.

Product Availability

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

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

isCleanUP

boolean isCleanUP()
                  throws IOException,
                         AutomationException
Cancel the current job.

Product Availability

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

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

setCacheFormat

void setCacheFormat(String pCacheFormat)
                    throws IOException,
                           AutomationException
Cancel the current job.

Product Availability

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

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

getCacheFormat

String getCacheFormat()
                      throws IOException,
                             AutomationException
Cancel the current job.

Product Availability

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

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

setTileLevelCacheDirectory

void setTileLevelCacheDirectory(String tileCacheDir)
                                throws IOException,
                                       AutomationException
Cancel the current job.

Product Availability

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

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

setCompressedLevelCacheDirectory

void setCompressedLevelCacheDirectory(String compressedCacheDir)
                                      throws IOException,
                                             AutomationException
Cancel the current job.

Product Availability

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

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

getConversionMode

int getConversionMode()
                      throws IOException,
                             AutomationException
Set the conversion mode.

Product Availability

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

Returns:
A com.esri.arcgis.carto.esriCacheCompressionMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConversionMode

void setConversionMode(int pMode)
                       throws IOException,
                              AutomationException
Set the conversion mode.

Product Availability

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

Parameters:
pMode - A com.esri.arcgis.carto.esriCacheCompressionMode constant (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.

getCacheExtent

IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException
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.

setCacheExtentByRef

void setCacheExtentByRef(IEnvelope ppCacheExtent)
                         throws IOException,
                                AutomationException
Cache Extent.

Product Availability

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

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

getTileCacheInfo

ITileCacheInfo getTileCacheInfo()
                                throws IOException,
                                       AutomationException
TileCacheInfo.

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 ppTileCacheInfo)
                           throws IOException,
                                  AutomationException
TileCacheInfo.

Product Availability

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

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