Package com.microstrategy.web.app.transforms

Class FilterElementRWTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FilterElementRWTransform
extends AbstractFilterElementTransform

Deprecated.

this transform has been replaced by ViewFilterEditorRWTransform and

Since:

MicroStrategy Web 8.0.1

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform

ExpressionGenericTransform.Context

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractFilterElementTransform

_filterElement

Fields inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform

_allowAQElemsSearchParam, _allowAQFormElemsToggleParam, _allowAQSingleMultiFormToggleParam, _allowMQSingleMultiQualToggleParam, _applyEvent, _clearFilterImageTxtParam, _cssAddConditionNonEditable, _cssBranchOperatorEditable, _cssBranchOperatorNonEditable, _cssConstant, _cssConstantInError, _cssConstantNonEditable, _cssContent, _cssEditableSubexpTable, _cssFilterActionType, _cssGlobal, _cssGlobalContent, _cssObjectName, _cssObjectNameInError, _cssObjectNameNonEditable, _cssOperator, _cssOperatorInError, _cssOperatorNonEditable, _cssText, _cssTextEditable, _cssTextNonEditable, _cssTitle, _defaultAttrQualModeParam, _dynamicDateDisplayParam, _expandEmbeddedFiltersParam, _expressionBean, _formName, _formsCollectionParam, _helpTopicNameParam, _hideIDFormsParam, _multiEvent, _separatorParam, _showAddConditionButton, _showDottedLineParam, _showInlineAcceptCancelButtonsParam, _stackSubexpressionsParam, _submitButtonNameParam, _titleParam, DISPLAY_DYNAMIC_DATES_AS_DYNAMIC, DISPLAY_DYNAMIC_DATES_AS_STATIC, helpTopic, helpType, PARAM_NAME_OLD_EDIT_MODE, renderForm

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
FilterElementRWTransform()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEditSubexpression(WebNode node)	Deprecated. Overrides the superclass' behavior to determine whether the subexpression is editable or not.
protected boolean	canFilterOnUnit(WebObjectInfo oi)	Deprecated. This method determines if the current object is allowed to be filtered upon.
protected boolean	canSelectElements(WebAttribute webAttribute)	Deprecated. This method determines whether the attribute requires a lookup table to support elements qualification.
boolean	existsMultipleNonemptyFilters()	Deprecated. Overrides the superclass' behavior and returns a false to determine whether there are multiple non empty filters.
protected java.lang.String	getBoneId()	Deprecated. Returns the id to be used for the JavaScript bone.
WebBeanError	getWebBeanErrorInfo()	Deprecated.
protected WebWorkingSet	getWorkingSet()	Deprecated. Returns the working set object.
protected void	initEditor(Editor editor)	Deprecated. Initializes the editor with the global settings.
protected void	initExpressionBeanTransform(FilterElementBean _filterElem)	Deprecated. The initTransform method will take a FilterElement and will initialize itself based on that FilterElement.
boolean	isApplyCancelEnabled()	Deprecated. Overrides the superclass' behavior and returns a false to determine if the apply and cancel buttons are to be rendered.
protected boolean	isDesignMode()	Deprecated.
boolean	isEditableOrEmpty()	Deprecated. This method returns if the editor is either editable or if it is empty.
protected boolean	isMetricDimtyTooltipEnabled()	Deprecated. Overrides the superclass' behavior on whether to show the metric dimensionality tooltip.
protected boolean	isSubexpressionInError(WebNode node)	Deprecated. Overrides the superclass' behavior to determine whether the subexpression is in error or not.
void	renderEditor(MarkupOutput out)	Deprecated. Main method to render the output of an editor
void	renderGenericValidationErrorMessage(MarkupOutput out)	Deprecated. Overrides the superclass' behavior for rendering validation error message.
protected void	setBoneProperties(JsonGenerator boneProps)	Deprecated. Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
void	transformForRequestInError(MarkupOutput out)	Deprecated. Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError.
void	transformForRequestSuccessful(MarkupOutput out)	Deprecated. Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractFilterElementTransform

getBeanName, getBeanStateLevel, getSupportedBeanType, initializeTransform, isEditable, isReportFilter, isUpdateManagerEnabled, renderContent, renderPostAggregationLimitSummary, showCloseButton

Methods inherited from class com.microstrategy.web.app.transforms.ExpressionGenericTransform

addAttDetails, addAttrsToTag, addClickOnAttrSelectorButton, addClickOnMetricSelectorButton, addEventHiddenInputs, addOption, buildFlattenedList, calculateBlockBegin, canEditOperator, canMoveDown, canMoveUp, canShowMetricTextOperators, canToggleAQFormElements, generateAnchor, generateDeleteSubExpressionClickJS, generateMultiEventArgumentString, generateMultiEventArgumentString, generateOptionTag, generateUpdateManagerEventJSString, getAddConditionEvent, getAddElementsEvent, getAddEmbeddedPromptEvent, getApplyEvent, getAttributesForAcceptButton, getAttributesForPromptButton, getAutoApply, getAvailableObjectsFolder, getBeanPath, getBeginJavaScriptCall, getCancelAllEvent, getCancelEvent, getClearAllEvent, getCloseEvent, getConstantValue, getContentTableAttributes, getContentTableClass, getCreateSubexpressionEvent, getCssName, getDeleteEvent, getDescription, getDisplayName, getEditEmbeddedPromptEvent, getEditEvent, getEditExpressionJS, getEditor, getElemsSearchEvent, getEmptyFilterMessage, getEventTargetExpressionBean, getExpBeanPath, getExpressionBean, getFilterType, getFirstPageEvent, getFlattenedContexFolderList, getFlattenedContextFolderPath, getFormName, getForms, getHelpEvent, getImageFolder, getLastPageEvent, getMainDivAttributes, getMetricName, getMetricShortuctNode, getMQAcceptEvent, getNextPageEvent, getObjectAlias, getOnClickJavaScript, getOperatorName, getPreferenceIntegerReplaceNull, getPrevPageEvent, getPromptButtonSourcePath, getRemoveElementsEvent, getRemovePromptEvent, getRestoreStateEvent, getSeparator, getSpecailBeginJavaScriptCall, getToggleAQFormElemsEvent, getToggleOperatorEvent, getToggleQualExprEvent, getTooltipReportObjects, getValidateJavaScript, includeOwnerInfo, includeTimeInfo, initExpressionBeanTransform, initializeCartSettings, initializeCartSettings, initializeCss, isAddWizardRequested, isAutoSynchronizeEnabled, isFilterEditorFrameEmpty, isFilterEmpty, isItemKeptInCartAvailable, isNotDhtml, isObjectInTemplate, isShowObjectTags, isStackedSubexpEnabled, isViewFilter, isViewReport, newCart, newContext, newFet, renderAcceptButton, renderAddWizard, renderAddWizardButtons, renderAddWizardDropdown, renderAddWizardTransition, renderApplyCancelButtons, renderAQEditMode, renderAQListCart, renderAQListEditMode, renderAQListFirstRow, renderAQOperatorOption, renderAQOperatorOptions, renderAQQualifyAttrForms, renderAQQualifyAttrForms, renderAQQualifyConstantTextbox, renderAQQualifyConstantTextbox, renderAQQualifyEditMode, renderAQQualifyFunctions, renderAQQualifyFunctions, renderAQQualifyUnit, renderAQQualifyUnitComparison, renderCancelButton, renderCloseButton, renderConstantPromptArea, renderDescendantOptions, renderDottedLine, renderDownButton, renderEditorTitle, renderEmptyFilterMessage, renderErrorMessage, renderEventHiddenInputs, renderExpression, renderFilterNode, renderFilterTree, renderHeader, renderHeaderAddCondition, renderHeaderAutoApply, renderHeaderClearAll, renderHelpButton, renderJavascript, renderMeNodeEditMode, renderMeNodeQualFunctions, renderMeNodeQualOperatorOptions, renderMQConstantTextbox, renderMQEditMode, renderMQFunctions, renderMQOperatorOption, renderMQOperatorOption, renderMQOperatorOptions, renderMQUnitComparison, renderOperator, renderOperator, renderOperatorEditMode, renderOperatorViewMode, renderPromptButton, renderPromptButton, renderRemoveSubexpressionButton, renderSeparator, renderSpecificValidationErrorMessage, renderSubExpression, renderSubexpressionBodyViewMode, renderSubexpressionBodyViewMode, renderSubExpressionEditMode, renderSubExpressionViewMode, renderTitle, renderUpAndDownButtons, renderUpAndDownButtons, renderUpButton, renderUpButton, renderXDAMetricSelectorButton, setFormName, shallRenderAcceptCancell, shallRenderForm, shouldShowObject, supportsPromptEditor, useWorkingSetForFormLookup

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FilterElementRWTransform

public FilterElementRWTransform()

Deprecated.

Method Detail

initExpressionBeanTransform

protected void initExpressionBeanTransform(FilterElementBean _filterElem)

Deprecated.

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.

Specified by:

initExpressionBeanTransform in class AbstractFilterElementTransform

Parameters:

_filterElem - The FilterElement object to initialize the transform with.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Deprecated.

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.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.

Overrides:

transformForRequestSuccessful in class ExpressionGenericTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Deprecated.

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError. This method just calls AbstractAppTransform.displayError(com.microstrategy.web.beans.MarkupOutput, java.lang.String, java.lang.String, java.lang.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.

Overrides:

transformForRequestInError in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getWebBeanErrorInfo

public WebBeanError getWebBeanErrorInfo()

Deprecated.

Overrides:

getWebBeanErrorInfo in class AbstractAppTransform

Returns:

the error info

renderEditor

public void renderEditor(MarkupOutput out)

Deprecated.

Main method to render the output of an editor

Parameters:

out - MarkupOutput instance where to create the HTML output

initEditor

protected void initEditor(Editor editor)

Deprecated.

Initializes the editor with the global settings.

Parameters:

editor - the Editor to modify.

renderGenericValidationErrorMessage

public void renderGenericValidationErrorMessage(MarkupOutput out)

Deprecated.

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.

Overrides:

renderGenericValidationErrorMessage in class ExpressionGenericTransform

Parameters:

out - The MarkupOutput object to render the output to.

isEditableOrEmpty

public boolean isEditableOrEmpty()

Deprecated.

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.

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Deprecated.

Description copied from class: AbstractAppTransform

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

Overrides:

setBoneProperties in class ExpressionGenericTransform

Parameters:

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

getBoneId

protected java.lang.String getBoneId()

Deprecated.

Description copied from class: AbstractAppTransform

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.

Overrides:

getBoneId in class ExpressionGenericTransform

Returns:

String

Since:

MicroStrategy Web 9.0.0

See Also:

AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)

isDesignMode

protected boolean isDesignMode()

Deprecated.

Specified by:

isDesignMode in class AbstractFilterElementTransform

getWorkingSet

protected WebWorkingSet getWorkingSet()

Deprecated.

Returns the working set object.

Specified by:

getWorkingSet in class AbstractFilterElementTransform

Returns:

A WebWorkingSet object.

isMetricDimtyTooltipEnabled

protected boolean isMetricDimtyTooltipEnabled()

Deprecated.

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

Overrides:

isMetricDimtyTooltipEnabled in class ExpressionGenericTransform

Returns:

Whether to show the metric dimensionality in a tooltip.

isSubexpressionInError

protected boolean isSubexpressionInError(WebNode node)

Deprecated.

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.

Overrides:

isSubexpressionInError in class ExpressionGenericTransform

Returns:

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

canEditSubexpression

protected boolean canEditSubexpression(WebNode node)

Deprecated.

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.

Overrides:

canEditSubexpression in class ExpressionGenericTransform

Returns:

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

existsMultipleNonemptyFilters

public boolean existsMultipleNonemptyFilters()

Deprecated.

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

Specified by:

existsMultipleNonemptyFilters in class AbstractFilterElementTransform

Returns:

True if there exist multiple nonempty filters, false otherwise.

See Also:

AbstractFilterElementTransform.existsMultipleNonemptyFilters()

isApplyCancelEnabled

public boolean isApplyCancelEnabled()

Deprecated.

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.

Overrides:

isApplyCancelEnabled in class ExpressionGenericTransform

Returns:

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

See Also:

ExpressionGenericTransform.isApplyCancelEnabled()

canSelectElements

protected boolean canSelectElements(WebAttribute webAttribute)

Deprecated.

Description copied from class: ExpressionGenericTransform

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

Overrides:

canSelectElements in class ExpressionGenericTransform

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.

Since:

MicroStrategy Web 9.0.0

See Also:

ExpressionGenericTransform.canSelectElements(com.microstrategy.web.objects.WebAttribute)

canFilterOnUnit

protected boolean canFilterOnUnit(WebObjectInfo oi)

Deprecated.

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

Overrides:

canFilterOnUnit in class ExpressionGenericTransform

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.