public class

FilterElementRWTransform

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

This class is deprecated.
this transform has been replaced by ViewFilterEditorRWTransform and {@ViewFilterElementRWTransform }

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.AbstractFilterElementTransform
From class com.microstrategy.web.app.transforms.ExpressionGenericTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FilterElementRWTransform()
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 isEditableOrEmpty()
This method returns if the editor is either editable or if it is empty.
void renderEditor(MarkupOutput out)
Main method to render the output of an editor
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.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
boolean canEditSubexpression(WebNode node)
Overrides the superclass' behavior to determine whether the subexpression is editable or not.
boolean canFilterOnUnit(WebObjectInfo oi)
This method determines if the current object is allowed to be filtered upon.
boolean canSelectElements(WebAttribute webAttribute)
This method determines whether the attribute requires a lookup table to support elements qualification.
String getBoneId()
Returns the id to be used for the JavaScript bone.
WebWorkingSet getWorkingSet()
Returns the working set object.
void initEditor(Editor editor)
Initializes the editor with the global settings.
void initExpressionBeanTransform(FilterElementBean _filterElem)
The initTransform method will take a FilterElement and will initialize itself based on that FilterElement.
boolean isDesignMode()
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 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.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 FilterElementRWTransform ()

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 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 renderEditor (MarkupOutput out)

Main method to render the output of an editor

Parameters
out MarkupOutput instance where to create the HTML output

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

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 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 canFilterOnUnit (WebObjectInfo oi)

This method determines if the current object is allowed to be filtered upon.

Parameters
oi The WebObjectInfo unit which needs to be shown in the filterable drop down list.
Returns
  • true if the current object is allowed to be filtered upon.

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 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 WebWorkingSet getWorkingSet ()

Returns the working set object.

Returns

protected void initEditor (Editor editor)

Initializes the editor with the global settings.

Parameters
editor the Editor to modify.

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

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