public class

FilterExpressionTransform

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.FilterExpressionTransform

Class Overview

The FilterExpressionTransform 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
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FilterExpressionTransform()
Public Methods
boolean getAutoApply()
Returns whether the auto-apply functionality is enabled.
String getDescription()
Returns a textual description of the transform.
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 isUpdateManagerEnabled()
This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager.
void renderButton(MarkupOutput out, WebEvent event, String desc)
void renderSaveCancelButtons(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)
void addEventHiddenInputs(ArrayList eventList)
void checkStatus(MarkupOutput out)
String getEmptyFilterMessage()
Returns the message that should be used if the filter is empty.
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 setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean supportsPromptEditor()
[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

Public Constructors

public FilterExpressionTransform ()

Public Methods

public boolean getAutoApply ()

Returns whether the auto-apply functionality is enabled. If this is true, the transform will render the GUI such that it expects that every operation will apply changes to the original expression automatically.

Returns
  • Whether auto-apply is enabled.

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

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 isUpdateManagerEnabled ()

This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager. By default, this is false, meaning that the update manager should not be used.

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

public void renderButton (MarkupOutput out, WebEvent event, String desc)

public void renderSaveCancelButtons (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 void addEventHiddenInputs (ArrayList eventList)

protected void checkStatus (MarkupOutput out)

Parameters
out output by this transform

protected String getEmptyFilterMessage ()

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

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 setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected boolean supportsPromptEditor ()