oracle.ide.db.dialogs

Class BaseDBEditorFactory

java.lang.Object

oracle.ide.db.dialogs.BaseDBEditorFactory

All Implemented Interfaces:

DBEditorFactory

public class BaseDBEditorFactory
extends java.lang.Object

Default implementation of DBEditorFactory that uses registered PanelLibrary classes to determine which objects are supported, and to drive the use of the default db object editor.

Since:

11.0

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.ide.db.dialogs.DBEditorFactory

DBEditorFactory.EditorType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDBEditorFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCreateDBObject(DBObjectTypeNode node) Whether this DBEditorFactory will be able to create a new database object under the given node.
boolean	canCreateDBObject(Schema schema, DBObjectProvider pro, java.lang.String dbObjectType) Whether this DBEditorFactory will be able to create a new dabtabase object of a specific type in a specific context.
boolean	canEditDBObject(DBObject obj, DBObjectProvider pro) Whether this DBEditorFactory will be able to edit an existing provider object of a specific type in a specific context.
boolean	canEditDBObject(DBObjectNode node) Deprecated.
boolean	canEditDBObject(SchemaObject obj, DBObjectProvider pro)
protected boolean	canUpdateObject(DBObject obj, DBObjectProvider pro) If canEditDBObject returns true, then this method is used to determine whether the verifiers are set to be editable or not.
void	commitPerformed(DBEditorConfig config, PanelLibrary lib) Called when a successful commit is performed for the object being created or edited.
boolean	createDBObject(DBObject newObj, DBObjectProvider pro) Deprecated.
boolean	createDBObject(DBObject newObj, DBObjectProvider pro, boolean commitToProvider) Deprecated.
DBObject	createDBObject(DBObjectNode node, java.lang.String dbObjectType) Deprecated.
<T extends DBObject> T	createDBObject(DBObjectProvider pro, T template, DBObject parent, boolean commitToProvider) Deprecated.
SchemaObject	createDBObject(DBObjectTypeNode node) Deprecated.
SchemaObject	createDBObject(Schema schema, DBObjectProvider pro, java.lang.String dbObjectType) Deprecated.
DBObject	createDBObject(Schema schema, DBObjectProvider pro, java.lang.String dbObjectType, DBObject parent, boolean commitToProvider) Deprecated.
<T extends SystemObject> T	createDBObject(Schema schema, DBObjectProvider pro, T template, boolean commitToProvider) Deprecated.
protected <T extends DBObject> T	createDBObject(Schema schema, DBObjectProvider pro, T template, DBObject parent, boolean commitToProvider) Deprecated.
protected PanelLibrary	createLibrary(java.lang.String dbObjectType)
Namespace	createNamespace(DBEditorConfig config) Create a Namesapce for use in a TraversableContext from the given DBEditorConfig.
protected Namespace	createNamespace(DBEditorConfig config, java.util.Map<java.lang.String,java.lang.Class> verifiers) Deprecated. - use createNamespace(DBEditorConfig).
protected DBEditorFactory.EditorType	determineEditorType(DBEditorConfig config) Determines what the appropriate EditorType is for the given config.
boolean	editDBObject(DBObject obj, DBObjectProvider pro) Deprecated.
boolean	editDBObject(DBObject obj, DBObjectProvider pro, boolean commitToProvider) Deprecated.
boolean	editDBObject(DBObject obj, DBObjectProvider pro, DBObject child) Deprecated.
boolean	editDBObject(DBObject obj, DBObjectProvider pro, DBObject child, boolean commitToProvider) Deprecated.
boolean	editDBObject(DBObjectNode node) Edits and existing database object in a provider.
boolean	editDBObject(SchemaObject obj, DBObjectProvider pro) Deprecated.
java.lang.String	getCreateLabel(java.lang.String dbObjectType) Retrieves the menu label for creating new objects of the specified type.
protected java.awt.Component	getDialogHeader(DBEditorConfig config)
PanelLibrary	getPanelLibrary(java.lang.String dbObjectType)
static java.lang.String	getTimestampKey(java.lang.String type) This is the key used to suspect timestamps for the lifetime of an object dialog.
protected void	initializeLibrary(PanelLibrary lib) This is called when each library is created.
static boolean	isCreateContext(Context ideContext) Tests whether the given Context was created as the result of a create dialog commiting and then launching an Editor.
boolean	isCreateSupported(java.lang.String dbObjectType) Whether this DBEditorFactory supports the creation of objects of the specified type.
void	launchDialog(DBEditorConfig config) Launches a create or edit dialog appropriate to the given DBEditorConfig.
protected void	launchDialog(DBEditorConfig config, PanelLibrary lib, boolean edit)
java.lang.String[]	listSupportedTypes() Lists all the types that create/edit is supported for.
protected java.util.Collection<java.lang.String>	listSupportedTypesImpl()
protected void	registerLibrary(java.lang.String dbObjectType, java.lang.Class<? extends PanelLibrary> libClass)
static void	setEditorType(DBEditorConfig config, DBEditorFactory.EditorType editorType) Use when launching an editor to set the editor type on the config that was used to launch.
protected void	showEditor(DBEditorConfig config)
protected boolean	supportsObjectType(java.lang.String dbObjectType, DBObjectProvider pro)
protected void	unregisterLibrary(java.lang.String dbObjectType, java.lang.Class<? extends PanelLibrary> libClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDBEditorFactory

protected BaseDBEditorFactory()

Method Detail

getPanelLibrary

public PanelLibrary getPanelLibrary(java.lang.String dbObjectType)

createLibrary

protected PanelLibrary createLibrary(java.lang.String dbObjectType)

initializeLibrary

protected void initializeLibrary(PanelLibrary lib)

This is called when each library is created. At this stage default panels can be added to the library.

See Also:

PanelLibrary.setDefaultPanels(oracle.ide.panels.Navigable[])

registerLibrary

protected void registerLibrary(java.lang.String dbObjectType,
                   java.lang.Class<? extends PanelLibrary> libClass)

unregisterLibrary

protected void unregisterLibrary(java.lang.String dbObjectType,
                     java.lang.Class<? extends PanelLibrary> libClass)

listSupportedTypes

public java.lang.String[] listSupportedTypes()

Description copied from interface: DBEditorFactory

Lists all the types that create/edit is supported for.

Returns:

an array of the types edit dialogs are available for.

See Also:

DBObject.getType()

listSupportedTypesImpl

protected java.util.Collection<java.lang.String> listSupportedTypesImpl()

isCreateSupported

public boolean isCreateSupported(java.lang.String dbObjectType)

Description copied from interface: DBEditorFactory

Whether this DBEditorFactory supports the creation of objects of the specified type. This is primarily used to determine whether a context menu item should be added for the type; the menu may or may not be enabled depending on whether the factory can create objects in a particular context.

Parameters:

dbObjectType - the type of object

Returns:

whether the 'New' menu item should be added

See Also:

DBObject.getType()

canCreateDBObject

public boolean canCreateDBObject(Schema schema,
                        DBObjectProvider pro,
                        java.lang.String dbObjectType)

Description copied from interface: DBEditorFactory

Whether this DBEditorFactory will be able to create a new dabtabase object of a specific type in a specific context.

Parameters:

schema - The schema to create the object in

pro - The DBObjectProvider instance to create the object in

dbObjectType - The type of database object to create

See Also:

DBObjectProvider, DBObject.getType()

supportsObjectType

protected boolean supportsObjectType(java.lang.String dbObjectType,
                         DBObjectProvider pro)

launchDialog

public final void launchDialog(DBEditorConfig config)

Description copied from interface: DBEditorFactory

Launches a create or edit dialog appropriate to the given DBEditorConfig. To be notified of the completion of the dialog, add a listener to the config.

Parameters:

config - the configuration for launching the dialog

launchDialog

protected void launchDialog(DBEditorConfig config,
                PanelLibrary lib,
                boolean edit)

determineEditorType

protected DBEditorFactory.EditorType determineEditorType(DBEditorConfig config)

Determines what the appropriate EditorType is for the given config. The returned EditorType will be set on the config and used to configure the appropriate editor.

Parameters:

config - the config we will launch with

Returns:

the type of editor that should be launched

commitPerformed

public void commitPerformed(DBEditorConfig config,
                   PanelLibrary lib)

Called when a successful commit is performed for the object being created or edited.

showEditor

protected final void showEditor(DBEditorConfig config)

canEditDBObject

public boolean canEditDBObject(DBObject obj,
                      DBObjectProvider pro)

Description copied from interface: DBEditorFactory

Whether this DBEditorFactory will be able to edit an existing provider object of a specific type in a specific context.

Parameters:

obj - The SchemaObject to be edited

pro - The DBObjectProvider instance to create the object in

getCreateLabel

public java.lang.String getCreateLabel(java.lang.String dbObjectType)

Description copied from interface: DBEditorFactory

Retrieves the menu label for creating new objects of the specified type.

Parameters:

dbObjectType - the type of object

Returns:

the menu label

See Also:

DBObject.getType()

createNamespace

public Namespace createNamespace(DBEditorConfig config)

Create a Namesapce for use in a TraversableContext from the given DBEditorConfig.

createNamespace

@Deprecated
protected Namespace createNamespace(DBEditorConfig config,
                                   java.util.Map<java.lang.String,java.lang.Class> verifiers)

Deprecated. - use createNamespace(DBEditorConfig).

canUpdateObject

protected boolean canUpdateObject(DBObject obj,
                      DBObjectProvider pro)

If canEditDBObject returns true, then this method is used to determine whether the verifiers are set to be editable or not. If not then all edits within the dialog should be disabled.

By default this just returns true - i.e. allowing the edit of any object canEditDBObject returns true for.

Returns:

whether the edit dialog will allow the user to change anything

getDialogHeader

protected java.awt.Component getDialogHeader(DBEditorConfig config)

getTimestampKey

public static java.lang.String getTimestampKey(java.lang.String type)

This is the key used to suspect timestamps for the lifetime of an object dialog.

isCreateContext

public static boolean isCreateContext(Context ideContext)

Tests whether the given Context was created as the result of a create dialog commiting and then launching an Editor.

setEditorType

public static void setEditorType(DBEditorConfig config,
                 DBEditorFactory.EditorType editorType)

Use when launching an editor to set the editor type on the config that was used to launch.

canCreateDBObject

public final boolean canCreateDBObject(DBObjectTypeNode node)

Description copied from interface: DBEditorFactory

Whether this DBEditorFactory will be able to create a new database object under the given node.

Specified by:

canCreateDBObject in interface DBEditorFactory

createDBObject

@Deprecated
public final SchemaObject createDBObject(Schema schema,
                                     DBObjectProvider pro,
                                     java.lang.String dbObjectType)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object of a specific type in the given schema and provider.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

schema - The schema to create the object in

pro - The DBObjectProvider instance to create the object in

dbObjectType - The type of database object to create

Returns:

the new object if it was successfully created

See Also:

DBObjectProvider, DBObject.getType()

createDBObject

@Deprecated
public final SchemaObject createDBObject(DBObjectTypeNode node)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object. The type, schema and provider are all taken from the given node.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

node - the node describing the schema, type and provider

Returns:

the new object if it was successfully created

createDBObject

@Deprecated
public final <T extends SystemObject> T createDBObject(Schema schema,
                                                   DBObjectProvider pro,
                                                   T template,
                                                   boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object using the given object as a template in the given schema and provider using the given parent object.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

schema - The schema to create the object in

pro - The DBObjectProvider instance to create the object in

template - An object to use as a template for the new object

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, create a new Index as part of the edit and commit the whole lot together later).

Returns:

the new object if it was successfully created

See Also:

DBObjectProvider, DBObject.getType()

createDBObject

@Deprecated
public final <T extends DBObject> T createDBObject(DBObjectProvider pro,
                                               T template,
                                               DBObject parent,
                                               boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object using the given template.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

pro - The DBObjectProvider instance to create the object in

template - the template for the new object

parent - the owning object of the object to be created (e.g. Table for a new Index)

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, create a new Index as part of the edit and commit the whole lot together later).

Returns:

the new object if it was successfully created

See Also:

DBObjectProvider, DBObject.getType()

createDBObject

@Deprecated
protected final <T extends DBObject> T createDBObject(Schema schema,
                                               DBObjectProvider pro,
                                               T template,
                                               DBObject parent,
                                               boolean commitToProvider)

Deprecated.

createDBObject

@Deprecated
public final DBObject createDBObject(DBObjectNode node,
                                 java.lang.String dbObjectType)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object of given type using the given node's object as a parent. So, for example, if the node is a Table node and dbObjectType is Index.TYPE this will fire the new Index dialog using the Table as a base.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

node - the node for the parent object

dbObjectType - the type of child object to be created

Returns:

the newly object if it was successfully created

createDBObject

@Deprecated
public final boolean createDBObject(DBObject newObj,
                                DBObjectProvider pro)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new schema object using the given starting object in the given provider.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

newObj - the new object being created

pro - The DBObjectProvider instance to create the object in

Returns:

whether the object was sucessfully created.

See Also:

DBObjectProvider

createDBObject

@Deprecated
public final boolean createDBObject(DBObject newObj,
                                DBObjectProvider pro,
                                boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new schema object using the given starting object in the given provider.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

newObj - the new object being created

pro - The DBObjectProvider instance to create the object in

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, create a new Index as part of the edit and commit the whole lot together later).

Returns:

whether the object was sucessfully created.

See Also:

DBObjectProvider

createDBObject

@Deprecated
public final DBObject createDBObject(Schema schema,
                                 DBObjectProvider pro,
                                 java.lang.String dbObjectType,
                                 DBObject parent,
                                 boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Creates a new database object of a specific type in the given schema and provider using the given parent object.

Specified by:

createDBObject in interface DBEditorFactory

Parameters:

schema - The schema to create the object in

pro - The DBObjectProvider instance to create the object in

dbObjectType - The type of database object to create

parent - the owning object of the object to be created (e.g. Table for a new Index)

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, create a new Index as part of the edit and commit the whole lot together later).

Returns:

the new object if it was successfully created

See Also:

DBObjectProvider, DBObject.getType()

canEditDBObject

public final boolean canEditDBObject(SchemaObject obj,
                      DBObjectProvider pro)

Specified by:

canEditDBObject in interface DBEditorFactory

See Also:

DBEditorFactory.canEditDBObject(DBObject,DBObjectProvider)

canEditDBObject

@Deprecated
public final boolean canEditDBObject(DBObjectNode node)

Deprecated.

Specified by:

canEditDBObject in interface DBEditorFactory

editDBObject

@Deprecated
public final boolean editDBObject(DBObject obj,
                              DBObjectProvider pro)

Deprecated.

Description copied from interface: DBEditorFactory

Edits an existing database object in a provider.

Specified by:

editDBObject in interface DBEditorFactory

Parameters:

obj - The SchemaObject to be edited

pro - The DBObjectProvider instance to create the object in

Returns:

whether the object was sucessfully edited.

editDBObject

@Deprecated
public final boolean editDBObject(SchemaObject obj,
                              DBObjectProvider pro)

Deprecated.

Specified by:

editDBObject in interface DBEditorFactory

See Also:

DBEditorFactory.editDBObject(DBObject,DBObjectProvider)

editDBObject

@Deprecated
public boolean editDBObject(DBObject obj,
                              DBObjectProvider pro,
                              boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Edits an existing database object in a provider.

Specified by:

editDBObject in interface DBEditorFactory

Parameters:

obj - The SchemaObject to be edited

pro - The DBObjectProvider instance to create the object in

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, edit an Index as part of the table edit and commit the whole lot together later).

Returns:

whether the object was sucessfully edited.

editDBObject

@Deprecated
public final boolean editDBObject(DBObject obj,
                              DBObjectProvider pro,
                              DBObject child)

Deprecated.

Description copied from interface: DBEditorFactory

Edits an existing database object in a provider.

Specified by:

editDBObject in interface DBEditorFactory

Parameters:

obj - The SchemaObject to be edited

pro - The DBObjectProvider instance to create the object in

child - a specific child object to edit

Returns:

whether the object was sucessfully edited.

editDBObject

public final boolean editDBObject(DBObjectNode node)

Description copied from interface: DBEditorFactory

Edits and existing database object in a provider. The object to edit is represented by the given node.

Specified by:

editDBObject in interface DBEditorFactory

Parameters:

node - the node representing the object to edit.

Returns:

whether the object was sucessfully edited.

See Also:

#launchDialog(DBEditorConfig)}

editDBObject

@Deprecated
public final boolean editDBObject(DBObject obj,
                              DBObjectProvider pro,
                              DBObject child,
                              boolean commitToProvider)

Deprecated.

Description copied from interface: DBEditorFactory

Edits an existing database object in a provider.

Specified by:

editDBObject in interface DBEditorFactory

Parameters:

obj - The SchemaObject to be edited

pro - The DBObjectProvider instance to create the object in

child - a specific child object to edit

commitToProvider - whether the dialog should commit the change back to the DBObjectProvider as well as the parent object. This allows a dialog to be fired from within another editor context (e.g. the modeler) and the edit absorbed into the edit of the parent (e.g. editing a Table, edit an Index as part of the table edit and commit the whole lot together later).

Returns:

whether the object was sucessfully edited.