Important: In the current release of BI Beans, use the Explorer Detail bean instead of the Explorer Search bean because the Explorer Detail bean now has both browse and search capability.
The Explorer Search bean is a BI Beans thin bean, for use in an HTML-client application. It allows users to search for objects in the BI Beans Catalog.
You can use the Explorer Search bean with the Explorer Tree bean, or you can display it separately. The Explorer Search bean searches the BI Beans Catalog for objects that meet the search criteria.
The ThinBeanUI
implementation of the Explorer Search bean is the
oracle.dss.thin.beans.persistence.ExplorerSearch
class. The UINode
for the Explorer Search bean is oracle.dss.thin.beans.persistence.ExplorerSearchBean
.
Your servlet must associate
the ExplorerSearch
object with the ExplorerSearchBean
object.
The JSP tag for this bean is the SearchTool
tag. In the UIX Language, there are no elements that correspond to the Explorer
Search bean. In the UIX language, the only similar UINode
is the
explorerQuickSearch element.
You should store the ExplorerSearch
in the HTTP session.
The Explorer Search keeps track of the selected path, the object type, the search string and the search criterion.
When you use the Explorer Search bean by itself, you must specify a folder whose contents the Explorer Search should search. Do do this, you call the setBIContext
method of the ExplorerSearch
object. If your HTML-client application uses OLAP data, then set an MDFolder
as the BIContext
. If your application does not use OLAP data, then set a PersistenceManager
as the BIContext
. The BIContext
that you set should also be stored in the browser session.
When you use the Explorer Search bean with the Explorer Tree, must connect the two beans so that the search event from the Explorer Tree can be handled by the Explorer Search.
When you use the Explorer Search
bean, you must implement an ExplorerListener
to listen for Delete events and for Select object and Select folder events.
The listener must actually delete the object. It must also respond to Select
object and Select folder events, by opening the object, for example.
The ExplorerSearch
sends an ExplorerEvent
to all
registered listeners whenever the user chooses to delete or to select an object.
The listener that you register should call the getAction
method
of the ExplorerEvent
to find out which event to handle. If getAction
returns BIConstants.DELETE_EVENT
, then the listener should delete
the object from the BI Beans Catalog. If getAction
returns BIConstants.SELECT_OBJECT_EVENT
,
then the listener should respond to the selection. If getAction
returns BIConstants.SELECT_FOLDER_EVENT
, then the listener should
respond to the selection.To open the object, you retrieve it from the Catalog.
You might, alternately, export, print, or manipulate the object in some way.
The getObjectName
method provides the path and name of the object, and the getObjectType
method provides the type of object that should be returned from the lookup
method of the BIContext
.
The ExplorerSearch
generates the following events, which are defined
in the oracle.dss.thin.BIConstants
interface.
SEARCH_EVENT
-- This event is generated when a user clicks
the Go button. It is handled by the ExplorerSearch
.
SELECT_FOLDER_EVENT
-- This event is generated when a user clicks a folder. It is handled by the ExplorerSearch
.
SELECT_OBJECT_EVENT
-- This event is generated when a user clicks an object other than a folder. It is handled by the ExplorerSearch
.
GOTO_ROW_EVENT
-- This event is generated when a user navigates in the ExplorerSearch
. This event has the VALUE
parameter, which specifies the desired first row.
FILTER_EVENT
-- This event is generated when a user selects a type of object to view. It is handled by the ExplorerSearch
. This event has the FILTER_TYPE
parameter, which identifies the type of objects to display.
DELETE_EVENT
-- This event is generated from the Delete column. The ExplorerSearch
passes this event to listeners.
The ExplorerDetail
handles the following events:
SEARCH_EVENT
-- The ExplorerSearch
handles this
event by searching for and displaying objects that meet the search criteria.
SELECT_FOLDER_EVENT
-- The ExplorerSearch
handles this event by making the selected folder current. It also fires an ExplorerEvent
to registered listeners.
SELECT_OBJECT_EVENT
-- The ExplorerSearch
handles this event by showing the object as selected. It also fires an ExplorerEvent
to registered listeners.
GOTO_ROW_EVENT
-- The ExplorerSearch
handles this event by making the specified row the first row that appears. This event has the VALUE
parameter, which specifies the desired first row.
FILTER_EVENT
-- The ExplorerSearch
handles this event by filtering its contents.
DELETE_EVENT
-- The ExplorerSearch
passes this event to listeners. The listener should delete the selected object.