oracle.ide.db

Class ProviderOperator

java.lang.Object

oracle.ide.db.ProviderOperator

public final class ProviderOperator
extends java.lang.Object

Utility class that wraps a create, update or delete operation within the provider. Designed for use by UI features to standardize behaviour (e.g. prompting for replace or cascade confirmation, use of a progress bar etc).

It is safe to use this in code that runs in headless junit tests. When running headless all commits will happen in the calling thread and exceptions will be logged rather than using an error dialog.

Since:

12

Constructor Summary

Constructors

Constructor and Description
ProviderOperator(DBObjectProvider pro) Creates a new operator for making changes in the given provider.
ProviderOperator(DBObjectProvider pro, Context context) Creates a new operator for making changes in the given provider.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commitTransaction(DBObjectTransaction txn) Commits the changes in the given transaction.
boolean	createObjects(SystemObject[] objs) Creates the given objects in the provider.
Difference	difference(SystemObject[] orig, SystemObject[] upd) Diffs the two sets of objects using the provider's DiffEngine.
static java.lang.String	getTitle(DBEditorConfig config) Gets a default generic title appropriate for the given editor config.
void	setTitle(java.lang.String title) Optionally sets a title that will be used for the progress bar and any error dialog shown to the user.
boolean	updateObjects(DBEditorConfig config) Creates or updates the object in the given editor config using the CascadeConfirmDialog.
boolean	updateObjects(SystemObject[] old, SystemObject[] updateObjs) Updates the given objects in the provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderOperator

public ProviderOperator(DBObjectProvider pro)

Creates a new operator for making changes in the given provider.

Parameters:

pro - the provider the operations will be performed in

ProviderOperator

public ProviderOperator(DBObjectProvider pro,
                Context context)

Creates a new operator for making changes in the given provider.

Parameters:

pro - the provider the operations will be performed in

context - the IDE context we're working within

Method Detail

setTitle

public void setTitle(java.lang.String title)

Optionally sets a title that will be used for the progress bar and any error dialog shown to the user. A default title will be created assuming a generic create or edit given the object(s) being edited if this is not called.

Parameters:

title - the title to use for any dialogs.

difference

public Difference difference(SystemObject[] orig,
                    SystemObject[] upd)

Diffs the two sets of objects using the provider's DiffEngine.

createObjects

public boolean createObjects(SystemObject[] objs)

Creates the given objects in the provider.

Parameters:

the - objects to create

Returns:

whether the objects were created successfully or not.

See Also:

DBObjectProvider.createObjects(SystemObject[],boolean)

updateObjects

public boolean updateObjects(SystemObject[] old,
                    SystemObject[] updateObjs)

Updates the given objects in the provider.

See Also:

DBObjectProvider.updateObjects(SystemObject[],SystemObject[])

updateObjects

public boolean updateObjects(DBEditorConfig config)

Creates or updates the object in the given editor config using the CascadeConfirmDialog.

Parameters:

config - contains provider, new object and (when editing) original object to update with.

Returns:

true if the update was successful, or if there were no changes to update

commitTransaction

public boolean commitTransaction(DBObjectTransaction txn)

Commits the changes in the given transaction. The commit is guaranteed to happen off the EDT. If an error occurs the user will be notified.

Parameters:

txn - the changes to commit

Returns:

true if the update was successful

getTitle

public static java.lang.String getTitle(DBEditorConfig config)

Gets a default generic title appropriate for the given editor config.