public class

FilterElementTransform

extends AbstractFilterElementTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ExpressionGenericTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFilterElementTransform
             ↳ com.microstrategy.web.app.transforms.FilterElementTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The FilterElementTransform is the transform that is used to render the view and base filters in the MicroStrategy Web GUI. It can transform a FilterElementBean object. Note that this transform extends the ExpressionGenericTransform, which transforms on a ExpressionBean. This is because this transform reuses a vast amount of the rendering methods from that transform, and only overrides filter editor-specific functionality.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameterImpl useBackendDetails Whether to use backend's filter details when possible
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractFilterElementTransform
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FilterElementTransform()
Public Methods
boolean existsMultipleNonemptyFilters()
This method returns whether there exist multiple nonempty filters.
boolean getAutoApply()
Overrides the superclass' getAutoApply method - this will return whether the current filter's autoapply setting is true or false.
String getDescription()
Returns a textual description of the transform.
WebEvent getHelpEvent()
This method is deprecated. not use anymore
boolean isAutoSynchronizeEnabled()
This method overrides the superclass' behavior on whether auto-synchronize is enabled.
void renderFilterTree(MarkupOutput out)
This method will render the actual filter expression tree in the GUI.
void renderHeaderAutoApply(MarkupOutput out)
Overrides the method to render the auto-apply portion of the header in the superclass.
void renderPostAggregationLimitSummary(MarkupOutput out)
Renders Report Limit summary section below Filter Expression.
void renderPreAggregationLimitSummary(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
void addClickOnAttrSelectorButton(InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)
void addClickOnMetricSelectorButton(InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)
List buildFlattenedList(int contextId, StringWrapper path)
WebEvent getAddEmbeddedPromptEvent()
WebEvent getEditEmbeddedPromptEvent()
String getEmptyFilterMessage()
Returns the message that should be used if the filter is empty.
String getPromptButtonSourcePath()
WebReportInstance getReportInstance()
WebExpression getReportLimitExpression(int flags)
This method will return the given limit summary expression.
WebWorkingSet getWorkingSet()
Returns the working set object.
void initExpressionBeanTransform(FilterElementBean _filterElem)
The initTransform method will take a FilterElement and will initialize itself based on that FilterElement.
boolean isDesignMode()
Overrides the superclass' isDesignMode method.
boolean isFilterEditorFrameEmpty()
Returns whether the full filter editor frame is empty.
boolean isMetricDimtyTooltipEnabled()
Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.
boolean isReport()
Whether we are editing the filter of a report.
boolean isSubsetReport()
void renderAQQualifyUnit(MarkupOutput out, WebNode node, WebEvent acceptEvent)
void renderMQUnitComparison(MarkupOutput out, String metricID, WebEvent acceptEvent)
This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..
void renderPostAggregationTitle(Tag trTag)
void renderXDAMetricSelectorButton(MarkupOutput out)
boolean shallRenderPostAggregationSummery(WebExpression expr)
boolean supportsPromptEditor()
boolean useBackendDetails()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractFilterElementTransform
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameterImpl useBackendDetails

Whether to use backend's filter details when possible

Public Constructors

public FilterElementTransform ()

Public Methods

public boolean existsMultipleNonemptyFilters ()

This method returns whether there exist multiple nonempty filters. If so, the default layout behavior is to render some space between the two filters. This will happen when either both a report limit and filter are being rendered, or when two limits are being rendered, for an MDX report.

Returns
  • True if there exist multiple nonempty filters, false otherwise.

public boolean getAutoApply ()

Overrides the superclass' getAutoApply method - this will return whether the current filter's autoapply setting is true or false.

Returns
  • The current auto apply setting.

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public WebEvent getHelpEvent ()

This method is deprecated.
not use anymore

Returns the WebEvent which is associated with the help button.

Returns
  • The help event.

public boolean isAutoSynchronizeEnabled ()

This method overrides the superclass' behavior on whether auto-synchronize is enabled. In this case, it is enabled if auto-apply is true or the report is in design mode.

Returns
  • Whether auto-synchronize is enabled for this transform.

public void renderFilterTree (MarkupOutput out)

This method will render the actual filter expression tree in the GUI. This is the lowest-level method that can be called by the layout to render the actual expression itself.

Parameters
out The MarkupOutput object to render the output to.

public void renderHeaderAutoApply (MarkupOutput out)

Overrides the method to render the auto-apply portion of the header in the superclass. This method will render the auto-apply checkbox using the preference value stored for the auto-apply setting.

Parameters
out The MarkupOutput object to render the output to.

public void renderPostAggregationLimitSummary (MarkupOutput out)

Renders Report Limit summary section below Filter Expression.

Parameters
out The MarkupOutput object to render the output to.

public void renderPreAggregationLimitSummary (MarkupOutput out)

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected void addClickOnAttrSelectorButton (InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)

protected void addClickOnMetricSelectorButton (InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)

protected List buildFlattenedList (int contextId, StringWrapper path)

protected WebEvent getAddEmbeddedPromptEvent ()

protected WebEvent getEditEmbeddedPromptEvent ()

protected String getEmptyFilterMessage ()

Returns the message that should be used if the filter is empty.

protected String getPromptButtonSourcePath ()

protected WebReportInstance getReportInstance ()

protected WebExpression getReportLimitExpression (int flags)

This method will return the given limit summary expression.

Parameters
flags A value from EnumWebLimitSummaryFlags.
Returns

protected WebWorkingSet getWorkingSet ()

Returns the working set object.

Returns

protected void initExpressionBeanTransform (FilterElementBean _filterElem)

The initTransform method will take a FilterElement and will initialize itself based on that FilterElement. This method must be called by any derived classes' initializeTransform method.

Parameters
_filterElem The FilterElement object to initialize the transform with.

protected boolean isDesignMode ()

Overrides the superclass' isDesignMode method. This method checks with the owner ReportFrameBean to determine whether the report is in design mode or not.

protected boolean isFilterEditorFrameEmpty ()

Returns whether the full filter editor frame is empty. This is different from the superclass' method that it overrides in that it takes into account the report limit in it's calculations for the report filter.

Returns
  • Whether the filter editor frame is empty.

protected boolean isMetricDimtyTooltipEnabled ()

Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.

Returns
  • Whether to show the metric dimensionality in a tooltip.

protected boolean isReport ()

Whether we are editing the filter of a report.
false if we are editing the filter of a grid in a document

Returns
  • Whether we are editing the filter of a report

protected boolean isSubsetReport ()

protected void renderAQQualifyUnit (MarkupOutput out, WebNode node, WebEvent acceptEvent)

protected void renderMQUnitComparison (MarkupOutput out, String metricID, WebEvent acceptEvent)

This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..

Parameters
out The MarkupOutput object to render the output to.
metricID The metric ID of the currently selected object in the pulldown.
acceptEvent The event that is used to accept the qualificiation.

protected void renderPostAggregationTitle (Tag trTag)

protected void renderXDAMetricSelectorButton (MarkupOutput out)

protected boolean shallRenderPostAggregationSummery (WebExpression expr)

protected boolean supportsPromptEditor ()

protected boolean useBackendDetails ()