oracle.dss.thin.beans.persistence
Class ExplorerDetail

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

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

Direct Known Subclasses:

ExplorerSearch

public class ExplorerDetail

extends Explorer

ExplorerDetail thin bean. ExplorerDetail is used to display contents of one BI Beans catalog folder.

Setting up the ExplorerDetail

To set up the ExplorerDetail, application developer needs to set an implementation of the oracle.dss.bicontext.BIContext interface onto it. For more details, see BIContext.

ExplorerDetail can be used standalone or in conjunction with the ExplorerTree. To combine ExplorerDetail with ExplorerTree, use method setExplorerDetail(ExplorerDetail detail) on the ExplorerTree. For more details, see ExplorerTree.

ExplorerDetail fires ExplorerEvents to notify the registered ExplorerListeners when an http event has occured. For more details, see ExplorerListener, ExplorerEvent.

The ExplorerDetail 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.DELETE_EVENT -- generated from the Delete column of the ExplorerDetail

The ExplorerDetail 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.DELETE_EVENT -- generated from the Delete column of the ExplorerDetail

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

See Also:

Explorer, ExplorerTree, ExplorerListener, ExplorerEvent

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ExplorerDetail()
Constructor.

Method Summary

void	checkpointState() Tells the ThinBean to start tracking state changes.
java.lang.String	getCheckpointState() Used to retrieve the state differences from the last time that state was checkpointed.
java.lang.String[]	getColumnNames() Retrieves the names of columns displayed in the table header
java.lang.String[]	getColumns() Retrieves the columns to be displayed in the table Valid types are any attribute names as defined in PSRConstants.Attributes
java.lang.String	getCurrentFolder() Retrieves the current directory for the Explorer.
java.lang.String	getCurrentFolderName() Retrieves the display name for the current folder
java.lang.String	getSearchCriterion() Retrieves the criterion for performing the search
java.lang.String	getSearchString() Retrieves the search string
java.lang.String	getState() Returns a String that represents the changes in the Explorer, since the Explorer was created or since setBaseState() was called.
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
boolean	isBreadCrumbsVisible() Indicates whether the ExplorerDetail displays bread crumbs to the current folder
boolean	isDeleteEnabled() Indicates whether the ExplorerDetail displays the Delete column
boolean	isHeaderVisible() Indicates whether the ExplorerDetail displays a header
void	refreshModel() Refreshes the model to be renderered by this ExplorerDetail
void	setBaseState() Establishes a base state for the Explorer from which state changes that go onto the state string are tracked.
void	setBreadCrumbsVisible(boolean visible) Specifies whether the ExplorerDetail should display bread crumbs to the current folder.
void	setCheckpointState(java.lang.String state) Used to set state differences from the last time that state was checkpointed.
void	setColumnNames(java.lang.String[] columnNames) Specifies the names of columns displayed in the table header
void	setColumns(java.lang.String[] columns) Specifies which columns are displayed in the table Valid types are any attribute names as defined in PSRConstants.Attributes
void	setCurrentFolder(java.lang.String currentFolder) Specifies the current directory for the Explorer.
void	setDeleteEnabled(boolean enabled) Specifies whether the ExplorerDetail displays the Delete column
void	setHeaderVisible(boolean visible) Specifies whether the ExplorerDetail should display a header.
void	setSearchCriterion(java.lang.String searchCriterion) Specifies the criterion for performing the search
void	setSearchString(java.lang.String searchString) Specifies the matching string for performing the search
void	setSelectedPath(java.lang.String path) Specifies the selected path.
void	setState(java.lang.String state) Sets a state string that represents the changes on the Explorer, since the Explorer was created or since setBaseState() was called.

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

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

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

ExplorerDetail

public ExplorerDetail()

Constructor.

Method Detail

setBaseState

public void setBaseState()

Establishes a base state for the Explorer from which state changes that go onto the state string are tracked. This call will effectively clear the thin bean's current state string.

Overrides:

setBaseState in class Explorer

setState

public void setState(java.lang.String state)

Sets a state string that represents the changes on the Explorer, since the Explorer was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.

Overrides:

setState in class Explorer

Parameters:

a - Explorer state

getState

public java.lang.String getState()

Returns a String that represents the changes in the Explorer, since the Explorer was created or since setBaseState() was called. This string placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL. This placing of an application's state onto the URL supports the ability for the application to support re-establishing application state from a bookmark.

Overrides:

getState in class Explorer

Returns:

the Explorer's state

getCheckpointState

public java.lang.String getCheckpointState()

Used to retrieve the state differences from the last time that state was checkpointed.

Overrides:

getCheckpointState in class Explorer

Returns:

the state differences from the last checkpoint

setCheckpointState

public void setCheckpointState(java.lang.String state)
                        throws ThinException

Used to set state differences from the last time that state was checkpointed.

Overrides:

setCheckpointState in class Explorer

Parameters:

state - the state differences from the last checkpoint

Throws:

ThinException - if the state could not be set

checkpointState

public void checkpointState()

Tells the ThinBean to start tracking state changes.

Overrides:

checkpointState in class Explorer

Following copied from interface: oracle.dss.thin.beans.CheckpointState

See Also:

ThinBean.getState(), BIStateManager

setSelectedPath

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

Specifies the selected path.

Overrides:

setSelectedPath in class Explorer

Parameters:

path -

Throws:

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

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

getCurrentFolderName

public java.lang.String getCurrentFolderName()

Retrieves the display name for the current folder

Returns:

the name of the current folder

getCurrentFolder

public java.lang.String getCurrentFolder()

Retrieves the current directory for the Explorer.

Returns:

the name of the current directory as a String

setCurrentFolder

public void setCurrentFolder(java.lang.String currentFolder)
                      throws javax.naming.NamingException

Specifies the current directory for the Explorer.

Parameters:

current - directory String name

Throws:

javax.naming.NamingException - if there was an error searching for contents of the specified folder

isHeaderVisible

public boolean isHeaderVisible()

Indicates whether the ExplorerDetail displays a header

Returns:

true if the header should be displayed

setHeaderVisible

public void setHeaderVisible(boolean visible)

Specifies whether the ExplorerDetail should display a header.

Parameters:

true - if the header should be displayed

isBreadCrumbsVisible

public boolean isBreadCrumbsVisible()

Indicates whether the ExplorerDetail displays bread crumbs to the current folder

Returns:

true if the bread crumbs should be displayed

setBreadCrumbsVisible

public void setBreadCrumbsVisible(boolean visible)

Specifies whether the ExplorerDetail should display bread crumbs to the current folder.

Parameters:

true - if the bread crumbs should be displayed

setColumns

public void setColumns(java.lang.String[] columns)

Specifies which columns are displayed in the table Valid types are any attribute names as defined in PSRConstants.Attributes

Parameters:

the - String array of column attributes, as registered with the BIBeans Repository

getColumns

public java.lang.String[] getColumns()

Retrieves the columns to be displayed in the table Valid types are any attribute names as defined in PSRConstants.Attributes

Returns:

the String array of column attributes, as registered with the BIBeans Repository

setColumnNames

public void setColumnNames(java.lang.String[] columnNames)

Specifies the names of columns displayed in the table header

Parameters:

the - String array of column names to be displayed in the UI

getColumnNames

public java.lang.String[] getColumnNames()

Retrieves the names of columns displayed in the table header

Returns:

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

setSearchCriterion

public void setSearchCriterion(java.lang.String searchCriterion)

Specifies the criterion for performing the search

Parameters:

the - criterion attribute, as defined in PSRConstants.Attributes

getSearchCriterion

public java.lang.String getSearchCriterion()

Retrieves the criterion for performing the search

Returns:

the criterion attribute, as defined in PSRConstants.Attributes

setSearchString

public void setSearchString(java.lang.String searchString)

Specifies the matching string for performing the search

Parameters:

the - search string

getSearchString

public java.lang.String getSearchString()

Retrieves the search string

Returns:

the search string

isDeleteEnabled

public boolean isDeleteEnabled()

Indicates whether the ExplorerDetail displays the Delete column

Returns:

true if the Delete column should is enabled

setDeleteEnabled

public void setDeleteEnabled(boolean enabled)

Specifies whether the ExplorerDetail displays the Delete column

Parameters:

enabled - true if the Delete column should be enabled

refreshModel

public void refreshModel()
                  throws javax.naming.NamingException

Refreshes the model to be renderered by this ExplorerDetail

Overrides:

refreshModel in class Explorer

Throws:

javax.naming.NamingException - if the model could not be refreshed