oracle.ide.db.execute

Class DBRequestProcessor.DBRunnable

java.lang.Object

oracle.ide.db.execute.DBRequestProcessor.DBRunnable

All Implemented Interfaces:

java.lang.Runnable

Enclosing class:

DBRequestProcessor

public abstract class DBRequestProcessor.DBRunnable
extends java.lang.Object
implements java.lang.Runnable

Specific Runnable implementation for a process that works against a given DBObjectProvider. This class is used for scheduling work with DBRequestProcessor.

Constructor Summary

Constructors

Constructor and Description
DBRunnable(DBObjectProvider pro, java.lang.String name) Create a new runnable that works against the given provider.

Method Summary

Modifier and Type	Method and Description
protected void	cancelWork() Called if the runnable is cancelled or interrupted.
protected abstract void	doWork() Does the work for this Runnable.
protected java.util.logging.Logger	getLogger() Gets the Logger that any DBException thrown by doWork() will have its message logged on.
java.lang.String	getName() Gets a name for this task that can be displayed to the user in the status UI as the task is executed.
DBObjectProvider	getProvider() Gets the DBObjectProvider that this task is working against.
void	run()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBRunnable

public DBRunnable(DBObjectProvider pro,
                  java.lang.String name)

Create a new runnable that works against the given provider.

Parameters:

pro - the provider

name - a translated string describing the task for displaying to the user in the status UI.

Method Detail

getProvider

public final DBObjectProvider getProvider()

Gets the DBObjectProvider that this task is working against.

Returns:

the provider, which can be null

getName

public java.lang.String getName()

Gets a name for this task that can be displayed to the user in the status UI as the task is executed.

Returns:

a translated name

getLogger

protected java.util.logging.Logger getLogger()

Gets the Logger that any DBException thrown by doWork() will have its message logged on.

Returns:

a Logger for error logging

doWork

protected abstract void doWork()
                        throws DBException,
                               java.lang.InterruptedException

Does the work for this Runnable. Do not perform UI operations in this method, do the work against the provider, then if necessary schedule any relevant UI events using SwingUtilities.invokeLater.

DBRunnables are expected to be cancellable. If they are cancelled the thread will be interrupted. Any long running process should therefore check the thread's interrupted during execution and stop processing if it is true.

When using DBRequestProcessor.schedule(java.lang.String, oracle.ide.db.execute.DBRequestProcessor.DBRunnable, int) (rather than DBRequestProcessor.execute(oracle.ide.db.execute.DBRequestProcessor.DBRunnable)) interrupt checking by a DBRunnable is important. If it takes too long for the interrupted process to stop, then the replacement DBRunnable scheduled afterwards might have already started (i.e. the scheduler does not wait for the existing runnable to stop). This means that if a shared object (e.g.a DBObject) is modified by this method then the interruption should always be checked before any modification to that object.

Throws:

DBException - if the work against the provider failed

java.lang.InterruptedException - if the work was interrupted and did not complete. This is simply to allow interruptable API calls to be made without a catch in the doWork implementation, it is not necessary to throw InterruptedException when the thread has been interrupted.

cancelWork

protected void cancelWork()

Called if the runnable is cancelled or interrupted. If additional work is required to stop a task (beyond Thread interrupt) then override and implement in this method.

It is possible that doWork() will not have been called when this method is called (if the task was scheduled but waiting for execution when it was cancelled). It is also possible that it could be called after doWork() has finished.

run

public final void run()

Specified by:

run in interface java.lang.Runnable