public class

ReportFrameBeanImpl

extends AbstractPersistableAppComponent
implements FrameBean ReportFrameBean
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.beans.AbstractTransformable
       ↳ com.microstrategy.web.beans.AbstractWebComponent
         ↳ com.microstrategy.web.app.beans.AbstractAppComponent
           ↳ com.microstrategy.web.app.beans.AbstractPersistableAppComponent
             ↳ com.microstrategy.web.app.beans.ReportFrameBeanImpl

Class Overview

The ReportFrameBeanImpl is a container for the ReportBean and all the beans associated with it, such as editors, formula bar, etc.

Summary

Constants
String REPORT_FILTER_NAME
String REPORT_LIMIT_NAME
String VIEW_FILTER_NAME
String VIEW_LIMIT_NAME
[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ReportFrameBean
Fields
protected String _editor Local property which value reflects the current editor
protected String _promptStyle Local property which stores the actual prompt style used.
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Methods
void addChild(String key, WebComponent child)
Adds a child component to the current WebComponent.
void addChildStateInfo(ParameterBuilder paramBldr, int howMuchState)
Adds children state information into an existing ParameterBuilder instance.
void addChildStateInfo(ParameterBuilder paramBldr)
Adds children state information into an existing ParameterBuilder instance.
void closeElement(FrameElement element)
Mark as closed the corresponding ReportFrameElement
void collectData()
We need to over-ride the collectdata on the ReportFrame so that we can clear the promptStyle property when the report bean is successful or ends in error
void doCollectData()
For performance, this method overrides the default collectData() by checking if the ReportBean will be displayed, and if not it will not trigger it's collectData().
MarkupOutput generateOutput()
This method creates a ReportFrameClassicTransform and returns the result of transforming it.
AttributeFormsEditorBean getAttributeFormsEditorBean()
Returns the attribute forms editor bean within this report frame bean.
WebComponent getChild(String key)
Get the child instance based on the key passed as argument
FrameElement getCurrentEditor()
It returns which is the current editor to be displayied.
int getDefaultStateLevel()
Returns the default state level.
DerivedElementsEditorBean getDerivedElementsEditor()
int getDesignMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
int getDesignModeStage()
Check the preferences for the name of the editor that will be displayed with this request.
DocumentBean getDocumentBean()
Returns the report bean associated with this report frame bean.
DrillEditorBean getDrillEditorBean()
Returns the drill editor bean within this report frame bean.
DrillFilterEditorBean getDrillFilterEditorBean()
Returns the drill filter editor bean within this report frame bean.
String getDynamicMenuName()
Name of the Shortcut object to use as Dynamic Menu
String getEditorMessage()
This method is used to set a message related with an Editor action.
int getExecutionMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
WebFeatures getFeaturesManager()
Return the WebFeatures implementation associated with this WebComponent
FilterElementBean getFilterElement(int type)
FormulaBarBean getFormulaBarBean()
Returns the formular bar bean within this report frame bean.
GraphFormatEditorBean getGraphFormatEditorBean()
Returns the graph format editor bean within this report frame bean.
GraphFormatToolbarBean getGraphFormatToolbarBean()
Returns the graph format toolbar bean within this report frame bean.
GridFormatEditorBean getGridFormatEditorBean()
Returns the grid format editor bean within this report frame bean.
GridFormatToolbarBean getGridFormatToolbarBean()
Returns the grid format toolbar bean within this report frame bean.
Object getIFrameComponent(String name)
Returns the associated object associated with the iFrame component.
boolean getIsDesignMode()
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign
Menu getMenus()
Returns the menus for this FrameBean based on the dynamicMenuName property.
String getMessageBeforeData()
This method is deprecated. use getEditorMessage()
ObjectBrowserBean getObjectBrowserBean()
This method is deprecated. This method should no longer be used. Use getObjectBrowserTabMgrBean instead.
ObjectBrowserManagerBean getObjectBrowserTabMgrBean()
Returns the ObjectBrowser bean associated with this report frame bean.
PageByBean getPageByBean()
PromptDetailsBean getPromptDetailsBean()
Returns a PromptDetailsBean object corresponding to the prompt details.
String getPromptStyle()
Indicates actual prompt style used.
PromptsContainerBean getPromptsContainerBean()
Returns a PromptsContainerBean object corresponding to the prompts container.
RWBean getRWBean()
Returns the rw bean associated with this report frame bean.
boolean getRefreshGrid()
Retrieves the flag indicating whether to refresh the grid or not.
ReportBean getReportBean()
Returns the report bean associated with this report frame bean.
ReportDetailsBean getReportDetailsBean()
Returns a ReportDetailsBean object corresponding to the report details.
String getReportEditorName()
Retrieves the name of the current open report editor
FilterEditorBean getReportFilterEditor()
Returns the report filter editor bean within this report frame bean.
FilterElementBean getReportFilterElement()
Returns a FilterElementBean object corresponding to the report filter.
FilterElementBean getReportLimitElement()
String getReportStyleLocalizedName()
ResizeEditorBean getResizeEditorBean()
Returns the resize editor bean within this report frame bean.
SubscriptionEditorBean getSchedulesEditorBean()
Returns the Subscription editor bean to use with web Subscriptions.
SubscriptionEditorBean getSendNowEditorBean()
Returns the Subscription editor bean to use with Send Now feature.
SortEditorBean getSortEditorBean()
Returns the sort editor bean within this report frame bean.
SubscriptionEditorBean getSubscriptionsEditorBean()
Returns the Subscription editor bean to use with Narrowcast Subscriptions.
WebComponent getTargetBean()
Returns the target bean associated with this FrameBean.
boolean getUseIFrame()
Returns if the ReportFrame uses IFrames
FilterEditorBean getViewFilterEditor()
Returns the view filter editor bean within this report frame bean.
FilterElementBean getViewFilterElement()
Returns a FilterElementBean object corresponding to the view filter.
FilterElementBean getViewLimitElement()
VisualizationPropertiesEditorBean getVisualizationPropertiesEditorBean()
int getXMLStatus()
Returns the EnumRequestStatus status of the bean.
boolean hasChanged()
Verifies the state of the component has changed
boolean isEventNeedsToCollectData()
boolean isIframeEnabled()
Determines if the instance is enabled to work on IFrame environments
boolean isNoActionFlagRemoved()
boolean isOpen(FrameElement element)
Identifies if the given ReportFrameElement is open.
boolean isReportToolbarEnabled()
Returns true if the report toolbar should be enabled
void openElement(FrameElement element)
Mark as opened the corresponding ReportFrameElement
void setDesignMode(int designMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
void setDesignModeStage(int designModeStage)
Sets the design mode stage of the report frame bean
void setDynamicMenuName(String dynamicMenuName)
Set the name of the dynamic menu to be associated with this instance
void setEditorMessage(String message)
This method is used to set a message related with an Editor action.
void setEventNeedsToCollectData(boolean needsToCollectData)
void setExecutionMode(int executeMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
void setMessageBeforeData(String message)
This method is deprecated. use setEditorMessage(String)
void setNoActionFlagRemoved(boolean noActionFlagRemoved)
Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
void setPromptStyle(String style)
Specifies which style to use for prompt transforms.
void setRefreshGrid(boolean value)
Sets a flag indicating whether to refresh the grid or not.
void setReportEditorName(String value)
Sets the name of the report editor to be open
void setUseIFrame(boolean value)
Defines if the ReportFrame should use IFrame
void setXMLStatus(int value)
Sets the EnumRequestStatus status of the bean.
boolean shouldDisplayContent(String name)
Returns false if an iFrame component needs not to be rendered in an iFrame request.
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Proceses the save/restore state opperation of the AppComponent
boolean isIFrameRequest()
Utility method that determines if it's an IFrame type of request.
boolean isObjectBrowserOpen()
Checks if the given ObjectBrowserManagerBean is open
WebEventHandler newDefaultEventHandler()
WebComponent searchChildByClass(Class beanClass)
void setCookie(String key, String value)
Set a cookie value as specified
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameBean
From interface com.microstrategy.web.app.beans.ReportFrameBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

protected static final String REPORT_FILTER_NAME

Constant Value: "rfe"

protected static final String REPORT_LIMIT_NAME

Constant Value: "rLe"

protected static final String VIEW_FILTER_NAME

Constant Value: "vfe"

protected static final String VIEW_LIMIT_NAME

Constant Value: "vle"

Fields

protected String _editor

Local property which value reflects the current editor

protected String _promptStyle

Local property which stores the actual prompt style used.

Public Methods

public void addChild (String key, WebComponent child)

Adds a child component to the current WebComponent. This call invalidates the cached states.

Parameters
key the key mapped to the child component.
child the child component to add.

public void addChildStateInfo (ParameterBuilder paramBldr, int howMuchState)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Overrides addChildStateInfo() for the smartCollectData case: When doing smartCollectData we change some settings in the Result flags or the WindowSettings of the report data to bring less information. We don't want these changes to be saved in the state of the report bean, so its state is saved before this changes and this method appends that state, instead of the current one.

Parameters
paramBldr The ParameterBuilder instance which has child state information added to it.
howMuchState How much persistable state of EnumWebPersistableState to return from its children.

public void addChildStateInfo (ParameterBuilder paramBldr)

Adds children state information into an existing ParameterBuilder instance. It is up to the supplied ParameterBuilder to determine how this information is serialized. Each WebComponent the hierarchy serializes its state according to its own getDefaultStateLevel().

Parameters
paramBldr The ParameterBuilder instance which has child state information added to it.

public void closeElement (FrameElement element)

Mark as closed the corresponding ReportFrameElement

Parameters
element the element to open
See Also

public void collectData ()

We need to over-ride the collectdata on the ReportFrame so that we can clear the promptStyle property when the report bean is successful or ends in error

public void doCollectData ()

For performance, this method overrides the default collectData() by checking if the ReportBean will be displayed, and if not it will not trigger it's collectData().

public MarkupOutput generateOutput ()

This method creates a ReportFrameClassicTransform and returns the result of transforming it.

Returns

public AttributeFormsEditorBean getAttributeFormsEditorBean ()

Returns the attribute forms editor bean within this report frame bean.

Returns

public WebComponent getChild (String key)

Get the child instance based on the key passed as argument

Parameters
key String value with the name to look for
Returns

public FrameElement getCurrentEditor ()

It returns which is the current editor to be displayied. Formatting editors (Grid or Graph), if current, are not considered.

Returns
  • the current editor,

public int getDefaultStateLevel ()

Returns the default state level. If not set, the default state level is EnumWebPersistableState.MINIMAL_STATE_INFO.

Returns
  • the defautl state level.

public DerivedElementsEditorBean getDerivedElementsEditor ()

public int getDesignMode ()

Returns the view mode of the report frame bean (a value from EnumReportViewModes)

Returns
  • the view mode of the report frame bean (a value from EnumReportViewModes)

public int getDesignModeStage ()

Check the preferences for the name of the editor that will be displayed with this request.

Returns
  • the name of the editor to be displayed for this frame

public DocumentBean getDocumentBean ()

Returns the report bean associated with this report frame bean.

Returns
  • the report bean associated with this report frame bean

public DrillEditorBean getDrillEditorBean ()

Returns the drill editor bean within this report frame bean.

Returns
  • the drill editor bean within this report frame bean.

public DrillFilterEditorBean getDrillFilterEditorBean ()

Returns the drill filter editor bean within this report frame bean.

Returns

public String getDynamicMenuName ()

Name of the Shortcut object to use as Dynamic Menu

Returns
  • the name of the dynamic menu associated with this instance

public String getEditorMessage ()

This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.

Returns
  • the message to be shown.

public int getExecutionMode ()

Returns the view mode of the report frame bean (a value from EnumReportViewModes)

Returns
  • the view mode of the report frame bean (a value from EnumReportViewModes)

public WebFeatures getFeaturesManager ()

Return the WebFeatures implementation associated with this WebComponent

Returns
  • a WebFeatures instance

public FilterElementBean getFilterElement (int type)

public FormulaBarBean getFormulaBarBean ()

Returns the formular bar bean within this report frame bean.

Returns
  • the formular bar bean within this report frame bean.

public GraphFormatEditorBean getGraphFormatEditorBean ()

Returns the graph format editor bean within this report frame bean.

Returns
  • the graph format editor within this report frame bean.

public GraphFormatToolbarBean getGraphFormatToolbarBean ()

Returns the graph format toolbar bean within this report frame bean.

Returns
  • the graph format toolbar within this report frame bean

public GridFormatEditorBean getGridFormatEditorBean ()

Returns the grid format editor bean within this report frame bean.

Returns
  • the grid format editor within this report frame bean.

public GridFormatToolbarBean getGridFormatToolbarBean ()

Returns the grid format toolbar bean within this report frame bean.

Returns
  • the grid format toolbar within this report frame bean.

public Object getIFrameComponent (String name)

Returns the associated object associated with the iFrame component. An iFrame component is any part of the interface that can be refreshed independently when using iFrames, for example a Bean, the current editor, the menus or the editor's message.

Parameters
name String with the name of the iframe component to look for
Returns
  • the corresponding iFrame component for the given name

public boolean getIsDesignMode ()

Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign

Returns
  • boolean true if the the report frame bean is in design mode TQMS 249689, add this method to interface ReportFrameBean

public Menu getMenus ()

Returns the menus for this FrameBean based on the dynamicMenuName property.

Returns
  • Menu instance associated with this bean

public String getMessageBeforeData ()

This method is deprecated.
use getEditorMessage()

Returns
  • editor message

public ObjectBrowserBean getObjectBrowserBean ()

This method is deprecated.
This method should no longer be used. Use getObjectBrowserTabMgrBean instead.

Returns the ObjectBrowser bean associated with this report frame bean.

Returns
  • the DynamicMenu bean associated with this report frame bean

public ObjectBrowserManagerBean getObjectBrowserTabMgrBean ()

Returns the ObjectBrowser bean associated with this report frame bean. The Object Browser is now a TabManager bean.

Returns
  • TabManagerBean

public PageByBean getPageByBean ()

Returns

public PromptDetailsBean getPromptDetailsBean ()

Returns a PromptDetailsBean object corresponding to the prompt details.

Returns

public String getPromptStyle ()

Indicates actual prompt style used.

Returns
  • String name of prompt style.

public PromptsContainerBean getPromptsContainerBean ()

Returns a PromptsContainerBean object corresponding to the prompts container.

Returns

public RWBean getRWBean ()

Returns the rw bean associated with this report frame bean.

Returns
  • the rw bean associated with this report frame bean

public boolean getRefreshGrid ()

Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.

public ReportBean getReportBean ()

Returns the report bean associated with this report frame bean.

Returns
  • the report bean associated with this report frame bean

public ReportDetailsBean getReportDetailsBean ()

Returns a ReportDetailsBean object corresponding to the report details.

Returns

public String getReportEditorName ()

Retrieves the name of the current open report editor

Returns
  • The name of the current open report editor

public FilterEditorBean getReportFilterEditor ()

Returns the report filter editor bean within this report frame bean.

Returns
  • the report filter editor bean within this report frame bean.

public FilterElementBean getReportFilterElement ()

Returns a FilterElementBean object corresponding to the report filter.

Returns

public FilterElementBean getReportLimitElement ()

public String getReportStyleLocalizedName ()

Returns
  • the report bean's localized style name. It's used for old-formatting reports to apply style first before other formattig manipulation. For new-formatting reports, it returns "".

public ResizeEditorBean getResizeEditorBean ()

Returns the resize editor bean within this report frame bean.

Returns

public SubscriptionEditorBean getSchedulesEditorBean ()

Returns the Subscription editor bean to use with web Subscriptions.

Returns

public SubscriptionEditorBean getSendNowEditorBean ()

Returns the Subscription editor bean to use with Send Now feature.

Returns

public SortEditorBean getSortEditorBean ()

Returns the sort editor bean within this report frame bean.

Returns

public SubscriptionEditorBean getSubscriptionsEditorBean ()

Returns the Subscription editor bean to use with Narrowcast Subscriptions.

Returns

public WebComponent getTargetBean ()

Returns the target bean associated with this FrameBean. The target bean is the one with the main data.

Returns
  • the target bean for this Frame.

public boolean getUseIFrame ()

Returns if the ReportFrame uses IFrames

Returns
  • true if frames are used.

public FilterEditorBean getViewFilterEditor ()

Returns the view filter editor bean within this report frame bean.

Returns
  • the view filter editor bean within this report frame bean.

public FilterElementBean getViewFilterElement ()

Returns a FilterElementBean object corresponding to the view filter.

Returns

public FilterElementBean getViewLimitElement ()

public VisualizationPropertiesEditorBean getVisualizationPropertiesEditorBean ()

public int getXMLStatus ()

Returns the EnumRequestStatus status of the bean. By default the status of this bean is EnumRequestStatus.WebBeanRequestSuccessful.

Returns

public boolean hasChanged ()

Verifies the state of the component has changed

Returns
  • boolean value indicating if the current instance has changed.

public boolean isEventNeedsToCollectData ()

Returns
  • Returns the _eventNeedsToCollectData.

public boolean isIframeEnabled ()

Determines if the instance is enabled to work on IFrame environments

Returns
  • boolean value indicating whether IFrame is enabled for this component

public boolean isNoActionFlagRemoved ()

public boolean isOpen (FrameElement element)

Identifies if the given ReportFrameElement is open. To identify whether a FrameElement is open, The ReportFrameBean checks the following:

  • In design mode:
    1. the object-browser and page-by section are always opened.
    2. the view and report filters are opened only when editing the filter.
    3. all other elements are closed.
  • In View mode:
    1. The object browser depends on the WebBrowserSettingObjBrowserView browser setting
    2. The page-by depends on the WebBrowserSettingPageBySection browser setting
    3. The grid and graph toolbar depends on a browser setting whose name is this ReportFrameBean name + "_" + WebBrowserSettingFormatToolbar i.e.:
      key = getName() + "_" + element.getName();
    4. Other elements depends on a browser setting whose is this ReportFrameBean name + "_" + the element's name, i.e.:
      key = getName() + "_" + element.getName();

Parameters
element FrameElement instance to check if it's opened or not
Returns
  • true if the element is open.

public boolean isReportToolbarEnabled ()

Returns true if the report toolbar should be enabled

Returns
  • isReportToolbarEnabled

public void openElement (FrameElement element)

Mark as opened the corresponding ReportFrameElement

Parameters
element the element to open
See Also

public void setDesignMode (int designMode)

Sets the view mode of the report frame bean (a value from EnumReportViewModes)

Parameters
designMode the view mode of the report frame bean (a value from EnumReportViewModes)

public void setDesignModeStage (int designModeStage)

Sets the design mode stage of the report frame bean

Parameters
designModeStage the design mode stage of the report frame bean (a value from EnumReportDesignMode)

public void setDynamicMenuName (String dynamicMenuName)

Set the name of the dynamic menu to be associated with this instance

Parameters
dynamicMenuName String with the name of the dynamic menu to be associated with this bean

public void setEditorMessage (String message)

This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.

Parameters
message the message to be shown.

public void setEventNeedsToCollectData (boolean needsToCollectData)

Parameters
needsToCollectData The _eventNeedsToCollectData to set.

public void setExecutionMode (int executeMode)

Sets the view mode of the report frame bean (a value from EnumReportViewModes)

Parameters
executeMode the view mode of the report frame bean (a value from EnumReportViewModes)

public void setMessageBeforeData (String message)

This method is deprecated.
use setEditorMessage(String)

Parameters
message String

public void setNoActionFlagRemoved (boolean noActionFlagRemoved)

Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode

Parameters
noActionFlagRemoved boolean true indicates we just remove the noAction flag from the executionFlags when switch a report from design mode to view mode

public void setPromptStyle (String style)

Specifies which style to use for prompt transforms.
This property indicates what prompt style to use when transforming a prompted Bean.

Parameters
style String

public void setRefreshGrid (boolean value)

Sets a flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.

public void setReportEditorName (String value)

Sets the name of the report editor to be open

Parameters
value The name of the report editor to be open

public void setUseIFrame (boolean value)

Defines if the ReportFrame should use IFrame

Parameters
value if true, the ReportFrame will use IFrames

public void setXMLStatus (int value)

Sets the EnumRequestStatus status of the bean.

Parameters
value The XML status value ofor this bean.

public boolean shouldDisplayContent (String name)

Returns false if an iFrame component needs not to be rendered in an iFrame request.

Parameters
name the component to render
Returns
  • false if the component should not be rendered, true otherwise.

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters
serializer an instance of the FlatStateSerializer object to use
howMuchState defines how much information needs to be saved
tokenizer an instance of the FlatStateTokenizer object to use

protected boolean isIFrameRequest ()

Utility method that determines if it's an IFrame type of request.

Returns
  • boolean value indicating if the request is of type IFrame or not. By default it is based only on information available on the RequestKeys associated with this instance.

protected boolean isObjectBrowserOpen ()

Checks if the given ObjectBrowserManagerBean is open

Returns
  • true if the element is open.

protected WebEventHandler newDefaultEventHandler ()

protected WebComponent searchChildByClass (Class beanClass)

protected void setCookie (String key, String value)

Set a cookie value as specified

Parameters
key name of the cookie to modify
value String with the value to assign to the specified cookie key