com.esri.arcgis.globecore
Class GlobeServerCooker

java.lang.Object
  com.esri.arcgis.globecore.GlobeServerCooker

All Implemented Interfaces:

IGlobeServerCooker, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GlobeServerCooker
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeServerCooker

The Globe Server Cooker coclass for Generating Tiles with globe server objects.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GlobeServerCooker()
Constructs a GlobeServerCooker using ArcGIS Engine.

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

Method Summary

void	cancel() Cancels cooking.
boolean	equals(Object o) Compare this object with another
IEnvelope	getAOI() The area of interest for cooking in GCS.
static String	getClsid() getClsid.
void	getLastError() Gets the last error.
int	getMaxLOD() The maximum Level Of detail for cooking.
int	getMinLOD() The minimum Level Of detail for cooking.
void	getStats(String[] pLayerName, int[] pLayerID, double[] pProgressPercent) Gets the current Cooker object cooking progress.
void	getThreadHandle(int[] pHandle) Gets the Cook thread handle.
int	hashCode() the hashcode for this object
void	initCooking(String serverName, String serverObjectName) cooks a given globe server object on a given server.
void	removeTiles(IEnvelope pExtent) Removes tiles from within the specified extent.
void	setAOI(IEnvelope ppExtent) The area of interest for cooking in GCS.
void	setInputLyrId(int rhs1) The layer id of the layer to be cooked.
void	setMaxLOD(int pMaxLOD) The maximum Level Of detail for cooking.
void	setMinLOD(int pMinLOD) The minimum Level Of detail for cooking.
void	update(IEnvelope pExtent, int pUpdatemode) Sets the extent of the region to be updated and the caching mode.

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

GlobeServerCooker

public GlobeServerCooker()
                  throws IOException,
                         UnknownHostException

Constructs a GlobeServerCooker using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeServerCooker

public GlobeServerCooker(Object obj)
                  throws IOException

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

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

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

getMinLOD

public int getMinLOD()
              throws IOException,
                     AutomationException

The minimum Level Of detail for cooking.

Product Availability

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

Specified by:

getMinLOD in interface IGlobeServerCooker

Returns:

The pMinLOD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinLOD

public void setMinLOD(int pMinLOD)
               throws IOException,
                      AutomationException

The minimum Level Of detail for cooking.

Product Availability

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

Specified by:

setMinLOD in interface IGlobeServerCooker

Parameters:

pMinLOD - The pMinLOD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLOD

public int getMaxLOD()
              throws IOException,
                     AutomationException

The maximum Level Of detail for cooking.

Product Availability

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

Specified by:

getMaxLOD in interface IGlobeServerCooker

Returns:

The pMaxLOD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLOD

public void setMaxLOD(int pMaxLOD)
               throws IOException,
                      AutomationException

The maximum Level Of detail for cooking.

Product Availability

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

Specified by:

setMaxLOD in interface IGlobeServerCooker

Parameters:

pMaxLOD - The pMaxLOD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAOI

public IEnvelope getAOI()
                 throws IOException,
                        AutomationException

The area of interest for cooking in GCS.

Product Availability

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

Specified by:

getAOI in interface IGlobeServerCooker

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.

setInputLyrId

public void setInputLyrId(int rhs1)
                   throws IOException,
                          AutomationException

The layer id of the layer to be cooked.

Product Availability

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

Specified by:

setInputLyrId in interface IGlobeServerCooker

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAOI

public void setAOI(IEnvelope ppExtent)
            throws IOException,
                   AutomationException

The area of interest for cooking in GCS.

Product Availability

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

Specified by:

setAOI in interface IGlobeServerCooker

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.

initCooking

public void initCooking(String serverName,
                        String serverObjectName)
                 throws IOException,
                        AutomationException

cooks a given globe server object on a given server.

Product Availability

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

Specified by:

initCooking in interface IGlobeServerCooker

Parameters:

serverName - The serverName (in)

serverObjectName - The serverObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IEnvelope pExtent,
                   int pUpdatemode)
            throws IOException,
                   AutomationException

Sets the extent of the region to be updated and the caching mode.

Product Availability

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

Specified by:

update in interface IGlobeServerCooker

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pUpdatemode - A com.esri.arcgis.globecore.esriGlobeCacheUpdateMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTiles

public void removeTiles(IEnvelope pExtent)
                 throws IOException,
                        AutomationException

Removes tiles from within the specified extent.

Product Availability

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

Specified by:

removeTiles in interface IGlobeServerCooker

Parameters:

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

cancel

public void cancel()
            throws IOException,
                   AutomationException

Cancels cooking. It will additionally stop the cookers on the Server

Product Availability

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

Specified by:

cancel in interface IGlobeServerCooker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStats

public void getStats(String[] pLayerName,
                     int[] pLayerID,
                     double[] pProgressPercent)
              throws IOException,
                     AutomationException

Gets the current Cooker object cooking progress.

Product Availability

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

Specified by:

getStats in interface IGlobeServerCooker

Parameters:

pLayerName - The pLayerName (in/out: use single element array)

pLayerID - The pLayerID (in/out: use single element array)

pProgressPercent - The pProgressPercent (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadHandle

public void getThreadHandle(int[] pHandle)
                     throws IOException,
                            AutomationException

Gets the Cook thread handle.

Product Availability

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

Specified by:

getThreadHandle in interface IGlobeServerCooker

Parameters:

pHandle - The pHandle (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastError

public void getLastError()
                  throws IOException,
                         AutomationException

Gets the last error.

Product Availability

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

Specified by:

getLastError in interface IGlobeServerCooker

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.