com.esri.arcgis.geoprocessing
Class GPServerTrackCancel

java.lang.Object
  com.esri.arcgis.geoprocessing.GPServerTrackCancel

All Implemented Interfaces:

IGPMessagesCallback, IGPServerTrackCancel, com.esri.arcgis.interop.RemoteObjRef, IProgressor, IStepProgressor, ITrackCancel, Serializable

public class GPServerTrackCancel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackCancel, IProgressor, IStepProgressor, IGPMessagesCallback, IGPServerTrackCancel

GP Server Track Cancel Class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPServerTrackCancel()
Constructs a GPServerTrackCancel using ArcGIS Engine.

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

Method Summary

void	cancel() Cancels the associated operation.
boolean	equals(Object o) Compare this object with another
boolean	esri_continue() Called frequently while associated operation is progressing.
int	getCheckTime() The interval at which the operation will be interrupted to advance progressors and process messages.
static String	getClsid() getClsid.
IJobMessages	getJobMessages() The job messages.
int	getMaxRange() The maximum range of the progression.
String	getMessage() The message displayed by the progressor.
int	getMinRange() The minimum range of the progression.
int	getPosition() The current position of the progression.
IProgressor	getProgressor() The progressor used to show progress during lengthy operations.
int	getStepValue() The step increment of the progression.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
void	init(Object pJobTracker) Initialize the track cancel.
boolean	isCancelOnClick() Indicates whether mouse clicks should cancel the operation.
boolean	isCancelOnKeyPress() Indicates whether the escape key and spacebar should cancel the operation.
boolean	isProcessMessages() An obsolete method.
boolean	isTimerFired() An obsolete method.
void	messageAdded(IGPMessage message) Fired when a geoprocessing message is added.
int	offsetPosition(int offsetValue) Offsets the position of the progression.
void	reset() Resets the manager after the associated operation is finished.
void	setCancelOnClick(boolean pCancelOnClick) Indicates whether mouse clicks should cancel the operation.
void	setCancelOnKeyPress(boolean pCancelOnKeyPress) Indicates whether the escape key and spacebar should cancel the operation.
void	setCheckTime(int milliseconds) The interval at which the operation will be interrupted to advance progressors and process messages.
void	setMaxRange(int maxRange) The maximum range of the progression.
void	setMessage(String message) The message displayed by the progressor.
void	setMinRange(int minRange) The minimum range of the progression.
void	setPosition(int position) The current position of the progression.
void	setProcessMessages(boolean processMessages) An obsolete method.
void	setProgressor(IProgressor progressor) The progressor used to show progress during lengthy operations.
void	setStepValue(int step) The step increment of the progression.
void	show() Shows the progressor.
void	startTimer(int hWnd, int milliseconds) An obsolete method.
void	step() Animates or steps the progressor.
void	stopTimer() An obsolete method.

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

GPServerTrackCancel

public GPServerTrackCancel()
                    throws IOException,
                           UnknownHostException

Constructs a GPServerTrackCancel using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPServerTrackCancel

public GPServerTrackCancel(Object obj)
                    throws IOException

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

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

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

setCheckTime

public void setCheckTime(int milliseconds)
                  throws IOException,
                         AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCheckTime in interface ITrackCancel

Parameters:

milliseconds - The milliseconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCheckTime

public int getCheckTime()
                 throws IOException,
                        AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Description

The CheckTime property indicates the frequency the CancelTracker will process any pending Windows (mouse and keyboard) messages. By default the CheckTime is 1000 milliseconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCheckTime in interface ITrackCancel

Returns:

The milliseconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressor

public void setProgressor(IProgressor progressor)
                   throws IOException,
                          AutomationException

The progressor used to show progress during lengthy operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setProgressor in interface ITrackCancel

Parameters:

progressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The progressor used to show progress during lengthy operations.

Description

Use the Progressor property to bind the CancelTracker with a progress object (for example, a progress bar, a progress dialog or a progress animation) that displays the progress of the lengthy operation. Once the Progressor has been set it will be updated automatically as the operation is executed.

Remarks

If the progressor is a step progressor, the MaxRange should be set to equal the number of iterations that the operation will progress through; this number should also match the number of times Continue will be called in the operation’s innermost loop.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getProgressor in interface ITrackCancel

Returns:

A reference to a com.esri.arcgis.system.IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException

Cancels the associated operation.

Description

By default a cancel will occur under the following circumstances:

• The Esc key was pressed.
• The space bar was pressed. Use the CancelOnKeyPress property to disable this action.
• The left or right mouse button was pressed. Use the CancelOnClick property to disable this action.

Whether a cancel occurs will depend on when the key or button was pressed and the CheckTime property. For example, if a map redraw was cancelled by a key press then it is possible that some phases of the redraw will complete before the key press is handled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

cancel in interface ITrackCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the manager after the associated operation is finished.

Description

The Reset method should be called just before a process that may be cancelled, such as a lengthy operation, begins. The Reset method sets the state of the CancelTracker to uncancelled and returns the internal counter, which is used to update the Progressor to zero.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface ITrackCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_continue

public boolean esri_continue()
                      throws IOException,
                             AutomationException

Called frequently while associated operation is progressing. A return value of false indicates that the operation should stop.

Product Availability

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

Specified by:

esri_continue in interface ITrackCancel

Returns:

The keepGoing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessMessages

public void setProcessMessages(boolean processMessages)
                        throws IOException,
                               AutomationException

An obsolete method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setProcessMessages in interface ITrackCancel

Parameters:

processMessages - The processMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProcessMessages

public boolean isProcessMessages()
                          throws IOException,
                                 AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isProcessMessages in interface ITrackCancel

Returns:

The processMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startTimer

public void startTimer(int hWnd,
                       int milliseconds)
                throws IOException,
                       AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

startTimer in interface ITrackCancel

Parameters:

hWnd - The hWnd (in)

milliseconds - The milliseconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimerFired

public boolean isTimerFired()
                     throws IOException,
                            AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isTimerFired in interface ITrackCancel

Returns:

The timerFired

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopTimer

public void stopTimer()
               throws IOException,
                      AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stopTimer in interface ITrackCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

public boolean isCancelOnClick()
                        throws IOException,
                               AutomationException

Indicates whether mouse clicks should cancel the operation.

Description

Indicates whether the user can use the left and right mouse buttons to cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnClick in interface ITrackCancel

Returns:

The pCancelOnClick

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

public void setCancelOnClick(boolean pCancelOnClick)
                      throws IOException,
                             AutomationException

Indicates whether mouse clicks should cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnClick in interface ITrackCancel

Parameters:

pCancelOnClick - The pCancelOnClick (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnKeyPress

public boolean isCancelOnKeyPress()
                           throws IOException,
                                  AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Description

Indicates whether the user can use the space bar to cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnKeyPress in interface ITrackCancel

Returns:

The pCancelOnKeyPress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnKeyPress

public void setCancelOnKeyPress(boolean pCancelOnKeyPress)
                         throws IOException,
                                AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnKeyPress in interface ITrackCancel

Parameters:

pCancelOnKeyPress - The pCancelOnKeyPress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(String message)
                throws IOException,
                       AutomationException

The message displayed by the progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMessage in interface IProgressor

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage()
                  throws IOException,
                         AutomationException

The message displayed by the progressor.

Description

This is a generic Message property for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMessage in interface IProgressor

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws IOException,
                 AutomationException

Shows the progressor.

Description

This is a generic Show method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

show in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step()
          throws IOException,
                 AutomationException

Animates or steps the progressor.

Description

This is a generic Step method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

step in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws IOException,
                 AutomationException

Hides the progressor.

Description

This is a generic Hide method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hide in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinRange

public void setMinRange(int minRange)
                 throws IOException,
                        AutomationException

The minimum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinRange in interface IStepProgressor

Parameters:

minRange - The minRange (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinRange

public int getMinRange()
                throws IOException,
                       AutomationException

The minimum range of the progression.

Description

The minimum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinRange in interface IStepProgressor

Returns:

The minRange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRange

public void setMaxRange(int maxRange)
                 throws IOException,
                        AutomationException

The maximum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRange in interface IStepProgressor

Parameters:

maxRange - The maxRange (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRange

public int getMaxRange()
                throws IOException,
                       AutomationException

The maximum range of the progression.

Description

The maximum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRange in interface IStepProgressor

Returns:

The maxRange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(int step)
                  throws IOException,
                         AutomationException

The step increment of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepValue in interface IStepProgressor

Parameters:

step - The step (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStepValue

public int getStepValue()
                 throws IOException,
                        AutomationException

The step increment of the progression.

Description

The increment value taken by the progression with each step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStepValue in interface IStepProgressor

Returns:

The step

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int position)
                 throws IOException,
                        AutomationException

The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPosition in interface IStepProgressor

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

public int getPosition()
                throws IOException,
                       AutomationException

The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPosition in interface IStepProgressor

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetPosition

public int offsetPosition(int offsetValue)
                   throws IOException,
                          AutomationException

Offsets the position of the progression.

Description

Offsets the current Position by the specified value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

offsetPosition in interface IStepProgressor

Parameters:

offsetValue - The offsetValue (in)

Returns:

The prevPos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

messageAdded

public void messageAdded(IGPMessage message)
                  throws IOException,
                         AutomationException

Fired when a geoprocessing message is added.

Product Availability

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

Specified by:

messageAdded in interface IGPMessagesCallback

Parameters:

message - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(Object pJobTracker)
          throws IOException,
                 AutomationException

Initialize the track cancel.

Product Availability

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

Specified by:

init in interface IGPServerTrackCancel

Parameters:

pJobTracker - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobMessages

public IJobMessages getJobMessages()
                            throws IOException,
                                   AutomationException

The job messages.

Product Availability

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

Specified by:

getJobMessages in interface IGPServerTrackCancel

Returns:

A reference to a com.esri.arcgis.system.IJobMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.