com.esri.arcgis.carto
Interface IMapCacheExporterJob

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

public interface IMapCacheExporterJob
extends IThreadedJob, Serializable

Executes in parallel and performs the job.

Product Availability

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


Method Summary
 IEnvelope getCacheExtent()
          Cache Extent.
 IGeometry getClipGeometry()
          ClipGeometry
 String getDataframe()
          Dataframe name.
 int getExportMode()
          Set the export mode.
 int getLevel()
          Cancel the current job.
 ICacheStorageInfo getSourceCacheStorageInfo()
          CacheStorageInfo.
 ITileCacheInfo getSourceTileCacheInfo()
          SourceTileCacheInfo.
 ITileImageInfo getSourceTileImageInfo()
          SourceTileImageInfo.
 ICacheStorageInfo getTargetCacheStorageInfo()
          TargetCacheStorageInfo.
 ITileCacheInfo getTargetTileCacheInfo()
          TargetTileCacheInfo.
 ITileImageInfo getTargetTileImageInfo()
          TargetTileImageInfo.
 void getTileRangeX(int[] pTileXMin, int[] pTileXMax)
          Cancel the current job.
 void getTileRangeY(int[] pTileYMin, int[] pTileYMax)
          Cancel the current job.
 boolean isOverwrite()
          Cancel the current job.
 void setCacheExtentByRef(IEnvelope ppCacheExtent)
          Cache Extent.
 void setClipGeometryByRef(IGeometry ppGeometry)
          ClipGeometry
 void setDataframe(String pDataframe)
          Dataframe name.
 void setExportMode(int pMode)
          Set the export mode.
 void setLevel(int pLevel)
          Cancel the current job.
 void setOverwrite(boolean pOverwrite)
          Cancel the current job.
 void setSourceCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
          CacheStorageInfo.
 void setSourceLevelCacheDirectory(String sourceCacheDir)
          Cancel the current job.
 void setSourceTileCacheInfoByRef(ITileCacheInfo ppSourceTileCacheInfo)
          SourceTileCacheInfo.
 void setSourceTileImageInfoByRef(ITileImageInfo ppSourceTileImageInfo)
          SourceTileImageInfo.
 void setTargetCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
          TargetCacheStorageInfo.
 void setTargetLevelCacheDirectory(String targetCacheDir)
          Cancel the current job.
 void setTargetTileCacheInfoByRef(ITileCacheInfo ppTargetTileCacheInfo)
          TargetTileCacheInfo.
 void setTargetTileImageInfoByRef(ITileImageInfo ppTargetTileImageInfo)
          TargetTileImageInfo.
 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.

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.

setOverwrite

void setOverwrite(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.

isOverwrite

boolean isOverwrite()
                    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.

setSourceLevelCacheDirectory

void setSourceLevelCacheDirectory(String sourceCacheDir)
                                  throws IOException,
                                         AutomationException
Cancel the current job.

Product Availability

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

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

setTargetLevelCacheDirectory

void setTargetLevelCacheDirectory(String targetCacheDir)
                                  throws IOException,
                                         AutomationException
Cancel the current job.

Product Availability

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

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

getExportMode

int getExportMode()
                  throws IOException,
                         AutomationException
Set the export mode.

Product Availability

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

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

setExportMode

void setExportMode(int pMode)
                   throws IOException,
                          AutomationException
Set the export mode.

Product Availability

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

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

getSourceTileCacheInfo

ITileCacheInfo getSourceTileCacheInfo()
                                      throws IOException,
                                             AutomationException
SourceTileCacheInfo.

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.

setSourceTileCacheInfoByRef

void setSourceTileCacheInfoByRef(ITileCacheInfo ppSourceTileCacheInfo)
                                 throws IOException,
                                        AutomationException
SourceTileCacheInfo.

Product Availability

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

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

getTargetTileCacheInfo

ITileCacheInfo getTargetTileCacheInfo()
                                      throws IOException,
                                             AutomationException
TargetTileCacheInfo.

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.

setTargetTileCacheInfoByRef

void setTargetTileCacheInfoByRef(ITileCacheInfo ppTargetTileCacheInfo)
                                 throws IOException,
                                        AutomationException
TargetTileCacheInfo.

Product Availability

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

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

getSourceTileImageInfo

ITileImageInfo getSourceTileImageInfo()
                                      throws IOException,
                                             AutomationException
SourceTileImageInfo.

Product Availability

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

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.

setSourceTileImageInfoByRef

void setSourceTileImageInfoByRef(ITileImageInfo ppSourceTileImageInfo)
                                 throws IOException,
                                        AutomationException
SourceTileImageInfo.

Product Availability

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

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

getTargetTileImageInfo

ITileImageInfo getTargetTileImageInfo()
                                      throws IOException,
                                             AutomationException
TargetTileImageInfo.

Product Availability

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

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.

setTargetTileImageInfoByRef

void setTargetTileImageInfoByRef(ITileImageInfo ppTargetTileImageInfo)
                                 throws IOException,
                                        AutomationException
TargetTileImageInfo.

Product Availability

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

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

getSourceCacheStorageInfo

ICacheStorageInfo getSourceCacheStorageInfo()
                                            throws IOException,
                                                   AutomationException
CacheStorageInfo.

Product Availability

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

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

setSourceCacheStorageInfoByRef

void setSourceCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
                                    throws IOException,
                                           AutomationException
CacheStorageInfo.

Product Availability

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

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

getTargetCacheStorageInfo

ICacheStorageInfo getTargetCacheStorageInfo()
                                            throws IOException,
                                                   AutomationException
TargetCacheStorageInfo.

Product Availability

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

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

setTargetCacheStorageInfoByRef

void setTargetCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
                                    throws IOException,
                                           AutomationException
TargetCacheStorageInfo.

Product Availability

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

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

getClipGeometry

IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException
ClipGeometry

Product Availability

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

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

setClipGeometryByRef

void setClipGeometryByRef(IGeometry ppGeometry)
                          throws IOException,
                                 AutomationException
ClipGeometry

Product Availability

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

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