Class FilterDetailsEditorTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
-
- com.microstrategy.web.app.transforms.GuiElementsBlockTransform
-
- com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
-
- com.microstrategy.web.app.transforms.FilterDetailsEditorTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FilterDetailsEditorTransform extends FloatingEditorBlockTransform
This Transform is responsible for reading the FilterDetailsFormatProperties for the Filter Details Editor- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
FP_HELP_TOPIC, helpTopic, helpType, JUIL_COMMAND_PARTS_DELIMITER, JUIL_COMMAND_SEPARATOR
-
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 FilterDetailsEditorTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
attribFormNameInAQConditions()
Returns the property value whether to Include Attribute form names in Attribute Qualification conditions.boolean
canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.java.lang.String
carriageReturnAfterAttribName()
Returns the property value whether to use a new line after attribute name and its in list elements.java.lang.String
carriageReturnAfterSubExpressionName()
Returns the property value whether to include a new line after the filter type name.java.lang.String
carriageReturnBetweenConditions()
Returns the property value whether to show new lines around conditions.java.lang.String
carriageReturnBetweenElements()
Returns the property value whether to use new line between elements in the in list condition.java.lang.String
carriageReturnBetweenSubExpressions()
Returns the property value whether to show a new line between filter types.java.lang.String
customSeparator()
Returns the property value for the the custom separator if used between the last two elements in the in list condition.java.lang.String
dynamicDates()
Returns the property value whether to show Dynamic Dates as dates or expressions.java.lang.String
expandShortcutFilters()
Returns the property value which enables shortcut filters to show the actual condition or just the filter name.java.lang.String
getDescription()
Returns a textual description of the transform.java.lang.String
getObjectId()
Returns the object id as retrieved from the request keys.java.lang.String
getProperty()
Returns the property in string format.java.lang.String
includeBaseTemplateName()
Returns the property value whether to include the Base template name in the Report Details.java.lang.String
includeConditionality()
Returns the property value whether to include the conditionality of metrics in the Report Details.java.lang.String
includeConditionalMetricsOnly()
Returns the property value whether to include the conditional metrics only in the Report Details.java.lang.String
includeDimensionality()
Returns the property value whether to include the dimensionality of metrics in the Report Details.java.lang.String
includeFilterDetails()
Method returns the property value for the "Filter Details" section to be included in the Filter Details Editorjava.lang.String
includeFormula()
Returns the property value whether to include the formula of metrics in the Report Details.java.lang.String
includeMetricQualInViewFilter()
Returns the property value whether to include Metric Qualification in View Filters.java.lang.String
includeMetrics()
Returns the property value whether to include Metrics in the Report Details.java.lang.String
includeNonMetricTemplateUnits()
Returns the property value whether to include Non-metric template units in the Report Details.java.lang.String
includePromptDetails()
Method returns the property value for the "Prompt Details" section to be included in the Filter Details Editorjava.lang.String
includePromptTitles()
Returns the property value whether Prompt Titles will be included in the Prompt Details.java.lang.String
includeReportDescription()
Method returns the property value for the "Report Description" section to be included in the Filter Details Editorjava.lang.String
includeReportFilter()
Returns the property value whether to include "Report Filter" section in the Filter Details.java.lang.String
includeReportFilterDesc()
Returns the property value whether to include the Report Filter's Description.java.lang.String
includeReportLimits()
Returns the property value whether to include Report Limits.java.lang.String
includeSecurityFilter()
Returns the property value whether to include Security Filter.java.lang.String
includeSubExpressionName()
Returns the property value whether to include filter type name.java.lang.String
includeTemplateDesc()
Returns the property value whether to include the Template description in the Report Details.java.lang.String
includeTemplateDetails()
Method returns the property value for the "Template Details" section to be included in the Filter Details Editorjava.lang.String
includeTransformation()
Returns the property value whether to include the transformation of metrics in the Report Details.java.lang.String
includeUnusedPrompts()
Returns the property value whether to include unused prompts.java.lang.String
includeUserFilter()
Returns the property value whether to include User Filter.java.lang.String
includeViewFilter()
Returns the property value whether to include View Filters in the Filter Details contents.void
initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform, such as width and height.boolean
isRWD()
Returns whether the Editor is opened in the Report Page or the RWD page.java.lang.String
logicalOperatorBetweenConditions()
Returns the property value whether to show Logical operator between conditions.java.lang.String
mdDelimeter()
Returns the property value whether to use delimiters around report object names.java.lang.String
parenthesesAroundConditions()
Returns the property value whether to show parentheses around conditions.java.lang.String
replacementPromptString()
Returns the property value for which string would be replaced for unanswered prompts.java.lang.String
reportFilterName()
Returns the property value whether to include the report filter's name.java.lang.String
separatorAfterAttribName()
Returns the property value for the the separator used between the attribute name and its in list values.java.lang.String
separatorBetweenLastTwo()
Returns the property value for the separator between last two elements in the in list conditions.java.lang.String
showAttribNameForAEPrompts()
Returns the property value for the options to show the attribute name for Attribute Element Prompts.java.lang.String
showAttribNameInListConditions()
Returns the property value whether to show attribute name for in list conditions.java.lang.String
showEmptyExpressions()
Returns the property value to show empty filter expressions.java.lang.String
spacing()
Returns the property value whether to show a spacing of one line or two lines.java.lang.String
subExpressionOrder()
Returns the property value for how to show the report limits (before or after the view filter).boolean
supports(Transformable data)
Returns true if the transform supports the specified data object.boolean
supports(java.lang.Class type)
Returns true if the transform supports objects of specified type.java.lang.String
trimElements()
Returns the property value to trim spaces in element values.java.lang.String
unitsFromViewOrBase()
Returns the property value whether to show units from the base template or the view template.java.lang.String
useAliasesInFilterDetails()
Returns the property value whether to use aliases in Filter Details.java.lang.String
useSymbolsForOperators()
Returns the property value to use either symbols for operators in qualification conditions.-
Methods inherited from class com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
convertUnit, generateJUILCommand, getDPI, getHelpPath, getHelpTopic, getLocaleInfo, getUnitsPreferenceValue, getUserPreferences, getWebIServerSession
-
Methods inherited from class com.microstrategy.web.app.transforms.GuiElementsBlockTransform
getAutoStyles, getElementID, getElementName, getListAttribute, getPicker, getPickerList, getRequestKeyValue, getRequestParameterValue, getRequestParameterValueEncoded, getShortcutDescriptor, isFeatureAvailable, removeListItems
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
buildFlattenedExpression, getAttForms, getChildWidget, getChildWidget, getCssName, getIserverNodeFunction, getObjectInfoCssName, getPreferenceValueReplaceNull, getSelf, includeAncestorInfo, includeFolderInfo, includeOwnerInfo, includeTimeInfo, insertChildren, inTreeStructure, isNull, isShowObjectTags, renderShell, renderTest, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, 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, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated
-
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
getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, transform
-
-
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransform
This method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent
,initializeImages
andinitializeCss
methods.transform
method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- the bean to transform.
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Transform
Returns a textual description of the transform.- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classFloatingEditorBlockTransform
- Returns:
- The textual description of the transform.
-
getProperty
public java.lang.String getProperty()
Returns the property in string format.
-
getObjectId
public java.lang.String getObjectId()
Returns the object id as retrieved from the request keys.
-
includeReportDescription
public java.lang.String includeReportDescription()
Method returns the property value for the "Report Description" section to be included in the Filter Details Editor
-
includePromptDetails
public java.lang.String includePromptDetails()
Method returns the property value for the "Prompt Details" section to be included in the Filter Details Editor
-
includeFilterDetails
public java.lang.String includeFilterDetails()
Method returns the property value for the "Filter Details" section to be included in the Filter Details Editor
-
includeTemplateDetails
public java.lang.String includeTemplateDetails()
Method returns the property value for the "Template Details" section to be included in the Filter Details Editor
-
includePromptTitles
public java.lang.String includePromptTitles()
Returns the property value whether Prompt Titles will be included in the Prompt Details. Refers to the "Include Prompt Titles" property.
-
replacementPromptString
public java.lang.String replacementPromptString()
Returns the property value for which string would be replaced for unanswered prompts. Refers to the "Replacement string for unanswered prompts"
-
showAttribNameForAEPrompts
public java.lang.String showAttribNameForAEPrompts()
Returns the property value for the options to show the attribute name for Attribute Element Prompts. Refers to the "Show attribute name for Attribute Element Prompts" property.
-
includeUnusedPrompts
public java.lang.String includeUnusedPrompts()
Returns the property value whether to include unused prompts. Refers to the "Include unused prompts" property
-
mdDelimeter
public java.lang.String mdDelimeter()
Returns the property value whether to use delimiters around report object names. Refers to the "Use delimiters around report object names" property.
-
includeReportFilter
public java.lang.String includeReportFilter()
Returns the property value whether to include "Report Filter" section in the Filter Details.
-
reportFilterName
public java.lang.String reportFilterName()
Returns the property value whether to include the report filter's name. Refers to the "Report Filter Name" property.
-
includeReportFilterDesc
public java.lang.String includeReportFilterDesc()
Returns the property value whether to include the Report Filter's Description. Refers to the "Report Filter Description" property.
-
includeViewFilter
public java.lang.String includeViewFilter()
Returns the property value whether to include View Filters in the Filter Details contents.
-
includeMetricQualInViewFilter
public java.lang.String includeMetricQualInViewFilter()
Returns the property value whether to include Metric Qualification in View Filters.
-
includeReportLimits
public java.lang.String includeReportLimits()
Returns the property value whether to include Report Limits.
-
includeUserFilter
public java.lang.String includeUserFilter()
Returns the property value whether to include User Filter.
-
includeSecurityFilter
public java.lang.String includeSecurityFilter()
Returns the property value whether to include Security Filter.
-
includeSubExpressionName
public java.lang.String includeSubExpressionName()
Returns the property value whether to include filter type name.
-
showEmptyExpressions
public java.lang.String showEmptyExpressions()
Returns the property value to show empty filter expressions. Refers to the "Show empty expressions" property
-
subExpressionOrder
public java.lang.String subExpressionOrder()
Returns the property value for how to show the report limits (before or after the view filter). Refers to the "Show Report Limits" property.
-
carriageReturnAfterSubExpressionName
public java.lang.String carriageReturnAfterSubExpressionName()
Returns the property value whether to include a new line after the filter type name.
-
carriageReturnBetweenSubExpressions
public java.lang.String carriageReturnBetweenSubExpressions()
Returns the property value whether to show a new line between filter types.
-
expandShortcutFilters
public java.lang.String expandShortcutFilters()
Returns the property value which enables shortcut filters to show the actual condition or just the filter name. Refers to the "Expand Shortcut Filters" property.
-
useAliasesInFilterDetails
public java.lang.String useAliasesInFilterDetails()
Returns the property value whether to use aliases in Filter Details.
-
showAttribNameInListConditions
public java.lang.String showAttribNameInListConditions()
Returns the property value whether to show attribute name for in list conditions.
-
separatorAfterAttribName
public java.lang.String separatorAfterAttribName()
Returns the property value for the the separator used between the attribute name and its in list values.
-
carriageReturnAfterAttribName
public java.lang.String carriageReturnAfterAttribName()
Returns the property value whether to use a new line after attribute name and its in list elements.
-
separatorBetweenLastTwo
public java.lang.String separatorBetweenLastTwo()
Returns the property value for the separator between last two elements in the in list conditions. Refers to "Separator between last two elements" property.
-
customSeparator
public java.lang.String customSeparator()
Returns the property value for the the custom separator if used between the last two elements in the in list condition.
-
carriageReturnBetweenElements
public java.lang.String carriageReturnBetweenElements()
Returns the property value whether to use new line between elements in the in list condition.
-
trimElements
public java.lang.String trimElements()
Returns the property value to trim spaces in element values.
-
useSymbolsForOperators
public java.lang.String useSymbolsForOperators()
Returns the property value to use either symbols for operators in qualification conditions.
-
attribFormNameInAQConditions
public java.lang.String attribFormNameInAQConditions()
Returns the property value whether to Include Attribute form names in Attribute Qualification conditions.
-
dynamicDates
public java.lang.String dynamicDates()
Returns the property value whether to show Dynamic Dates as dates or expressions.
-
parenthesesAroundConditions
public java.lang.String parenthesesAroundConditions()
Returns the property value whether to show parentheses around conditions.
-
carriageReturnBetweenConditions
public java.lang.String carriageReturnBetweenConditions()
Returns the property value whether to show new lines around conditions.
-
spacing
public java.lang.String spacing()
Returns the property value whether to show a spacing of one line or two lines.
-
logicalOperatorBetweenConditions
public java.lang.String logicalOperatorBetweenConditions()
Returns the property value whether to show Logical operator between conditions.
-
unitsFromViewOrBase
public java.lang.String unitsFromViewOrBase()
Returns the property value whether to show units from the base template or the view template.
-
includeBaseTemplateName
public java.lang.String includeBaseTemplateName()
Returns the property value whether to include the Base template name in the Report Details.
-
includeTemplateDesc
public java.lang.String includeTemplateDesc()
Returns the property value whether to include the Template description in the Report Details.
-
includeNonMetricTemplateUnits
public java.lang.String includeNonMetricTemplateUnits()
Returns the property value whether to include Non-metric template units in the Report Details.
-
includeMetrics
public java.lang.String includeMetrics()
Returns the property value whether to include Metrics in the Report Details.
-
includeDimensionality
public java.lang.String includeDimensionality()
Returns the property value whether to include the dimensionality of metrics in the Report Details.
-
includeTransformation
public java.lang.String includeTransformation()
Returns the property value whether to include the transformation of metrics in the Report Details.
-
includeFormula
public java.lang.String includeFormula()
Returns the property value whether to include the formula of metrics in the Report Details.
-
includeConditionality
public java.lang.String includeConditionality()
Returns the property value whether to include the conditionality of metrics in the Report Details.
-
includeConditionalMetricsOnly
public java.lang.String includeConditionalMetricsOnly()
Returns the property value whether to include the conditional metrics only in the Report Details.
-
canTransform
public boolean canTransform(Transformable data)
Description copied from interface:Transform
Checks that the transform supports specified data object and that object is in the state supported by this transform.- Specified by:
canTransform
in interfaceTransform
- Overrides:
canTransform
in classAbstractTransform
- Returns:
- true if the transform supports specified data object and the object is in the state supported by this transform.
-
supports
public boolean supports(java.lang.Class type)
Description copied from interface:Transform
Returns true if the transform supports objects of specified type.- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
type
- the Java Class object representing bean type.- Returns:
- true if the transform supports objects of specified type.
-
supports
public boolean supports(Transformable data)
Description copied from interface:Transform
Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
data
- a transformable object- Returns:
- true if the transform supports the data object, false otherwise.
- See Also:
Transform.canTransform(com.microstrategy.web.beans.Transformable)
-
isRWD
public boolean isRWD()
Returns whether the Editor is opened in the Report Page or the RWD page.
-
-