oracle.dss.thin.beans.persistence
Class ExplorerTree

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.persistence.Explorer
              |
              +--oracle.dss.thin.beans.persistence.ExplorerTree

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class ExplorerTree

extends Explorer

The ExplorerTree thin bean. ExplorerTree is used to display contents of the BI Beans Catalog in a hierarhical tree form.

Setting up the ExplorerTree

To set up the ExplorerTree, application developer needs to set an implementation of the oracle.dss.bicontext.BIContext interface onto it. For more details, see BIContext. ExplorerTree fires ExplorerEvents to notify the registered ExplorerListeners when a tree node is selected. For more details, see ExplorerListener, ExplorerEvent.

The ExplorerTree generates the following events:

• BIConstants.GOTO_ROW_EVENT -- generated by row navigation in ExplorerDetail/ExplorerSearch
• BIConstants.SELECT_OBJECT_EVENT -- generated when a BI Beans Catalog item was selected in any of the Explorer beans
• BIConstants.SELECT_FOLDER_EVENT -- generated when a BI Beans Catalog folder was selected in any of the Explorer beans
• BIConstants.FILTER_EVENT -- generated by filtering the object types displayed by the Explorer beans
• BIConstants.SEARCH_EVENT -- generated from the ExplorerTree search area, and from the ExplorerSearch
• BIConstants.EXPAND_FOLDER_EVENT -- generated when ExplorerTree folder is expanded
• BIConstants.COLLAPSE_FOLDER_EVENT -- generated when ExplorerTree folder is collapsed

The ExplorerTree handles the following events:

• BIConstants.GOTO_ROW_EVENT -- generated by row navigation in ExplorerDetail/ExplorerSearch
• BIConstants.SELECT_OBJECT_EVENT -- generated when a BI Beans Catalog item was selected in any of the Explorer beans
• BIConstants.SELECT_FOLDER_EVENT -- generated when a BI Beans Catalog folder was selected in any of the Explorer beans
• BIConstants.FILTER_EVENT -- generated by filtering the object types displayed by the Explorer beans
• BIConstants.SEARCH_EVENT -- generated from the ExplorerTree search area, and from the ExplorerSearch
• BIConstants.EXPAND_FOLDER_EVENT -- generated when ExplorerTree folder is expanded
• BIConstants.COLLAPSE_FOLDER_EVENT -- generated when ExplorerTree folder is collapsed

For more information about using the ExplorerTree, see the "Explorer Tree" topic in the BI Beans Help system.

See Also:

Explorer, ExplorerDetail, ExplorerSearch, ExplorerListener, ExplorerEvent, SaveAs

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ExplorerTree()
Constructor.

Method Summary

boolean	expandPath(java.lang.String path) Expands the given path in the tree
java.lang.String[]	getObjectTypeNames() Retrieves the names of types displayed in the object type filter
java.lang.String	getTitle() Retrieves the title to be displayed above the tree
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
boolean	isFoldersSelectable() Indicates whether the ExplorerTree allows folder selection
void	setExplorerDetail(ExplorerDetail explorerDetail) Sets the ExplorerDetail on the ExplorerTree
void	setFoldersSelectable(boolean selectable) Specifies whether the ExplorerTree allows folder selection
void	setSelectedPath(java.lang.String path) Specifies the selected path.
void	setTitle(java.lang.String title) Specifies the title to be displayed above the tree

Methods inherited from class oracle.dss.thin.beans.persistence.Explorer

addExplorerListener, checkpointState, getBIContext, getCheckpointState, getLastSelectedPath, getObjectType, getObjectTypes, getRootName, getRowBlockSize, getSaveAs, getSearchControls, getSearchFilters, getSearchFoldersLimit, getSelectedObjectType, getSelectedPath, getStartRow, getState, isFoldersVisible, isObjectFilterVisible, isSearchVisible, refreshModel, removeExplorerListener, setBaseState, setBIContext, setCheckpointState, setFoldersVisible, setObjectFilterVisible, setObjectType, setObjectTypeNames, setObjectTypes, setRootName, setRowBlockSize, setSaveAs, setSearchControls, setSearchFilters, setSearchFoldersLimit, setSearchVisible, setStartRow, setState

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, generateOnClickSubmit, getEventTarget, getLocale, getThinBeanName, removeErrorHandler, setEventTarget, setLocale, setThinBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplorerTree

public ExplorerTree()

Constructor.

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request. To determine the correct ThinBean to call handleEvent() on, the application should check the "source" query parameter, which will be the ThinBeanName of the ThinBean that rendered the URL/Form in HTML and which also needs to handle the event. The application can also choose to call handleEvent on all of its ThinBeanUI components and check the return value of handleEvent() to determine which component has handled the event. Each ThinBeanUI component needs to check the source parameter to make sure that it matches their ThinBeanName. If it does not match, then the event should not be processed.

Overrides:

handleEvent in class Explorer

Parameters:

provider - An instance of a QueryParameterProvider that returns decoded and unescaped query parameter values from HTTPServletRequests

Returns:

EVENT_NOT_HANDLED, EVENT_HANDLED, or EVENT_RESPONSE_DONE

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE

setExplorerDetail

public void setExplorerDetail(ExplorerDetail explorerDetail)
                       throws javax.naming.NamingException

Sets the ExplorerDetail on the ExplorerTree

Parameters:

explorerDetail - the ExplorerDetail thin bean

Throws:

javax.naming.NamingException - if the ExplorerDetail could not be updated with the contents of ExplorerTree's current folder

getTitle

public java.lang.String getTitle()

Retrieves the title to be displayed above the tree

Returns:

title

setTitle

public void setTitle(java.lang.String title)

Specifies the title to be displayed above the tree

Parameters:

title -

setSelectedPath

public void setSelectedPath(java.lang.String path)
                     throws javax.naming.NamingException

Specifies the selected path. If the path is not currently visible, the tree nodes leading to the path will get expanded to display the new selected path.

Overrides:

setSelectedPath in class Explorer

Parameters:

path - the path that is to appear as selected in the ExplorerTree

Throws:

javax.naming.NamingException - if the path could not be selected

expandPath

public boolean expandPath(java.lang.String path)
                   throws javax.naming.NamingException

Expands the given path in the tree

Parameters:

path - the String path to be expanded

Returns:

true if the path was expanded successfully

Throws:

javax.naming.NamingException - if the path could not be expanded

getObjectTypeNames

public java.lang.String[] getObjectTypeNames()

Retrieves the names of types displayed in the object type filter

Overrides:

getObjectTypeNames in class Explorer

Returns:

the String array of type names to be displayed in the UI

isFoldersSelectable

public boolean isFoldersSelectable()

Indicates whether the ExplorerTree allows folder selection

Returns:

true if the folders can be selected

setFoldersSelectable

public void setFoldersSelectable(boolean selectable)

Specifies whether the ExplorerTree allows folder selection

Parameters:

true - if the folders can be selected