public class

ViewFilterElementRWTransform

extends ViewFilterElementTransform
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
               ↳ com.microstrategy.web.app.transforms.ViewFilterElementTransform
                 ↳ com.microstrategy.web.app.transforms.ViewFilterElementRWTransform

Class Overview

Called by ViewFilterEditorRWTransform to render the the view filter in the MicroStrategy Web GUI for crosstab objects contained in a report writing document. It can transform a FilterElementBean object.

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.FilterElementTransform
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
ViewFilterElementRWTransform()
Public Methods
boolean existsMultipleNonemptyFilters()
Overrides the superclass' behavior and returns a false to determine whether there are multiple non empty filters.
WebBeanError getWebBeanErrorInfo()
boolean isApplyCancelEnabled()
Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered.
boolean isAutoSynchronizeEnabled()
This method overrides the superclass' behavior on whether auto-synchronize is enabled.
boolean isEditableOrEmpty()
This method returns if the editor is either editable or if it is empty.
void renderAddWizardDropdown(MarkupOutput out)
Overrides the superclass' behavior to show any object from any dataset if SingleSourceGrid=false
void renderGenericValidationErrorMessage(MarkupOutput out)
Overrides the superclass' behavior for rendering validation error message.
void transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestEndsInError.
Protected Methods
boolean canEditSubexpression(WebNode node)
Overrides the superclass' behavior to determine whether the subexpression is editable or not.
boolean canSelectElements(WebAttribute webAttribute)
This method determines whether the attribute requires a lookup table to support elements qualification.
WebFolder getAvailableObjectsFolder()
Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.
String getBoneId()
Returns the id to be used for the JavaScript bone.
String getTooltipReportObjects()
Overrides the superclass' behavior to show tooltip in metric expression if SingleSourceGrid=false
void initExpressionBeanTransform(FilterElementBean _filterElem)
The initTransform method will take a FilterElement and will initialize itself based on that FilterElement.
void initializeCartSettings(Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
This method will initialize the shopping cart object used to render an attribute element list qualification.
boolean isDesignMode()
Overrides the superclass' isDesignMode method.
boolean isMetricDimtyTooltipEnabled()
Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.
boolean isSubexpressionInError(WebNode node)
Overrides the superclass' behavior to determine whether the subexpression is in error or not.
void renderAQQualifyUnitComparison(MarkupOutput out, String selectedAttributeID, String selectedFormID, WebEvent acceptEvent)
Overrides the superclass' behavior to show attribute forms from any dataset if SingleSourceGrid=false
void renderMQUnitComparison(MarkupOutput out, String metricID, WebEvent acceptEvent)
Overrides the superclass' behavior to show metrics from any dataset if SingleSourceGrid=false
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.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ViewFilterElementTransform
From class com.microstrategy.web.app.transforms.FilterElementTransform
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

Public Constructors

public ViewFilterElementRWTransform ()

Public Methods

public boolean existsMultipleNonemptyFilters ()

Overrides the superclass' behavior and returns a false to determine whether there are multiple non empty filters.

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

public WebBeanError getWebBeanErrorInfo ()

Returns
  • the error info

public boolean isApplyCancelEnabled ()

Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered. For the RW view filter the enclosing editor renders the apply, ok and cancel buttons.

Returns
  • True if the apply/cancel buttons should be shown, false otherwise.

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 boolean isEditableOrEmpty ()

This method returns if the editor is either editable or if it is empty. It is used to determine if we should render the title bar div.

Returns
  • Whether the editor is either editable or if it is empty.

public void renderAddWizardDropdown (MarkupOutput out)

Overrides the superclass' behavior to show any object from any dataset if SingleSourceGrid=false

Parameters
out The MarkupOutput object to render the output to.
See Also
  • com.microstrategy.web.app.transforms.ExpressionGenericTransform#renderAddWizardDropdown()

public void renderGenericValidationErrorMessage (MarkupOutput out)

Overrides the superclass' behavior for rendering validation error message. If the expression bean has a validation error waiting on it, this method will render a generic error message. It will also check if the expression is a valid expression and render an error message if the expression is not valid any more. If there is no validation error waiting, then this method will do nothing.

Parameters
out The MarkupOutput object to render the output to.

public void transformForRequestInError (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestEndsInError. This method just calls displayError(MarkupOutput, String, String, Exception) with the title and message based on the error code from the bean's ErrorInfo, as provided by the the getErrorTitle and getErrorMessage methods accordingly.
Transforms that would like to generate customized output based on the error should extend this method.

Parameters
out output by this transform

Protected Methods

protected boolean canEditSubexpression (WebNode node)

Overrides the superclass' behavior to determine whether the subexpression is editable or not. Checks the super to determine if the subexpression is editable and also checks to see if there are any errors at the current node. The expression is not editable if there are any errors at the current node.

Returns
  • Whether the subexpression at the current node is editable or not.

protected boolean canSelectElements (WebAttribute webAttribute)

This method determines whether the attribute requires a lookup table to support elements qualification.

Parameters
webAttribute The attribute on which we have to decide if it requires a lookup table to support elements qualification.
Returns
  • true if the attribute requires a lookup table to support elements qualification.

protected WebFolder getAvailableObjectsFolder ()

Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.

Returns
  • A WebFolder with the list of available objects.

protected String getBoneId ()

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

Returns
  • String

protected String getTooltipReportObjects ()

Overrides the superclass' behavior to show tooltip in metric expression if SingleSourceGrid=false

Returns
  • String

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 void initializeCartSettings (Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)

This method will initialize the shopping cart object used to render an attribute element list qualification.

Parameters
cart The Cart object being initialized.
acceptEvent The event to use to accept the qualficiation.
elemsBlockBegin The blockBegin parameter for the available elements to retrieve.
elemsBlockCount The blockBegin parameter for the available elements to retrieve.
totalElements The total number of elements in the element list of available elements.

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 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 isSubexpressionInError (WebNode node)

Overrides the superclass' behavior to determine whether the subexpression is in error or not. Returns whether the subexpression at the current node is in error or not.

Returns
  • Whether the subexpression at the current node is in error or not.

protected void renderAQQualifyUnitComparison (MarkupOutput out, String selectedAttributeID, String selectedFormID, WebEvent acceptEvent)

Overrides the superclass' behavior to show attribute forms from any dataset if SingleSourceGrid=false

Parameters
out The MarkupOutput object to render the output to.
acceptEvent The event used to accept the qualification.

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

Overrides the superclass' behavior to show metrics from any dataset if SingleSourceGrid=false

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.