oracle.dss.thin.beans.dataView
Class FindMember

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.ThinBeanDialog
              |
              +--oracle.dss.thin.beans.dataView.FindMember

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class FindMember

extends ThinBeanDialog

The ThinBeanUI for the Find Member dialog. The Find Member dialog presents page dimension members for a view. Users can search the dimension members to assign for a page dimension. The Find Member dialog is generally used with a thin presentation bean, to allow users to navigate large sets of page dimension members. The FindMember generates the following events:

• BIConstants.PAGE_EVENT -- This event is generated when a user clicks Select. The view that you pass to the setView method handles this event. You do not need to set an event target.
• BIConstants.SEARCH_EVENT -- This event is generated when a user clicks the Go button to search for a dimension member. This FindMember handles the event as well.
• BIConstants.GOTO_ROW_EVENT -- This event is generated when a user clicks a dimension member. The FindMember handles the event as well.

The FindMember handles the following events:

• BIConstants.INIT_FIND_MEMBER_EVENT -- This FindMember handles this event by getting the dimension members to display and by clearing the search string. Then it passes an InitEvent to any registered ThinBeanDialogListener objects. This event is generated by the thin presentation bean when a user clicks more... in the paging control.
• BIConstants.SEARCH_EVENT -- This FindMember handles this event by getting the members that match the search string.
• BIConstants.GOTO_ROW_EVENT -- This FindMember handles this event by making the specified row the first row.

For more information about using the Find Member dialog, see the "Find Member Dialog" topic in the BI Beans Help system.

See Also:

ThinDataviewCommon

Fields inherited from class oracle.dss.thin.beans.ThinBeanDialog

ALL_PAGES, CURRENT_PAGE, SELECTED_PAGES

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

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

FindMember()
Constructor that does not specify an associated thin presentation bean.

FindMember(java.lang.String thinBeanName, ThinDataviewCommon view)
Constructor that specifies the thin presentation bean for this FindMember.

Method Summary

int	getEdge() Retrieves the edge that contains the dimension to display in the Find Member dialog.
int	getLayer() Retrieves the layer to display in the Find Member dialog.
int	getRowBlockSize() Retrieves the number of dimension members to display at one time in the Find Member dialog.
java.lang.String	getSearchString() Retrieves the string to search for.
int	getStartRow() Retrieves the first member to display in the Find Member dialog.
ThinDataviewCommon	getView() Retrieves the thin presentation bean that uses this FindMember.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
boolean	isPagingControlPopup() Indicates whether this tool is used as a popup window for the paging control of a thin presentation bean.
void	setEdge(int edge) Specifies the edge that contains the dimension to display in the Find Member dialog.
void	setLayer(int layer) Specifies the layer to display in the Find Member dialog.
void	setPagingControlPopup(boolean isPopup) Specifies whether the Find Member appears as a popup window for the paging control of the thin presentation bean.
void	setRowBlockSize(int blockSize) Specifies the number of dimension members to display at one time in the Find Member dialog.
void	setSearchString(java.lang.String searchString) Specifies the string to search for, in a search operation.
void	setStartRow(int row) Specifies the first member to display in the Find Member dialog.
void	setThinBeanName(java.lang.String thinBeanName) A unique name for this FindMember.
void	setView(ThinDataviewCommon view) Specifies the thin presentation bean that uses this FindMember dialog.

Methods inherited from class oracle.dss.thin.beans.ThinBeanDialog

addThinBeanDialogListener, removeThinBeanDialogListener

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FindMember

public FindMember()

Constructor that does not specify an associated thin presentation bean.

FindMember

public FindMember(java.lang.String thinBeanName,
ThinDataviewCommon view)

Constructor that specifies the thin presentation bean for this FindMember. Use this constructor if this FindMember will serve only one thin presentation bean. When you use this constructor, the FindMember automatically sets itself as an EventTarget for the BIConstants.INIT_FIND_MEMBER_EVENT, and it sets the thin presentation bean as the an EventTarget for its BIConstants.PAGE_EVENT.

Parameters:

thinBeanName - The name of this FindMember thin bean.

view - The thin presentation bean whose paging control this FindMember supports.

Method Detail

setView

public void setView(ThinDataviewCommon view)

Specifies the thin presentation bean that uses this FindMember dialog.

Parameters:

view - The view whose paging control uses this FindMember.

getView

public ThinDataviewCommon getView()

Retrieves the thin presentation bean that uses this FindMember.

Returns:

The thin presentation bean whose paging control uses this FindMember.

setThinBeanName

public void setThinBeanName(java.lang.String thinBeanName)

A unique name for this FindMember. You may have multiple thin beans in an application at the same time. The source query parameter should have a unique name, so that the event can be correctly routed.

Overrides:

setThinBeanName in class BaseThinBeanUI

Parameters:

thinBeanName - The unique name for this FindMember.

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Overrides:

handleEvent in class ThinBeanDialog

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

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

getLayer

public int getLayer()

Retrieves the layer to display in the Find Member dialog.

Returns:

The layer index that identifies the dimension to display.

setLayer

public void setLayer(int layer)

Specifies the layer to display in the Find Member dialog.

Parameters:

layer - The layer index in the page edge that identifies the dimension to display in the Find Member dialog.

getEdge

public int getEdge()

Retrieves the edge that contains the dimension to display in the Find Member dialog.

Returns:

The edge index. Valid values appear in the See Also section, but this should be DataDirector.PAGE_EDGE.

See Also:

DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.COLUMN_EDGE

setEdge

public void setEdge(int edge)

Specifies the edge that contains the dimension to display in the Find Member dialog.

Parameters:

edge - The edge index. Valid values appear in the See Also section, but the Find Member dialog is designed to work with the page edge. The default value is DataDirector.PAGE_EDGE.

See Also:

DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.COLUMN_EDGE

getStartRow

public int getStartRow()

Retrieves the first member to display in the Find Member dialog.

Returns:

The index of the first dimension member that appears in the Find Member dialog.

setStartRow

public void setStartRow(int row)

Specifies the first member to display in the Find Member dialog.

Parameters:

row - The index of the first dimension member to display in the Find Member dialog.

getRowBlockSize

public int getRowBlockSize()

Retrieves the number of dimension members to display at one time in the Find Member dialog.

Returns:

The number of rows to display in the Find Member dialog.

setRowBlockSize

public void setRowBlockSize(int blockSize)

Specifies the number of dimension members to display at one time in the Find Member dialog.

Parameters:

blockSize - The number of rows to display in the Find Member dialog. The default is 25.

setSearchString

public void setSearchString(java.lang.String searchString)

Specifies the string to search for, in a search operation.

Parameters:

searchString - The string to search for.

getSearchString

public java.lang.String getSearchString()

Retrieves the string to search for.

Returns:

The string to search for in a search operation.

setPagingControlPopup

public void setPagingControlPopup(boolean isPopup)

Specifies whether the Find Member appears as a popup window for the paging control of the thin presentation bean. The default value is true.

Parameters:

isPopup - true to display the Find Member dialog as a popup, false otherwise.

isPagingControlPopup

public boolean isPagingControlPopup()

Indicates whether this tool is used as a popup window for the paging control of a thin presentation bean.

Returns:

true if the Find Member dialog appears as a popup, false if it does not.