com.esri.arcgis.carto
Class MapCacheExporter

java.lang.Object
  com.esri.arcgis.carto.MapCacheExporter

All Implemented Interfaces:

IMapCacheExporter, IEnumThreadedJobs, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MapCacheExporter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapCacheExporter, IEnumThreadedJobs

A Map Cache Compressor object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MapCacheExporter()
Constructs a MapCacheExporter using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	esri_import(ILongArray pLevels, IGeometry pGeometry, int numThreads, ITrackCancel pTrackCancel, boolean overwrite) Import cache.
void	export(ILongArray pLevels, IGeometry pGeometry, int numThreads, ITrackCancel pTrackCancel, ICacheStorageInfo pCacheStorageInfo, boolean overwrite) Export cache.
static String	getClsid() getClsid.
String	getDataframe() Dataframe name.
String	getHost() Server machine name.
String	getService() Service name.
String	getTargetCachePath() The cache location.
int	hashCode() the hashcode for this object
IThreadedJob	next() Returns the next threaded job.
void	reset() Resets the enumerator.
void	setDataframe(String pDataframe) Dataframe name.
void	setHost(String pHost) Server machine name.
void	setService(String pService) Service name.
void	setTargetCachePath(String ppCacheLocation) The cache location.

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

MapCacheExporter

public MapCacheExporter()
                 throws IOException,
                        UnknownHostException

Constructs a MapCacheExporter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapCacheExporter

public MapCacheExporter(Object obj)
                 throws IOException

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

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

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

getHost

public String getHost()
               throws IOException,
                      AutomationException

Server machine name.

Product Availability

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

Specified by:

getHost in interface IMapCacheExporter

Returns:

The pHost

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHost

public void setHost(String pHost)
             throws IOException,
                    AutomationException

Server machine name.

Product Availability

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

Specified by:

setHost in interface IMapCacheExporter

Parameters:

pHost - The pHost (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getService

public String getService()
                  throws IOException,
                         AutomationException

Service name.

Product Availability

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

Specified by:

getService in interface IMapCacheExporter

Returns:

The pService

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setService

public void setService(String pService)
                throws IOException,
                       AutomationException

Service name.

Product Availability

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

Specified by:

setService in interface IMapCacheExporter

Parameters:

pService - The pService (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 IMapCacheExporter

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 IMapCacheExporter

Parameters:

pDataframe - The pDataframe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetCachePath

public String getTargetCachePath()
                          throws IOException,
                                 AutomationException

The cache location.

Product Availability

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

Specified by:

getTargetCachePath in interface IMapCacheExporter

Returns:

The ppCacheLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetCachePath

public void setTargetCachePath(String ppCacheLocation)
                        throws IOException,
                               AutomationException

The cache location.

Product Availability

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

Specified by:

setTargetCachePath in interface IMapCacheExporter

Parameters:

ppCacheLocation - The ppCacheLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_import

public void esri_import(ILongArray pLevels,
                        IGeometry pGeometry,
                        int numThreads,
                        ITrackCancel pTrackCancel,
                        boolean overwrite)
                 throws IOException,
                        AutomationException

Import cache.

Product Availability

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

Specified by:

esri_import in interface IMapCacheExporter

Parameters:

pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

numThreads - The numThreads (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.

export

public void export(ILongArray pLevels,
                   IGeometry pGeometry,
                   int numThreads,
                   ITrackCancel pTrackCancel,
                   ICacheStorageInfo pCacheStorageInfo,
                   boolean overwrite)
            throws IOException,
                   AutomationException

Export cache.

Product Availability

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

Specified by:

export in interface IMapCacheExporter

Parameters:

pLevels - A reference to a com.esri.arcgis.system.ILongArray (in)

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

numThreads - The numThreads (in)

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

pCacheStorageInfo - A reference to a com.esri.arcgis.carto.ICacheStorageInfo (in)

overwrite - The overwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IThreadedJob next()
                  throws IOException,
                         AutomationException

Returns the next threaded job.

Product Availability

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

Specified by:

next in interface IEnumThreadedJobs

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the enumerator.

Product Availability

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

Specified by:

reset in interface IEnumThreadedJobs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.