Package com.portal.search
Class SearchController
java.lang.Object
com.portal.bas.PControllerImpl
com.portal.bas.PComponentControllerImpl
com.portal.bas.comp.PIAPanelController
com.portal.search.SearchController
- All Implemented Interfaces:
PComponentController
,PControllerBean
,PropertyChangeListener
,Serializable
,Remote
,Unreferenced
,EventListener
A Template Based search front-end for Portal.
This is a front end for the Portal search engine that trys to
hide the details of storable classes from the user. Instead, users
supply data in form-lets oriented to specific sources they might wish
to search from, and designed to search for specific storable classes
determined by their creator. These form-lets are created by
interpreting a set of properties passed to the front-end. These
properties also contain the information needed to form the proper
search strings for Portal. Search results are passed back to the
caller via the search event/listener mechanism, in batches.
- Version:
- %version: 19 % %date_modified: Tue May 28 10:23:18 2002 %
- Author:
- Monica Gaines
- See Also:
-
Field Summary
Fields inherited from class com.portal.bas.PControllerImpl
mFList, mRemoteListeners, UPDATE_CLIENT, UPDATE_MODEL_CHANGE, UPDATE_NEW_MODEL, UPDATE_PROPERTY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactionPerformed
(ActionEvent event) Initiates a search using data provided by the client through the event or obtains data neccessay for displaying a generic search.protected void
protected void
fireLabels
(ResultData[] res) protected void
fireProgress
(int amt) Sends a DataChangeEvent indicating the amount of progress of the search.protected void
fireResults
(PModelHandle[] res) protected void
fireSearchEvent
(SearchEvent event) String[]
Get the 'searchData' property array.protected void
Called bydistributeEventToListeners
to pass an event to specific listener methods.void
setResultFields
(FList flds) Set the 'resultFields' property, which is used in the search.void
setSearchData
(String[] data) Set the 'searchData' property array.Methods inherited from class com.portal.bas.comp.PIAPanelController
getRemoteListenerHandle, getSelectionDataFor, propertyChange, update
Methods inherited from class com.portal.bas.PComponentControllerImpl
fireDataChangeEvent, fireDataChangeEvent, fireDataChangeEvent, fireDataChangeEvent, getConnection, getProperty, getView, setDisplayComponent, setProperty, update
Methods inherited from class com.portal.bas.PControllerImpl
addRemoteListener, closeSecContext, createClientException, distributeEventToListeners, fireModelChangeEvent, getAppController, getArrayRange, getContext, getField, getField, getField, getFieldWithRestriction, getFieldWithRestriction, getFieldWithRestriction, getModel, getSecContext, isLight, register, releaseContext, releaseRemoteListener, removeRemoteListener, setField, setField, setModel, unreferenced
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.portal.bas.PControllerBean
addRemoteListener, getArrayRange, getModel, isLight, register, releaseRemoteListener, removeRemoteListener, setModel
-
Constructor Details
-
SearchController
Creates an instance of the search controller.- Throws:
RemoteException
-
-
Method Details
-
getSearchData
Get the 'searchData' property array. This is a collection of the data set by the user for each template.- Returns:
- A string array with each string containing the information for a single template.
-
setSearchData
Set the 'searchData' property array. This will be used to pre-load templates with the given information.- Parameters:
data
- A String array containing data for each template.
-
setResultFields
Set the 'resultFields' property, which is used in the search.- Parameters:
flds
- the new list of fields expected for each found result
-
actionPerformed
Initiates a search using data provided by the client through the event or obtains data neccessay for displaying a generic search.- Specified by:
actionPerformed
in interfacePComponentController
- Overrides:
actionPerformed
in classPIAPanelController
- Parameters:
event
- issued by the client to begin the search- Returns:
- An object may be returned as a result of action processing.
- Throws:
RemoteException
- thrown for errors
-
fireProgress
Sends a DataChangeEvent indicating the amount of progress of the search.- Parameters:
amt
- the number of items found in search- Throws:
RemoteException
-
fireResults
- Throws:
RemoteException
-
fireLabels
- Throws:
RemoteException
-
fireSearchEvent
-
fireError
- Throws:
RemoteException
-
handleDistributeToListener
Description copied from class:PControllerImpl
Called bydistributeEventToListeners
to pass an event to specific listener methods. When overriding this method, be sure to pass calls for unknown listener classes to the parent controller to handle other types of event objects.- Overrides:
handleDistributeToListener
in classPControllerImpl
- Parameters:
l
- the listener to call a method forevt
- the event object to distribute
-