oracle.dss.persistence.gui
Class CustomObjectManagerImpl

java.lang.Object
  |
  +--oracle.dss.persistence.gui.CustomObjectManagerImpl

All Implemented Interfaces:

CustomObjectManager

public class CustomObjectManagerImpl

extends java.lang.Object

implements CustomObjectManager

The implementation of CustomObjectManager interface to assist in saving and loading objects from the repository.

Constructor Summary

CustomObjectManagerImpl(BIContext userRootContext)
Constructor.

CustomObjectManagerImpl(BIContext userRootContext, java.lang.String favoritePath)
Constructor.

CustomObjectManagerImpl(BIContext userRootContext, java.lang.String favoritePath, BIContext[] initContextPaths)
Constructor.

Method Summary

boolean	deleteObject(ObjectBinding obj) Deletes the object from the persistence storage.
ErrorHandler	getErrorHandler() Returns and ErrorHandler object that's used for logging errors.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Retrieves the HelpProvider.
java.util.Locale	getLocale() Retrieves the locale that has been specified for this component.
java.lang.String	getSelectedName() Returns the name of the currently selected object.
java.lang.String	getSelectedPath() Returns the full path of the currently selected object.
java.util.Vector	listAllObjects(java.lang.String objectType) Provides a list of ObjectBindings of all objects of the given type that are found in the persistence storage (given the filters set on the persistence manager by the application that set permissions, roots, etc.).
ObjectBinding	loadObjectByType(java.lang.String objectType) Retrives from the persistence storage an object of a given type.
ObjectBinding	saveObjectByType(java.lang.String objectType, StringXMLizable objectToBeSaved) Saves an object of a given type in the persistence storage.
void	setErrorHandler(ErrorHandler errorHandler) Sets an ErrorHandler object that's used for logging errors.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Specifies the HelpProvider.
void	setLocale(java.util.Locale locale) Specifies the locale for this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomObjectManagerImpl

public CustomObjectManagerImpl(BIContext userRootContext)
                        throws BINoInitialContextException

Constructor.

Parameters:

userRootContext - BIContext object representing the top-most folder (root) within which we can search for objects and save objects

Throws:

BINoInitialContextException - if userRootContext is null

CustomObjectManagerImpl

public CustomObjectManagerImpl(BIContext userRootContext,
                               java.lang.String favoritePath)
                        throws BINoInitialContextException

Constructor.

Parameters:

userRootContext - BIContext object representing the top-most folder (root) within which we can search for objects and save objects

favoritePath - a String representing the default folder (relative to userRootContext) where the user will be taken automatically when evoking saving/loading dialogs

Throws:

BINoInitialContextException - if userRootContext is null

CustomObjectManagerImpl

public CustomObjectManagerImpl(BIContext userRootContext,
                               java.lang.String favoritePath,
BIContext[] initContextPaths)
                        throws BINoInitialContextException

Constructor.

Parameters:

userRootContext - BIContext object representing the top-most folder (root) within which we can search for objects and save objects

favoritePath - a String representing the default folder (relative to userRootContext) where the user will be taken automatically when evoking saving/loading dialogs

initContextPath - a vector of BIContext each of which represents a folder where objects will be loaded from at the initial stage

Throws:

BINoInitialContextException - if userRootContext is null

Method Detail

listAllObjects

public java.util.Vector listAllObjects(java.lang.String objectType)

Provides a list of ObjectBindings of all objects of the given type that are found in the persistence storage (given the filters set on the persistence manager by the application that set permissions, roots, etc.).

Specified by:

listAllObjects in interface CustomObjectManager

Parameters:

objectType - a string representing the type of the objects that we are looking for

Returns:

a vector of objects (of type ObjectBinding) of a given type null if no objects of this type are found

loadObjectByType

public ObjectBinding loadObjectByType(java.lang.String objectType)

Retrives from the persistence storage an object of a given type. This method is expected to evoke a "Browse" UI that, when closed, will return an object (in the form of ObjectBinding) selected by the user.

Specified by:

loadObjectByType in interface CustomObjectManager

Parameters:

objectType - a string representing the type of the object that we are looking for; if it's null or an empty string, no search filter will be provided in the FileChooser UI and the user will be able to select an object of any type.

Returns:

an object retrieved from the persistence storage null if no object matching the given criteria is found or if the user clicks on the "Cancel" button.

saveObjectByType

public ObjectBinding saveObjectByType(java.lang.String objectType,
StringXMLizable objectToBeSaved)

Saves an object of a given type in the persistence storage. This method is expected to bring a "Browse" UI that will let the user select where the object should be save to and the name of the object.

Specified by:

saveObjectByType in interface CustomObjectManager

Parameters:

objectType - a string representing the type of the object that we are saving

objectToBeSaved - an object that we are saving

Returns:

the ObjectBinding representation of the object we saved null if saving failed

deleteObject

public boolean deleteObject(ObjectBinding obj)

Deletes the object from the persistence storage.

Specified by:

deleteObject in interface CustomObjectManager

Parameters:

obj - an ObjectBinding representing the object to be deleted

Returns:

true if deleting succeed false if deleting failed

getSelectedPath

public java.lang.String getSelectedPath()

Returns the full path of the currently selected object. null if no object is selected.

Specified by:

getSelectedPath in interface CustomObjectManager

getSelectedName

public java.lang.String getSelectedName()

Returns the name of the currently selected object. null if no object is selected.

Specified by:

getSelectedName in interface CustomObjectManager

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Retrieves the HelpProvider.

Returns:

The HelpProvider.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Specifies the HelpProvider.

Parameters:

helpProvider - The HelpProvider.

getLocale

public java.util.Locale getLocale()

Retrieves the locale that has been specified for this component. This method returns the locale that was specified in the setLocale method or the default locale if none are specified.

Returns:

The locale specified for this component.

See Also:

setLocale(java.util.Locale)

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this component. The locale specified in this method takes precedence over the default locale setting. This method differs from the java.lang.util.Locale.setLocale method, in that this method sets the locale only for this instance of the CustomObjectManagerImpl.

The locale setting affects the text that is displayed and the date format, when details are displayed.

Parameters:

locale - The locale for this component to use.

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Sets an ErrorHandler object that's used for logging errors. If an error handler has been set, then this CustomObjectManagerImpl reports error conditions to the handler. Otherwise, it prints the stack trace.

Parameters:

errorHandler - ErrorHandler

getErrorHandler

public ErrorHandler getErrorHandler()

Returns and ErrorHandler object that's used for logging errors.

Returns:

ErrorHandler