public abstract class

AbstractFilterElementTransform

extends ExpressionGenericTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FilterElementBean _filterElement
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractFilterElementTransform()
Public Methods
abstract boolean existsMultipleNonemptyFilters()
This method returns whether there exist multiple nonempty filters.
Class getSupportedBeanType()
Returns the supported bean type for this transform.
void initializeTransform(Transformable data)
Overrides the initializeTransform method with type-specific initialization data.
boolean isEditable()
This method is to return whether the expression should be considered to be editable or not.
boolean isReportFilter()
Returns whether the report filter is being rendered.
boolean isUpdateManagerEnabled()
If this method returns true, then the transform will send all multiple events through the update manager.
void renderContent(MarkupOutput out)
This method overrides the renderContent method on the superclass, and ensures rendering of report limits in addition to (or in the case of MDX reports, instead of) the filter.
void renderPostAggregationLimitSummary(MarkupOutput out)
Renders Report Limit summary section below Filter Expression.
Protected Methods
String getBeanName()
Overrides getBeanName on the superclass with the FilterElement's bean name.
int getBeanStateLevel()
Overrides the superclass' getBeanStateLevel.
abstract WebWorkingSet getWorkingSet()
Returns the working set object, if the filter is a report filter.
abstract void initExpressionBeanTransform(FilterElementBean _filterElem)
abstract boolean isDesignMode()
boolean showCloseButton()
This method overrides the showCloseButton method on the superclass, and decides, based upon application context, whether it is correct to show the close button.
[Expand]
Inherited Methods
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 FilterElementBean _filterElement

Public Constructors

public AbstractFilterElementTransform ()

Public Methods

public abstract 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 Class getSupportedBeanType ()

Returns the supported bean type for this transform.

Returns
  • A Class object representing the bean type this transform supports.

public void initializeTransform (Transformable data)

Overrides the initializeTransform method with type-specific initialization data. This MUST be overridden by any classes which extend this transform if they do not transform on a FilterElement object, because this initializeTransform method assumes that the Transformable passed to it is of type FilterElement.

Parameters
data The object that is being transformed.

public boolean isEditable ()

This method is to return whether the expression should be considered to be editable or not. If this is true, then the transform may render the expression with editing capabilities. If this is false, then the transform should render the expression in a view-only mode.

Returns
  • True if the expression should be editable, false otherwise.

public boolean isReportFilter ()

Returns whether the report filter is being rendered.

Returns
  • True if the report filter is being rendered, false otherwise.

public boolean isUpdateManagerEnabled ()

If this method returns true, then the transform will send all multiple events through the update manager. If this is false, then the transform will generate its own multiple events.

Returns
  • True if the update manager is enabled, false otherwise.

public void renderContent (MarkupOutput out)

This method overrides the renderContent method on the superclass, and ensures rendering of report limits in addition to (or in the case of MDX reports, instead of) the filter.

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.

Protected Methods

protected String getBeanName ()

Overrides getBeanName on the superclass with the FilterElement's bean name.

Returns
  • The expression bean's name.

protected int getBeanStateLevel ()

Overrides the superclass' getBeanStateLevel. It uses the context of the FilterElement to determine the level of state which must be saved for the bean.

Returns
  • The bean state level required for the ExpressionBean.

protected abstract WebWorkingSet getWorkingSet ()

Returns the working set object, if the filter is a report filter. Otherwise, returns null.

Returns
  • A WebWorkingSet object if the filter is a report filter, or null otherwise.

protected abstract void initExpressionBeanTransform (FilterElementBean _filterElem)

protected abstract boolean isDesignMode ()

protected boolean showCloseButton ()

This method overrides the showCloseButton method on the superclass, and decides, based upon application context, whether it is correct to show the close button.

Returns
  • Whether to show a close button.