com.portal.app.comp

Class PIASearchPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.pfc.ui.ImagePanel

com.portal.bas.comp.PIACustomizablePanel

com.portal.app.comp.PIASearchPanel

All Implemented Interfaces:

PSearchProducer, PAppComponent, PClientComponent, PCollectDataListener, PComponent, PComponentAttribute, PViewDataChangeListener, ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

PAccountsEntryPanel, PDeviceSearchEntryPanelBase, PNumberEntryPanel, PSettopEntryPanel, PSIMEntryPanel

public class PIASearchPanel
extends PIACustomizablePanel
implements PSearchProducer

The base search panel class - contains the real logic for searching This panel supports remote listening, which means its possible for the search results to be sent to a search results component's controller directly on the server side. Otherwise, the search results will come back to the client side and be sent to interested parties. Those parties will most likely need to then send it back to their controllers for processing. All those round trips slow things down.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allBrandsSelected
protected boolean	allowBrandActs
protected PBrandTree	brandTree
protected boolean	filterNonBrandHostAccounts
protected boolean	forceStop
protected boolean	isBranded
protected String	mClass
protected int	resultsLimit
protected PScopeEntryPoint	selectedBrand
protected Object	stopLock

Fields inherited from class com.portal.bas.comp.PIACustomizablePanel

isTracking, mIAList, mImpl, unregList

Fields inherited from class com.portal.pfc.ui.ImagePanel

IMAGE_CENTERED, IMAGE_SCALE_TO_HEIGHT, IMAGE_SCALE_TO_WIDTH, IMAGE_SCALED, IMAGE_TILED, mImageIcon, mScaledImage

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
PIASearchPanel()

Method Summary

Modifier and Type	Method and Description
void	addSearchInfoListener(PSearchInfoListener l) Adds a listener for the results of this search
void	addSearchResultsListener(PSearchResultsListener l) Connects the search panel to a class that is interested in the results of the search.
void	clear() A convenience method that clears all Portal-aware descendants of this panel.
void	collectData(PCollectDataEvent event) Override collectData(), turning it into a no-op.
protected void	collectDataFromPanelWidgets(Component c, Vector models, Vector assocClasses)
void	filterNonBrandHostAccounts(boolean b)
protected void	fireColumns(String[] cols) Sends an event to the search listeners
protected void	fireProgress(int progress) Sends out a progress report, typically to the main application
protected void	fireSearchResults(PModelHandle[] results) Send an event containing the results of the search
String	getControllerClassName() Retrieves the class name of this component's controller, in this case, null.
protected String[]	getDesiredResults() Retrieves the column display field descriptions.
String	getStorableClass() Get the storable class searched for by this component
Vector	getTools() Returns the commands available on this panel.
boolean	hasBrandHost()
boolean	isLoginRoot()
void	removeSearchInfoListener(PSearchInfoListener l) Removes a listener for the results of this search
void	removeSearchResultsListener(PSearchResultsListener l) Disconnects the search panel from a class that is interested in the results of the search.
void	search() Starts the search process
void	setAllBrandsStatus(boolean status) Assigns all brands selected status
void	setBrandAccountsDisplayed(boolean b)
void	setBrandStatus(boolean status) Assigns status if the system is branded or not.
void	setBrandTree(PBrandTree bTree) Provides the brand tree object
void	setResultsDisplayLimit(int i)
void	setSelectedBrand(PScopeEntryPoint newBrand) Assigns the selected brand
void	setSingleDBSearchEnabled(boolean flag) Enables the single DB Search
void	setSingleDBSearchID(long id)
void	setSingleDBSearchID(PModelHandle acct) Sets the scope for the single db search to be the database associated with the given account.
void	setSpreadSheet(PIASpecSpreadSheet s) Implements the abstract method from the PSearchProducer interface.
void	setStorableClass(String sclass) Set the class used by the component for searches.
void	startSearch() Called to really start the search process in motion.
void	stop() Stops the search process
void	stopSearch()
void	viewDataChange(PViewDataChangeEvent event) Implements the PViewDataChangeListener interface

Methods inherited from class com.portal.bas.comp.PIACustomizablePanel

componentAdded, componentRemoved, containsError, getBackgroundImageSource, getBundle, getModelHandle, getRemoteComponent, getResourceName, isClean, isCurrencyDisplay, isDirty, isError, isInputTracking, isLight, isRequired, processError, resetToDefault, revertToPrimary, setBackgroundImageMode, setBackgroundImageSource, setClean, setCurrencyDisplay, setDefault, setError, setInputTracking, setModelHandle, setRequired, setResourceName, togglePrimaryToSecondary, unregister

Methods inherited from class com.portal.pfc.ui.ImagePanel

getBackgroundImageIcon, getBackgroundImageMode, imageUpdate, paintComponent, setBackgroundImageIcon

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mClass

protected String mClass

forceStop

protected boolean forceStop

stopLock

protected Object stopLock

isBranded

protected boolean isBranded

selectedBrand

protected PScopeEntryPoint selectedBrand

allBrandsSelected

protected boolean allBrandsSelected

brandTree

protected PBrandTree brandTree

allowBrandActs

protected boolean allowBrandActs

filterNonBrandHostAccounts

protected boolean filterNonBrandHostAccounts

resultsLimit

protected int resultsLimit

Constructor Detail

PIASearchPanel

public PIASearchPanel()

Method Detail

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Description copied from class: PIACustomizablePanel

Retrieves the class name of this component's controller, in this case, null.

Specified by:

getControllerClassName in interface PComponent

Overrides:

getControllerClassName in class PIACustomizablePanel

Returns:

A null String.

Throws:

RemoteException - thrown for errors

setStorableClass

public void setStorableClass(String sclass)
                      throws RemoteException

Set the class used by the component for searches. The default is "/account".

Parameters:

class - The storable class name to search for

Throws:

RemoteException

getStorableClass

public String getStorableClass()
                        throws RemoteException

Get the storable class searched for by this component

Returns:

The storable class used

Throws:

RemoteException

addSearchResultsListener

public void addSearchResultsListener(PSearchResultsListener l)

Connects the search panel to a class that is interested in the results of the search.

Parameters:

l - the interested class

removeSearchResultsListener

public void removeSearchResultsListener(PSearchResultsListener l)

Disconnects the search panel from a class that is interested in the results of the search.

Parameters:

l - the disinterested class

addSearchInfoListener

public void addSearchInfoListener(PSearchInfoListener l)

Adds a listener for the results of this search

Specified by:

addSearchInfoListener in interface PSearchProducer

Parameters:

l - the listener

removeSearchInfoListener

public void removeSearchInfoListener(PSearchInfoListener l)

Removes a listener for the results of this search

Specified by:

removeSearchInfoListener in interface PSearchProducer

Parameters:

l - the listener

collectData

public void collectData(PCollectDataEvent event)

Override collectData(), turning it into a no-op. This panel uses an internal mechanism for collecting search criteria which is similar, but differnt, than the regular collectData() methodology. At the same time, if/when this panel is embedded amongst regular display-type panels it shouldn't really do anything when collectData() is called.

Specified by:

collectData in interface PCollectDataListener

Overrides:

collectData in class PIACustomizablePanel

Parameters:

event - the PCollectDataEvent event

viewDataChange

public void viewDataChange(PViewDataChangeEvent event)
                    throws RemoteException

Implements the PViewDataChangeListener interface

Specified by:

viewDataChange in interface PViewDataChangeListener

Overrides:

viewDataChange in class PIACustomizablePanel

Parameters:

event - the data change event

Throws:

RemoteException - e

stopSearch

public void stopSearch()

hasBrandHost

public boolean hasBrandHost()

startSearch

public void startSearch()

Called to really start the search process in motion. Note that this method will issue PCollectDataEvents to the PIA components that exist in a subclass. It behaves slightly differently than the traditional collectData() process in the sense that each component is issued a separate PModelHandle. This is because the controller needs to have an array of PModelHandles so it can build a complex search. What this means is that any subclass cannot override collectData() and expect it to get called. Only individual components will have their collectData() methods called.

getTools

public Vector getTools()

Returns the commands available on this panel. Currently these are start/end search, and a command to clear the fields in the panel

Specified by:

getTools in interface PClientComponent

Overrides:

getTools in class PIACustomizablePanel

Returns:

A Vector that contains Action objects.

fireSearchResults

protected void fireSearchResults(PModelHandle[] results)

Send an event containing the results of the search

Parameters:

results - the search results array

fireProgress

protected void fireProgress(int progress)

Sends out a progress report, typically to the main application

Parameters:

the - progress status - typically a type in PSearchResultsEvent

fireColumns

protected void fireColumns(String[] cols)

Sends an event to the search listeners

Parameters:

cols -

getDesiredResults

protected String[] getDesiredResults()

Retrieves the column display field descriptions. This allows the search component to retrieve only those fields directly requested by the component that will display the search results.

collectDataFromPanelWidgets

protected void collectDataFromPanelWidgets(Component c,
                                           Vector models,
                                           Vector assocClasses)

setSingleDBSearchEnabled

public void setSingleDBSearchEnabled(boolean flag)

Description copied from interface: PSearchProducer

Enables the single DB Search

Specified by:

setSingleDBSearchEnabled in interface PSearchProducer

setSingleDBSearchID

public void setSingleDBSearchID(long id)

Specified by:

setSingleDBSearchID in interface PSearchProducer

setSingleDBSearchID

public void setSingleDBSearchID(PModelHandle acct)

Sets the scope for the single db search to be the database associated with the given account.

Specified by:

setSingleDBSearchID in interface PSearchProducer

Parameters:

acct - the account the contains the database to use

stop

public void stop()

Description copied from interface: PSearchProducer

Stops the search process

Specified by:

stop in interface PSearchProducer

search

public void search()

Description copied from interface: PSearchProducer

Starts the search process

Specified by:

search in interface PSearchProducer

clear

public void clear()

Description copied from class: PIACustomizablePanel

A convenience method that clears all Portal-aware descendants of this panel.

Specified by:

clear in interface PSearchProducer

Specified by:

clear in interface PComponentAttribute

Overrides:

clear in class PIACustomizablePanel

setSpreadSheet

public void setSpreadSheet(PIASpecSpreadSheet s)

Implements the abstract method from the PSearchProducer interface. Registers the results table with the producer

Specified by:

setSpreadSheet in interface PSearchProducer

setBrandStatus

public void setBrandStatus(boolean status)

Assigns status if the system is branded or not.

Specified by:

setBrandStatus in interface PSearchProducer

setSelectedBrand

public void setSelectedBrand(PScopeEntryPoint newBrand)

Assigns the selected brand

Specified by:

setSelectedBrand in interface PSearchProducer

setAllBrandsStatus

public void setAllBrandsStatus(boolean status)

Description copied from interface: PSearchProducer

Assigns all brands selected status

Specified by:

setAllBrandsStatus in interface PSearchProducer

setBrandTree

public void setBrandTree(PBrandTree bTree)

Description copied from interface: PSearchProducer

Provides the brand tree object

Specified by:

setBrandTree in interface PSearchProducer

setBrandAccountsDisplayed

public void setBrandAccountsDisplayed(boolean b)

filterNonBrandHostAccounts

public void filterNonBrandHostAccounts(boolean b)

isLoginRoot

public boolean isLoginRoot()

setResultsDisplayLimit

public void setResultsDisplayLimit(int i)