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, java.io.Serializable, java.util.EventListener

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

COM Class 'DefaultRasterStatusEvent'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'The default listener of the raster related events.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterStatusEvent

IID, IID3424b100_5836_11d4_8d9b_00c04f5b87b2, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterStatusEvent2

IID, IID3872f080_b932_4a24_941d_21ec0d43f0b7, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IERasterStatus

IID, IIDce4bcc80_2758_11d3_80ce_00500462e955, xxDummy

Constructor Summary

Constructors

Constructor and Description
DefaultRasterStatusEvent() Constructs a DefaultRasterStatusEvent using ArcGIS Engine.
DefaultRasterStatusEvent(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DefaultRasterStatusEvent theDefaultRasterStatusEvent = (DefaultRasterStatusEvent) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
void	esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent) Indicates whether the operation should be continued.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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	release() Release this COM object reference
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(java.lang.String new_task) Raster Engine has started a different subtask.
void	updateTaskStatus(java.lang.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

Constructor Detail

DefaultRasterStatusEvent

public DefaultRasterStatusEvent()
                         throws java.io.IOException,
                                java.net.UnknownHostException

Constructs a DefaultRasterStatusEvent using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DefaultRasterStatusEvent

public DefaultRasterStatusEvent(java.lang.Object obj)
                         throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

start

public void start(IRasterStatusEventStartEvent theEvent)
           throws java.io.IOException,
                  AutomationException

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

Specified by:

start in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step(IRasterStatusEventStepEvent theEvent)
          throws java.io.IOException,
                 AutomationException

Reports status/progress at a given step.

Specified by:

step in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop(IRasterStatusEventStopEvent theEvent)
          throws java.io.IOException,
                 AutomationException

Stops the raster status/progress report.

Specified by:

stop in interface IRasterStatusEvent

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

title

public void title(IRasterStatusEvent2TitleEvent theEvent)
           throws java.io.IOException,
                  AutomationException

The title of the event.

Specified by:

title in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

message

public void message(IRasterStatusEvent2MessageEvent theEvent)
             throws java.io.IOException,
                    AutomationException

The message of the event.

Specified by:

message in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_continue

public void esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the operation should be continued.

Specified by:

esri_continue in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTaskName

public void updateTaskName(java.lang.String new_task)
                    throws java.io.IOException,
                           AutomationException

Raster Engine has started a different subtask.

Specified by:

updateTaskName in interface IERasterStatus

Parameters:

new_task - The new_task (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCancel

public boolean queryCancel()
                    throws java.io.IOException,
                           AutomationException

Raster Engine asks if user has decided to quit.

Specified by:

queryCancel in interface IERasterStatus

Returns:

The give_up

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTaskStatus

public void updateTaskStatus(java.lang.String taskname,
                             double percent_finished)
                      throws java.io.IOException,
                             AutomationException

Raster Engine reports job status.

Specified by:

updateTaskStatus in interface IERasterStatus

Parameters:

taskname - The taskname (in)

percent_finished - The percent_finished (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetCancel

public void resetCancel()
                 throws java.io.IOException,
                        AutomationException

Raster Engine acknowledges user's desire to abort.

Specified by:

resetCancel in interface IERasterStatus

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.