oracle.dss.thin.beans.persistence
Class Explorer

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

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

Direct Known Subclasses:

ExplorerDetail, ExplorerTree

public abstract class Explorer

extends BaseThinBeanUI

The base Explorer thin bean. Explorer thin beans are used to display, browse and search through the contents of the BI Beans Catalog. This class defines methods and fields that are common to all the Explorer thin beans.

Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.

Listening to the Explorer events

The application developer can add an ExplorerListener to the Explorer subclass. When the Explorer bean handles an event, the ExplorerEvent will be fired to all the registered ExplorerListener objects. For more details, see ExplorerListener, ExplorerEvent.

Explorer State Management

The Explorer beans support state for their currently selected path, and the currently displayed object type.

The Explorer 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

The Explorer 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

For more information about using the Explorer Beans, see the BI Beans Help system.

See Also:

ExplorerTree, ExplorerDetail, ExplorerSearch, ExplorerListener, ExplorerEvent

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

Explorer()
Constructor.

Method Summary

void	addExplorerListener(ExplorerListener l) Registers a listener for the ExplorerEvents, which are fired when the current directory is changed or a new item is selected.
void	checkpointState() Tells the ThinBean to start tracking state changes.
BIContext	getBIContext() Retrieves the BIContext for the Explorer.
java.lang.String	getCheckpointState() Used to retrieve the state differences from the last time that state was checkpointed.
java.lang.String	getLastSelectedPath() Retrieves the last selected path.
java.lang.String	getObjectType() Retrieves the type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If null, all types of objects are displayed
java.lang.String[]	getObjectTypeNames() Retrieves the names of types displayed in the object type filter
java.lang.String[]	getObjectTypes() Retrieves what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository
java.lang.String	getRootName() Retrieves the root directory name for the Explorer.
int	getRowBlockSize() Retrieves the block size for the Explorer.
SaveAs	getSaveAs() Retrieves the SaveAs dialog used with the ExplorerTree or the ExplorerDetail.
BISearchControls	getSearchControls() Retrieves the SearchControls used for searching the current directory
javax.naming.directory.Attributes	getSearchFilters() Returns the search filter used when seraching the contents of the current directory
int	getSearchFoldersLimit() Retrieves the number of folders in the current folder which will be searched to determine whether they contain sub folders.
java.lang.String	getSelectedObjectType() Retrieves the type of the currently selected object in the Explorer
java.lang.String	getSelectedPath() Retrieves the selected path
int	getStartRow() Retrieves the start row for the Explorer.
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	isFoldersVisible() Indicates whether the Explorer displays folders
boolean	isObjectFilterVisible() Indicates whether the Explorer displays object filter control
boolean	isSearchVisible() Indicates whether the Explorer displays a search fields
void	refreshModel() Refreshes the model to be renderered by the Tree or TableBean UIX Components
void	removeExplorerListener(ExplorerListener l) Unregisters a listener for the ExplorerEvents, which are fired when the current directory is changed or a new item is selected.
void	setBaseState() Establishes a base state for the Explorer from which state changes that go onto the state string are tracked.
void	setBIContext(BIContext biContext) Specifies the BIContext for the Explorer.
void	setCheckpointState(java.lang.String state) Used to set state differences from the last time that state was checkpointed.
void	setFoldersVisible(boolean visible) Specifies whether the Explorer should display folders.
void	setObjectFilterVisible(boolean visible) Specifies whether the Explorer displays object filter control
void	setObjectType(java.lang.String objectType) Specifies what type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If set to null, all types of objects are displayed
void	setObjectTypeNames(java.lang.String[] objectTypeNames) Specifies the names of types displayed in the object type filter
void	setObjectTypes(java.lang.String[] objectTypes) Specifies what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository
void	setRootName(java.lang.String rootName) Specifies the root directory name for the Explorer.
void	setRowBlockSize(int blockSize) Specifies the block size for the Explorer.
void	setSaveAs(SaveAs saveAs) Sets the SaveAs dialog on the Explorer In the ExplorerTree, the SaveAs dialog gets updated with the information about the currently selected object in the tree.
void	setSearchControls(BISearchControls controls) Sets the SearchControls used used for searching the current directory
void	setSearchFilters(javax.naming.directory.Attributes matchingAttrs) Sets the search filter to be filter the results of searching the current directory
void	setSearchFoldersLimit(int limit) Sets the number of folders in the current folder which will be searched to determine whether they contain sub folders.
void	setSearchVisible(boolean visible) Specifies whether the Explorer should display the search fields.
void	setSelectedPath(java.lang.String path) Specifies the selected path.
void	setStartRow(int row) Specifies the start row for the Explorer.
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.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

Explorer

public Explorer()

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. Explorer beans track changes to the selected path, and displayed object type

Overrides:

setBaseState in class BaseThinBeanUI

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 BaseThinBeanUI

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 BaseThinBeanUI

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 BaseThinBeanUI

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 BaseThinBeanUI

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 BaseThinBeanUI

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

See Also:

ThinBean.getState(), BIStateManager

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.

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

getBIContext

public BIContext getBIContext()

Retrieves the BIContext for the Explorer.

Returns:

an implementation of the oracle.dss.bicontext.BIContext interface

setBIContext

public void setBIContext(BIContext biContext)

Specifies the BIContext for the Explorer.

Parameters:

biContext - an implementation of the oracle.dss.bicontext.BIContext interface

getRootName

public java.lang.String getRootName()

Retrieves the root directory name for the Explorer.

Returns:

the name of the root directory as a String

setRootName

public void setRootName(java.lang.String rootName)

Specifies the root directory name for the Explorer.

Parameters:

root - directory String name

getStartRow

public int getStartRow()

Retrieves the start row for the Explorer.

Returns:

the index of the row from which the current folder contents are going to be displayed

setStartRow

public void setStartRow(int row)

Specifies the start row for the Explorer.

Parameters:

the - index of the row from which the current folder contents are going to be displayed

getRowBlockSize

public int getRowBlockSize()

Retrieves the block size for the Explorer.

Returns:

the number of rows to be displayed when browsing the repository folders

setRowBlockSize

public void setRowBlockSize(int blockSize)

Specifies the block size for the Explorer.

Parameters:

the - number of rows to be displayed when browsing the repository

isObjectFilterVisible

public boolean isObjectFilterVisible()

Indicates whether the Explorer displays object filter control

Returns:

true if the object filter should be displayed

setObjectFilterVisible

public void setObjectFilterVisible(boolean visible)

Specifies whether the Explorer displays object filter control

Parameters:

true - if the object filter should be displayed

isSearchVisible

public boolean isSearchVisible()

Indicates whether the Explorer displays a search fields

Returns:

true if the search fields should be displayed

setSearchVisible

public void setSearchVisible(boolean visible)

Specifies whether the Explorer should display the search fields.

Parameters:

true - if the search fields should be displayed

getSearchFoldersLimit

public int getSearchFoldersLimit()

Retrieves the number of folders in the current folder which will be searched to determine whether they contain sub folders. The default value is 0, which means that all folders in the current folder will be searched. This property should be used to tune performance in cases where the number of sub folders is too large.

Returns:

the maximum number of folders which will be searched to determine whether they have sub folders

setSearchFoldersLimit

public void setSearchFoldersLimit(int limit)

Sets the number of folders in the current folder which will be searched to determine whether they contain sub folders. The default value is 0, which means that all folders in the current folder will be searched. This property should be used to tune performance in cases where the number of sub folders is too large.

Parameters:

the - maximum number of folders which will be searched to determine whether they have sub folders

refreshModel

public void refreshModel()
                  throws javax.naming.NamingException

Refreshes the model to be renderered by the Tree or TableBean UIX Components

Throws:

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

getSelectedObjectType

public java.lang.String getSelectedObjectType()

Retrieves the type of the currently selected object in the Explorer

Returns:

the name of the type, as registered with the BIBeans Repository

getSelectedPath

public java.lang.String getSelectedPath()

Retrieves the selected path

Returns:

selected path

setSelectedPath

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

Specifies the selected path.

Parameters:

path -

Throws:

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

getSearchFilters

public javax.naming.directory.Attributes getSearchFilters()

Returns the search filter used when seraching the contents of the current directory

Returns:

the search filter

setSearchFilters

public void setSearchFilters(javax.naming.directory.Attributes matchingAttrs)

Sets the search filter to be filter the results of searching the current directory

Parameters:

the - search filter used to populate the model

getSearchControls

public BISearchControls getSearchControls()

Retrieves the SearchControls used for searching the current directory

Returns:

the SearchControls used for searching the current directory

setSearchControls

public void setSearchControls(BISearchControls controls)

Sets the SearchControls used used for searching the current directory

Parameters:

the - SearchControls used for searching the current directory

setObjectType

public void setObjectType(java.lang.String objectType)
                   throws javax.naming.NamingException

Specifies what type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If set to null, all types of objects are displayed

Parameters:

the - name of the type, as registered with the BIBeans Repository

getLastSelectedPath

public java.lang.String getLastSelectedPath()

Retrieves the last selected path.

Returns:

last selected path

getObjectType

public java.lang.String getObjectType()

Retrieves the type of objects are displayed in the Explorer Valid types are all types registered with the BIBeans Repository If null, all types of objects are displayed

Returns:

the name of the type, as registered with the BIBeans Repository

setObjectTypes

public void setObjectTypes(java.lang.String[] objectTypes)

Specifies what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository

Parameters:

the - String array of type names, as registered with the BIBeans Repository

getObjectTypes

public java.lang.String[] getObjectTypes()

Retrieves what types of objects are displayed in the object type filter Valid types are all types registered with the BIBeans Repository

Returns:

the String array of type names, as registered with the BIBeans Repository

setObjectTypeNames

public void setObjectTypeNames(java.lang.String[] objectTypeNames)

Specifies the names of types displayed in the object type filter

Parameters:

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

getObjectTypeNames

public java.lang.String[] getObjectTypeNames()

Retrieves the names of types displayed in the object type filter

Returns:

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

isFoldersVisible

public boolean isFoldersVisible()

Indicates whether the Explorer displays folders

Returns:

true if the folders should be displayed

setFoldersVisible

public void setFoldersVisible(boolean visible)

Specifies whether the Explorer should display folders.

Parameters:

true - if the folders should be displayed

addExplorerListener

public void addExplorerListener(ExplorerListener l)

Registers a listener for the ExplorerEvents, which are fired when the current directory is changed or a new item is selected.

Parameters:

l - The listener to add.

See Also:

ExplorerEvent

removeExplorerListener

public void removeExplorerListener(ExplorerListener l)

Unregisters a listener for the ExplorerEvents, which are fired when the current directory is changed or a new item is selected.

Parameters:

l - The listener to remove.

See Also:

ExplorerEvent

setSaveAs

public void setSaveAs(SaveAs saveAs)

Sets the SaveAs dialog on the Explorer In the ExplorerTree, the SaveAs dialog gets updated with the information about the currently selected object in the tree. In the ExplorerDetail, the SaveAs dialog gets updated with the information about the currently selected folder.

Parameters:

saveAs - the SaveAs thin bean

getSaveAs

public SaveAs getSaveAs()

Retrieves the SaveAs dialog used with the ExplorerTree or the ExplorerDetail. In the ExplorerTree, the SaveAs dialog gets updated with the information about the currently selected object in the tree. In the ExplorerDetail, the SaveAs dialog gets updated with the information about the currently selected folder.

Returns:

the SaveAs thin bean