Package com.microstrategy.web.app.transforms

Class 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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

ViewFilterElementRWTransform

public class ViewFilterElementTransform
extends FilterElementTransform

Filter Element used to display the View Filter on the report page.

Since:

MicroStrategy Web 9.0.0

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

useBackendDetails

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canFilterOnUnit(WebObjectInfo oi)	This method determines if the current object is allowed to be filtered upon.
WebEvent	getApplyEvent()	Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.
java.util.Map	getMainDivAttributes()	Returns the list of attributes to add to the main that makes up the filter editor GUI.
protected WebEvent	getMQAcceptEvent(boolean isMetricExprQual)
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.
protected void	renderAcceptButton(MarkupOutput out, WebEvent acceptEvent, java.lang.String[] eventArgList, boolean isDefault)
protected void	renderMoveNodeToViewLimitButton(MarkupOutput mainOut, WebNode node)
protected void	renderUpAndDownButtons(MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)
protected void	setBoneProperties(JsonGenerator boneProps)	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.
protected boolean	useBackendDetails()

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

addClickOnAttrSelectorButton, addClickOnMetricSelectorButton, buildFlattenedList, existsMultipleNonemptyFilters, getAddEmbeddedPromptEvent, getAutoApply, getDescription, getEditEmbeddedPromptEvent, getEmptyFilterMessage, getHelpEvent, getPromptButtonSourcePath, getReportInstance, getReportLimitExpression, getWorkingSet, initExpressionBeanTransform, isAutoSynchronizeEnabled, isDesignMode, isFilterEditorFrameEmpty, isMetricDimtyTooltipEnabled, isReport, isSubsetReport, renderAQQualifyUnit, renderFilterTree, renderHeaderAutoApply, renderMQUnitComparison, renderPostAggregationLimitSummary, renderPostAggregationTitle, renderPreAggregationLimitSummary, renderXDAMetricSelectorButton, shallRenderPostAggregationSummery, supportsPromptEditor, transformForRequestSuccessful

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

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

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

addAttDetails, addAttrsToTag, addEventHiddenInputs, addOption, calculateBlockBegin, canEditOperator, canEditSubexpression, canMoveDown, canMoveUp, canSelectElements, canShowMetricTextOperators, canToggleAQFormElements, generateAnchor, generateDeleteSubExpressionClickJS, generateMultiEventArgumentString, generateMultiEventArgumentString, generateOptionTag, generateUpdateManagerEventJSString, getAddConditionEvent, getAddElementsEvent, getAttributesForAcceptButton, getAttributesForPromptButton, getAvailableObjectsFolder, getBeanPath, getBeginJavaScriptCall, getBoneId, getCancelAllEvent, getCancelEvent, getClearAllEvent, getCloseEvent, getConstantValue, getContentTableAttributes, getContentTableClass, getCreateSubexpressionEvent, getCssName, getDeleteEvent, getDisplayName, getEditEvent, getEditExpressionJS, getEditor, getElemsSearchEvent, getEventTargetExpressionBean, getExpBeanPath, getExpressionBean, getFilterType, getFirstPageEvent, getFlattenedContexFolderList, getFlattenedContextFolderPath, getFormName, getForms, getImageFolder, getLastPageEvent, getMetricName, getMetricShortuctNode, getNextPageEvent, getObjectAlias, getOnClickJavaScript, getOperatorName, getPreferenceIntegerReplaceNull, getPrevPageEvent, getRemoveElementsEvent, getRemovePromptEvent, getRestoreStateEvent, getSeparator, getSpecailBeginJavaScriptCall, getToggleAQFormElemsEvent, getToggleOperatorEvent, getToggleQualExprEvent, getTooltipReportObjects, getValidateJavaScript, includeOwnerInfo, includeTimeInfo, initExpressionBeanTransform, initializeCartSettings, initializeCss, isAddWizardRequested, isApplyCancelEnabled, isFilterEmpty, isItemKeptInCartAvailable, isNotDhtml, isObjectInTemplate, isShowObjectTags, isStackedSubexpEnabled, isSubexpressionInError, isViewFilter, isViewReport, newCart, newContext, newFet, renderAddWizard, renderAddWizardButtons, renderAddWizardDropdown, renderAddWizardTransition, renderApplyCancelButtons, renderAQEditMode, renderAQListCart, renderAQListEditMode, renderAQListFirstRow, renderAQOperatorOption, renderAQOperatorOptions, renderAQQualifyAttrForms, renderAQQualifyAttrForms, renderAQQualifyConstantTextbox, renderAQQualifyConstantTextbox, renderAQQualifyEditMode, renderAQQualifyFunctions, renderAQQualifyFunctions, renderAQQualifyUnitComparison, renderCancelButton, renderCloseButton, renderConstantPromptArea, renderDescendantOptions, renderDottedLine, renderDownButton, renderEditorTitle, renderEmptyFilterMessage, renderErrorMessage, renderEventHiddenInputs, renderExpression, renderFilterNode, renderGenericValidationErrorMessage, renderHeader, renderHeaderAddCondition, renderHeaderClearAll, renderHelpButton, renderJavascript, renderMeNodeEditMode, renderMeNodeQualFunctions, renderMeNodeQualOperatorOptions, renderMQConstantTextbox, renderMQEditMode, renderMQFunctions, renderMQOperatorOption, renderMQOperatorOption, renderMQOperatorOptions, renderOperator, renderOperator, renderOperatorEditMode, renderOperatorViewMode, renderPromptButton, renderPromptButton, renderRemoveSubexpressionButton, renderSeparator, renderSpecificValidationErrorMessage, renderSubExpression, renderSubexpressionBodyViewMode, renderSubexpressionBodyViewMode, renderSubExpressionEditMode, renderSubExpressionViewMode, renderTitle, renderUpAndDownButtons, renderUpButton, renderUpButton, setFormName, shallRenderAcceptCancell, shallRenderForm, shouldShowObject, 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, getWebBeanErrorInfo, 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, transformForRequestInError, 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

ViewFilterElementTransform

public ViewFilterElementTransform()

Method Detail

renderUpAndDownButtons

protected void renderUpAndDownButtons(MarkupOutput mainOut,
                                      WebNode node,
                                      boolean isEditableFilterExpr)
                               throws UnmodifiableException,
                                      java.lang.IllegalArgumentException,
                                      java.lang.IllegalStateException

Overrides:

renderUpAndDownButtons in class ExpressionGenericTransform

Throws:

UnmodifiableException

java.lang.IllegalArgumentException

java.lang.IllegalStateException

getMainDivAttributes

public java.util.Map getMainDivAttributes()

Returns the list of attributes to add to the main

that makes up the filter editor GUI. These attributes must primarily be included for the javascript concerning the filter editor to work properly.

Overrides:

getMainDivAttributes in class ExpressionGenericTransform

Returns:

A java.util.Map object whose keys are the attribute names, and the values are the attribute values. Both are String-typed.

renderAcceptButton

protected void renderAcceptButton(MarkupOutput out,
                                  WebEvent acceptEvent,
                                  java.lang.String[] eventArgList,
                                  boolean isDefault)

Overrides:

renderAcceptButton in class ExpressionGenericTransform

getMQAcceptEvent

protected WebEvent getMQAcceptEvent(boolean isMetricExprQual)

Overrides:

getMQAcceptEvent in class ExpressionGenericTransform

getApplyEvent

public WebEvent getApplyEvent()

Description copied from class: ExpressionGenericTransform

Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.

Overrides:

getApplyEvent in class ExpressionGenericTransform

Returns:

The apply event.

renderMoveNodeToViewLimitButton

protected void renderMoveNodeToViewLimitButton(MarkupOutput mainOut,
                                               WebNode node)
                                        throws java.lang.IllegalStateException,
                                               java.lang.IllegalArgumentException,
                                               UnmodifiableException

Throws:

java.lang.IllegalStateException

java.lang.IllegalArgumentException

UnmodifiableException

useBackendDetails

protected boolean useBackendDetails()

Overrides:

useBackendDetails in class FilterElementTransform

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

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.

canFilterOnUnit

protected boolean canFilterOnUnit(WebObjectInfo oi)

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.

initializeCartSettings

protected void initializeCartSettings(Cart cart,
                                      WebEvent acceptEvent,
                                      int elemsBlockBegin,
                                      int elemsBlockCount,
                                      int totalElements,
                                      WebAttribute attr)

Description copied from class: ExpressionGenericTransform

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

Overrides:

initializeCartSettings in class ExpressionGenericTransform

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.