com.esri.arcgis.datasourcesraster
Class DefaultRasterStatusEvent

java.lang.Object
  com.esri.arcgis.datasourcesraster.DefaultRasterStatusEvent

All Implemented Interfaces:

IERasterStatus, IRasterStatusEvent, IRasterStatusEvent2, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class DefaultRasterStatusEvent
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStatusEvent, IRasterStatusEvent2, IERasterStatus

The default listener of the raster related events.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DefaultRasterStatusEvent()
Constructs a DefaultRasterStatusEvent using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent) Indicates whether the operation should be continued.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	message(IRasterStatusEvent2MessageEvent theEvent) The message of the event.
boolean	queryCancel() Raster Engine asks if user has decided to quit.
void	resetCancel() Raster Engine acknowledges user's desire to abort.
void	start(IRasterStatusEventStartEvent theEvent) Starts the raster status/progress report for a given step and a maximum values.
void	step(IRasterStatusEventStepEvent theEvent) Reports status/progress at a given step.
void	stop(IRasterStatusEventStopEvent theEvent) Stops the raster status/progress report.
void	title(IRasterStatusEvent2TitleEvent theEvent) The title of the event.
void	updateTaskName(String new_task) Raster Engine has started a different subtask.
void	updateTaskStatus(String taskname, double percent_finished) Raster Engine reports job status.

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

DefaultRasterStatusEvent

public DefaultRasterStatusEvent()
                         throws IOException,
                                UnknownHostException

Constructs a DefaultRasterStatusEvent using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DefaultRasterStatusEvent

public DefaultRasterStatusEvent(Object obj)
                         throws IOException

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

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

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

start

public void start(IRasterStatusEventStartEvent theEvent)
           throws IOException,
                  AutomationException

Starts the raster status/progress report for a given step and a maximum values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

start in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step(IRasterStatusEventStepEvent theEvent)
          throws IOException,
                 AutomationException

Reports status/progress at a given step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

step in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop(IRasterStatusEventStopEvent theEvent)
          throws IOException,
                 AutomationException

Stops the raster status/progress report.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

title

public void title(IRasterStatusEvent2TitleEvent theEvent)
           throws IOException,
                  AutomationException

The title of the event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

title in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

message

public void message(IRasterStatusEvent2MessageEvent theEvent)
             throws IOException,
                    AutomationException

The message of the event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

message in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_continue

public void esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent)
                   throws IOException,
                          AutomationException

Indicates whether the operation should be continued.

Product Availability

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

Specified by:

esri_continue in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTaskName

public void updateTaskName(String new_task)
                    throws IOException,
                           AutomationException

Raster Engine has started a different subtask.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

updateTaskName in interface IERasterStatus

Parameters:

new_task - The new_task (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCancel

public boolean queryCancel()
                    throws IOException,
                           AutomationException

Raster Engine asks if user has decided to quit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryCancel in interface IERasterStatus

Returns:

The give_up

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTaskStatus

public void updateTaskStatus(String taskname,
                             double percent_finished)
                      throws IOException,
                             AutomationException

Raster Engine reports job status.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

updateTaskStatus in interface IERasterStatus

Parameters:

taskname - The taskname (in)

percent_finished - The percent_finished (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetCancel

public void resetCancel()
                 throws IOException,
                        AutomationException

Raster Engine acknowledges user's desire to abort.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetCancel in interface IERasterStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.