com.esri.arcgis.geoprocessing
Class MapCacheTileManagerJob

java.lang.Object
  com.esri.arcgis.geoprocessing.MapCacheTileManagerJob

All Implemented Interfaces:

IThreadedJob, IMapCacheTileManagerJob, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MapCacheTileManagerJob
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapCacheTileManagerJob, IThreadedJob

A threaded job.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MapCacheTileManagerJob()
Constructs a MapCacheTileManagerJob using ArcGIS Engine.

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

Method Summary

void	cancel() Cancel the current job.
void	enableLocalCaching(boolean localCaching) Enable local caching.
boolean	equals(Object o) Compare this object with another
void	execute(ITrackCancel pTrackCancel) Executes the job.
IEnvelope	getCacheExtent() Cache Extent.
IGeometry	getClipGeometry() ClipGeometry
static String	getClsid() getClsid.
String	getDataframe() Dataframe name.
String	getLayerName() Layer name.
int	getLevel() Cancel the current job.
IThreadedJobResult	getResult() The result of this job.
int	getTileManagerMode() Cancel the current job.
void	getTileRangeX(int[] pTileXMin, int[] pTileXMax) Cancel the current job.
void	getTileRangeY(int[] pTileYMin, int[] pTileYMax) Cancel the current job.
int	hashCode() the hashcode for this object
void	setCacheExtentByRef(IEnvelope ppCacheExtent) Cache Extent.
void	setClipGeometryByRef(IGeometry ppGeometry) ClipGeometry
void	setDataframe(String pDataframe) Dataframe name.
void	setLayerName(String pLayerName) Layer name.
void	setLevel(int pLevel) Cancel the current job.
void	setThreadNumber(int threadID) Sets the thread number on the job.
void	setTileManagerMode(int pMode) 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 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

MapCacheTileManagerJob

public MapCacheTileManagerJob()
                       throws IOException,
                              UnknownHostException

Constructs a MapCacheTileManagerJob using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapCacheTileManagerJob

public MapCacheTileManagerJob(Object obj)
                       throws IOException

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

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

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

setTileRangeX

public void setTileRangeX(int tileXMin,
                          int tileXMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTileRangeX in interface IMapCacheTileManagerJob

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

public void setTileRangeY(int tileYMin,
                          int tileYMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTileRangeY in interface IMapCacheTileManagerJob

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

public void getTileRangeX(int[] pTileXMin,
                          int[] pTileXMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getTileRangeX in interface IMapCacheTileManagerJob

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

public void getTileRangeY(int[] pTileYMin,
                          int[] pTileYMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getTileRangeY in interface IMapCacheTileManagerJob

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

public void setLevel(int pLevel)
              throws IOException,
                     AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setLevel in interface IMapCacheTileManagerJob

Parameters:

pLevel - The pLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevel

public int getLevel()
             throws IOException,
                    AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getLevel in interface IMapCacheTileManagerJob

Returns:

The pLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileManagerMode

public int getTileManagerMode()
                       throws IOException,
                              AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getTileManagerMode in interface IMapCacheTileManagerJob

Returns:

A com.esri.arcgis.carto.esriMapCacheUpdateMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileManagerMode

public void setTileManagerMode(int pMode)
                        throws IOException,
                               AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTileManagerMode in interface IMapCacheTileManagerJob

Parameters:

pMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataframe

public String getDataframe()
                    throws IOException,
                           AutomationException

Dataframe name.

Product Availability

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

Specified by:

getDataframe in interface IMapCacheTileManagerJob

Returns:

The pDataframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataframe

public void setDataframe(String pDataframe)
                  throws IOException,
                         AutomationException

Dataframe name.

Product Availability

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

Specified by:

setDataframe in interface IMapCacheTileManagerJob

Parameters:

pDataframe - The pDataframe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerName

public String getLayerName()
                    throws IOException,
                           AutomationException

Layer name.

Product Availability

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

Specified by:

getLayerName in interface IMapCacheTileManagerJob

Returns:

The pLayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerName

public void setLayerName(String pLayerName)
                  throws IOException,
                         AutomationException

Layer name.

Product Availability

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

Specified by:

setLayerName in interface IMapCacheTileManagerJob

Parameters:

pLayerName - The pLayerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableLocalCaching

public void enableLocalCaching(boolean localCaching)
                        throws IOException,
                               AutomationException

Enable local caching.

Product Availability

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

Specified by:

enableLocalCaching in interface IMapCacheTileManagerJob

Parameters:

localCaching - The localCaching (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheExtent

public IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException

Cache Extent.

Product Availability

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

Specified by:

getCacheExtent in interface IMapCacheTileManagerJob

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

public void setCacheExtentByRef(IEnvelope ppCacheExtent)
                         throws IOException,
                                AutomationException

Cache Extent.

Product Availability

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

Specified by:

setCacheExtentByRef in interface IMapCacheTileManagerJob

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.

getClipGeometry

public IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException

ClipGeometry

Product Availability

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

Specified by:

getClipGeometry in interface IMapCacheTileManagerJob

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

public void setClipGeometryByRef(IGeometry ppGeometry)
                          throws IOException,
                                 AutomationException

ClipGeometry

Product Availability

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

Specified by:

setClipGeometryByRef in interface IMapCacheTileManagerJob

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.

setThreadNumber

public void setThreadNumber(int threadID)
                     throws IOException,
                            AutomationException

Sets the thread number on the job.

Product Availability

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

Specified by:

setThreadNumber in interface IThreadedJob

Parameters:

threadID - The threadID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ITrackCancel pTrackCancel)
             throws IOException,
                    AutomationException

Executes the job.

Product Availability

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

Specified by:

execute in interface IThreadedJob

Parameters:

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.

getResult

public IThreadedJobResult getResult()
                             throws IOException,
                                    AutomationException

The result of this job.

Product Availability

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

Specified by:

getResult in interface IThreadedJob

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IThreadedJobResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException

Cancel the current job.

Product Availability

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

Specified by:

cancel in interface IThreadedJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.