Skip navigation links

oracle.jdeveloper.offlinedb.wizard
Class ProviderWizard

java.lang.Object
oracle.ide.wizard.Wizard
oracle.jdeveloper.offlinedb.wizard.ProviderWizard

public class ProviderWizard

extends Wizard

Wizard for creating an Offline Database (OfflineDBObjectProvider). The class also contains static methods for creating, editing and choosing Offline Database providers.

Constructor Summary

ProviderWizard()

Method Summary

static void	addPanel(java.lang.String title, java.lang.Class panel, java.lang.String helpID) Adds a panel to the ProviderWizard so that whenever a provider is created, or its settings edited, the given panel appear in the dialog.
static OfflineDBObjectProvider	chooseProvider(Context c, boolean allowApplicationCreate, boolean allowProjectCreate, boolean allowProviderCreate) Prompts the user to choose an offline database in the given Context, optionally they can be allowed to create a new one.
static OfflineDBObjectProvider	chooseProvider(Context c, OfflineDBObjectProvider defaultSelection, boolean allowApplicationCreate, boolean allowProjectCreate, boolean allowProviderCreate) Prompts the user to choose an offline database in the given Context, optionally they can be allowed to create a new one.
static OfflineDBObjectProvider	chooseProvider(Project p, boolean allowProviderCreate) Prompts the user to choose an offline database in the given Project, optionally they can be allowed to create a new one.
static OfflineDBObjectProvider	chooseProvider(Project p, boolean allowProviderCreate, boolean incProjDeps) Prompts the user to choose an offline database in the given Project, optionally they can be allowed to create a new one.
static OfflineDBObjectProvider	chooseProvider(Project p, boolean allowProviderCreate, Database db) Allow the user to choose an offline provider that is compatible with the given provider settings from the given project (including its dependencies), The supplied Database will be used as the base for the offline database.
static OfflineDBObjectProvider	chooseProvider(Project p, OfflineDBObjectProvider pro) Allow the user to choose an offline provider that is compatible with the given provider from the given project (including its dependencies).
static OfflineDBObjectProvider	chooseProvider(Project p, ProviderSettings settings, java.net.URL url) Allow the user to choose an offline provider that is compatible with the given provider settings from the given project (including its dependencies).
static OfflineDBObjectProvider	createProvider(Context c) Launches the dialog to create a provider.
static OfflineDBObjectProvider	createProvider(Context c, java.lang.String name, java.lang.String schema, java.lang.Class clz) Launches the dialog to create a provider, based on supplied values
static boolean	editProvider(Context c) Launches the editor on the provider in the given context.
static OfflineDBObjectProvider	findOrCreateProviderNode(Project p, ProviderSettings settings)
javax.swing.Icon	getIcon() Gets the Icon to use in the Object Gallery.
java.lang.String	getLongLabel() Provides a description of the Wizard that appears in the hint text area of the Object Gallery.
java.lang.String	getShortLabel() Provides the label that represents the Wizard in the Object Gallery.
static void	initialiseTemplates(Context c, OfflineDBObjectProvider pro, java.lang.Boolean initialise, java.lang.Boolean edit) Called to handle the templates of a given offline database.
boolean	invoke(Context context) Invokes the wizard.
boolean	isAvailable(Context context) Called when the sensitivity of the menu item that opens this wizard must be determined.
static void	removePanel(java.lang.String title) Removes a previously registered panel from the ProviderWizard.
static void	showMissingProviderError(Context c, java.lang.String title) Shows a dialog to the user letting them know that the .offlinedb file is missing and we cannot continue without it.

Methods inherited from class oracle.ide.wizard.Wizard

getLegacyParams, getMenuSpecification, getToolTipText, setLegacyParams, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderWizard

public ProviderWizard()

Method Detail

isAvailable

public boolean isAvailable(Context context)

Description copied from class: Wizard

Called when the sensitivity of the menu item that opens this wizard must be determined.

Specified by:

isAvailable in class Wizard

Parameters:

context - The Context to use when invoking this Wizard.

Returns:

true if the wizard can be invoked, or false otherwise.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Wizard

Provides the label that represents the Wizard in the Object Gallery. The label should be a noun or noun phrase naming the item that is created by this Wizard and should omit the word "new". Examples: "Java Class", "Java Interface", "XML Document", "Database Connection".

Specified by:

getShortLabel in class Wizard

Returns:

The human readable label of the Wizard.

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Wizard

Gets the Icon to use in the Object Gallery. If this Wizard is not accessed from the Object Gallery, the Wizard should return null.

Overrides:

getIcon in class Wizard

Returns:

The Icon to be displayed in the Object Gallery.

getLongLabel

public java.lang.String getLongLabel()

Description copied from class: Wizard

Provides a description of the Wizard that appears in the hint text area of the Object Gallery. This is usually a verb phrase starting with "Creates a...". The default implementation uses a format string for "Creates a new ____", filling in the blank with the value from Wizard.getShortLabel().

Overrides:

getLongLabel in class Wizard

invoke

public boolean invoke(Context context)

Description copied from class: Wizard

Invokes the wizard.

Specified by:

invoke in class Wizard

Parameters:

context - The context of the wizard. All parameters required by the wizard must be set on the context. The wizard may also return values to the caller by setting them into the Context for the caller to retrieve.

Returns:

true if the invocation was successful, false if it failed or was canceled.

addPanel

public static void addPanel(java.lang.String title,
                            java.lang.Class panel,
                            java.lang.String helpID)

Adds a panel to the ProviderWizard so that whenever a provider is created, or its settings edited, the given panel appear in the dialog. The provider settings PropertyStorage is available to the navigable via the getPropertyStorage() method on the TraversableContext passed into the panel onEntry and onExit.

removePanel

public static void removePanel(java.lang.String title)

Removes a previously registered panel from the ProviderWizard.

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Project p,
                                                     boolean allowProviderCreate)

Prompts the user to choose an offline database in the given Project, optionally they can be allowed to create a new one. The provider for the chosen database is returned (could be null if none chosen). By default any project dependencies are included in the list. This is the prefered method of choosing an offline provider.

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Project p,
                                                     OfflineDBObjectProvider pro)

Allow the user to choose an offline provider that is compatible with the given provider from the given project (including its dependencies).

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Project p,
                                                     ProviderSettings settings,
                                                     java.net.URL url)

Allow the user to choose an offline provider that is compatible with the given provider settings from the given project (including its dependencies).

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Project p,
                                                     boolean allowProviderCreate,
                                                     boolean incProjDeps)

Prompts the user to choose an offline database in the given Project, optionally they can be allowed to create a new one. The provider for the chosen database is returned (could be null if none chosen).

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Context c,
                                                     boolean allowApplicationCreate,
                                                     boolean allowProjectCreate,
                                                     boolean allowProviderCreate)

Prompts the user to choose an offline database in the given Context, optionally they can be allowed to create a new one. Additionally the user can be allowed to choose and create new applications and projects if that is desired. The provider for the chosen database is returned (could be null if none chosen).

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Project p,
                                                     boolean allowProviderCreate,
                                                     Database db)

Allow the user to choose an offline provider that is compatible with the given provider settings from the given project (including its dependencies), The supplied Database will be used as the base for the offline database.

chooseProvider

public static OfflineDBObjectProvider chooseProvider(Context c,
                                                     OfflineDBObjectProvider defaultSelection,
                                                     boolean allowApplicationCreate,
                                                     boolean allowProjectCreate,
                                                     boolean allowProviderCreate)

Prompts the user to choose an offline database in the given Context, optionally they can be allowed to create a new one. Additionally the user can be allowed to choose and create new applications and projects if that is desired. The user may provide a default selection for the provider wizard -- if not supplied the provider in the context is used. The provider for the chosen database is returned (could be null if none chosen).

editProvider

public static boolean editProvider(Context c)

Launches the editor on the provider in the given context.

createProvider

public static OfflineDBObjectProvider createProvider(Context c,
                                                     java.lang.String name,
                                                     java.lang.String schema,
                                                     java.lang.Class clz)

Launches the dialog to create a provider, based on supplied values

Parameters:

c - an IdeContext, possibly taken from the Travesablecontext

name - the value to populate the set the name field in the provider dialog

schema - the value to populate the schema field in the provider dialog

clz - the class needed to populate the Database emulaion value.

createProvider

public static OfflineDBObjectProvider createProvider(Context c)

Launches the dialog to create a provider.

findOrCreateProviderNode

public static OfflineDBObjectProvider findOrCreateProviderNode(Project p,
                                                               ProviderSettings settings)
                                                        throws java.io.IOException,
                                                               DBException,
                                                               java.lang.IllegalAccessException,
                                                               java.lang.InstantiationException

Throws:

java.io.IOException

DBException

java.lang.IllegalAccessException

java.lang.InstantiationException

showMissingProviderError

public static void showMissingProviderError(Context c,
                                            java.lang.String title)

Shows a dialog to the user letting them know that the .offlinedb file is missing and we cannot continue without it.

Parameters:

c - the current context

title - the title for the resulting dialog (if null a default will be used).

initialiseTemplates

public static void initialiseTemplates(Context c,
                                       OfflineDBObjectProvider pro,
                                       java.lang.Boolean initialise,
                                       java.lang.Boolean edit)

Called to handle the templates of a given offline database. The templates can be optionally initialised with default template objects, and/or the template editor launched.

Parameters:

c - the current IDE context

pro - the offline database to initialise the templates on

initialise - whether to initialise default templates for the given offline database

edit - whether to launch the template editor dialog on the offline database's template settings.

Skip navigation links