com.esri.arcgis.carto
Class MapCacheStorageFormatConvertor

java.lang.Object
  extended by com.esri.arcgis.carto.MapCacheStorageFormatConvertor
All Implemented Interfaces:
IMapCacheStorageFormatConvertor, IEnumThreadedJobs, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MapCacheStorageFormatConvertor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapCacheStorageFormatConvertor, IEnumThreadedJobs

A Map Cache Compressor object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
MapCacheStorageFormatConvertor()
          Constructs a MapCacheStorageFormatConvertor using ArcGIS Engine.
MapCacheStorageFormatConvertor(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapCacheStorageFormatConvertor theMapCacheStorageFormatConvertor = (MapCacheStorageFormatConvertor) obj;
 
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.
 boolean equals(Object o)
          Compare this object with another
 IEnvelope getCacheExtent()
          The target cache location.
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 IThreadedJob next()
          Returns the next threaded job.
 void reset()
          Resets the enumerator.
 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.
 
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

MapCacheStorageFormatConvertor

public MapCacheStorageFormatConvertor()
                               throws IOException,
                                      UnknownHostException
Constructs a MapCacheStorageFormatConvertor using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MapCacheStorageFormatConvertor

public MapCacheStorageFormatConvertor(Object obj)
                               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapCacheStorageFormatConvertor theMapCacheStorageFormatConvertor = (MapCacheStorageFormatConvertor) obj;

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

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

getTileCachePath

public String getTileCachePath()
                        throws IOException,
                               AutomationException
The source cache location.

Product Availability

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

Specified by:
getTileCachePath in interface IMapCacheStorageFormatConvertor
Returns:
The ppCacheLocation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileCachePath

public void setTileCachePath(String ppCacheLocation)
                      throws IOException,
                             AutomationException
The source cache location.

Product Availability

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

Specified by:
setTileCachePath in interface IMapCacheStorageFormatConvertor
Parameters:
ppCacheLocation - The ppCacheLocation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompressedCachePath

public String getCompressedCachePath()
                              throws IOException,
                                     AutomationException
The target cache location.

Product Availability

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

Specified by:
getCompressedCachePath in interface IMapCacheStorageFormatConvertor
Returns:
The ppTargetCacheLocation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompressedCachePath

public void setCompressedCachePath(String ppTargetCacheLocation)
                            throws IOException,
                                   AutomationException
The target cache location.

Product Availability

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

Specified by:
setCompressedCachePath in interface IMapCacheStorageFormatConvertor
Parameters:
ppTargetCacheLocation - The ppTargetCacheLocation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheExtent

public IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException
The target cache location.

Product Availability

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

Specified by:
getCacheExtent in interface IMapCacheStorageFormatConvertor
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 ppExtent)
                         throws IOException,
                                AutomationException
The target cache location.

Product Availability

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

Specified by:
setCacheExtentByRef in interface IMapCacheStorageFormatConvertor
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

public 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.

Specified by:
compress in interface IMapCacheStorageFormatConvertor
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

public 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.

Specified by:
decompress in interface IMapCacheStorageFormatConvertor
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

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 IMapCacheStorageFormatConvertor
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 IMapCacheStorageFormatConvertor
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 IMapCacheStorageFormatConvertor
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 IMapCacheStorageFormatConvertor
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 IMapCacheStorageFormatConvertor
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 IMapCacheStorageFormatConvertor
Parameters:
pDataframe - The pDataframe (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPacketSize

public int getPacketSize()
                  throws IOException,
                         AutomationException
Packet Size

Product Availability

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

Specified by:
getPacketSize in interface IMapCacheStorageFormatConvertor
Returns:
The pPacketSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPacketSize

public void setPacketSize(int pPacketSize)
                   throws IOException,
                          AutomationException
Packet Size

Product Availability

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

Specified by:
setPacketSize in interface IMapCacheStorageFormatConvertor
Parameters:
pPacketSize - The pPacketSize (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.