public class

FilterDetailsEditorTransform

extends FloatingEditorBlockTransform
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

Class Overview

This Transform is responsible for reading the FilterDetailsFormatProperties for the Filter Details Editor

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FilterDetailsEditorTransform()
Public Methods
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.
String carriageReturnAfterAttribName()
Returns the property value whether to use a new line after attribute name and its in list elements.
String carriageReturnAfterSubExpressionName()
Returns the property value whether to include a new line after the filter type name.
String carriageReturnBetweenConditions()
Returns the property value whether to show new lines around conditions.
String carriageReturnBetweenElements()
Returns the property value whether to use new line between elements in the in list condition.
String carriageReturnBetweenSubExpressions()
Returns the property value whether to show a new line between filter types.
String customSeparator()
Returns the property value for the the custom separator if used between the last two elements in the in list condition.
String dynamicDates()
Returns the property value whether to show Dynamic Dates as dates or expressions.
String expandShortcutFilters()
Returns the property value which enables shortcut filters to show the actual condition or just the filter name.
String getDescription()
String getObjectId()
Returns the object id as retrieved from the request keys.
String getProperty()
Returns the property in string format.
String includeBaseTemplateName()
Returns the property value whether to include the Base template name in the Report Details.
String includeConditionalMetricsOnly()
Returns the property value whether to include the conditional metrics only in the Report Details.
String includeConditionality()
Returns the property value whether to include the conditionality of metrics in the Report Details.
String includeDimensionality()
Returns the property value whether to include the dimensionality of metrics in the Report Details.
String includeFilterDetails()
Method returns the property value for the "Filter Details" section to be included in the Filter Details Editor
String includeFormula()
Returns the property value whether to include the formula of metrics in the Report Details.
String includeMetricQualInViewFilter()
Returns the property value whether to include Metric Qualification in View Filters.
String includeMetrics()
Returns the property value whether to include Metrics in the Report Details.
String includeNonMetricTemplateUnits()
Returns the property value whether to include Non-metric template units in the Report Details.
String includePromptDetails()
Method returns the property value for the "Prompt Details" section to be included in the Filter Details Editor
String includePromptTitles()
Returns the property value whether Prompt Titles will be included in the Prompt Details.
String includeReportDescription()
Method returns the property value for the "Report Description" section to be included in the Filter Details Editor
String includeReportFilter()
Returns the property value whether to include "Report Filter" section in the Filter Details.
String includeReportFilterDesc()
Returns the property value whether to include the Report Filter's Description.
String includeReportLimits()
Returns the property value whether to include Report Limits.
String includeSecurityFilter()
Returns the property value whether to include Security Filter.
String includeSubExpressionName()
Returns the property value whether to include filter type name.
String includeTemplateDesc()
Returns the property value whether to include the Template description in the Report Details.
String includeTemplateDetails()
Method returns the property value for the "Template Details" section to be included in the Filter Details Editor
String includeTransformation()
Returns the property value whether to include the transformation of metrics in the Report Details.
String includeUnusedPrompts()
Returns the property value whether to include unused prompts.
String includeUserFilter()
Returns the property value whether to include User Filter.
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.
String logicalOperatorBetweenConditions()
Returns the property value whether to show Logical operator between conditions.
String mdDelimeter()
Returns the property value whether to use delimiters around report object names.
String parenthesesAroundConditions()
Returns the property value whether to show parentheses around conditions.
String replacementPromptString()
Returns the property value for which string would be replaced for unanswered prompts.
String reportFilterName()
Returns the property value whether to include the report filter's name.
String separatorAfterAttribName()
Returns the property value for the the separator used between the attribute name and its in list values.
String separatorBetweenLastTwo()
Returns the property value for the separator between last two elements in the in list conditions.
String showAttribNameForAEPrompts()
Returns the property value for the options to show the attribute name for Attribute Element Prompts.
String showAttribNameInListConditions()
Returns the property value whether to show attribute name for in list conditions.
String showEmptyExpressions()
Returns the property value to show empty filter expressions.
String spacing()
Returns the property value whether to show a spacing of one line or two lines.
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(Class type)
Returns true if the transform supports objects of specified type.
String trimElements()
Returns the property value to trim spaces in element values.
String unitsFromViewOrBase()
Returns the property value whether to show units from the base template or the view template.
String useAliasesInFilterDetails()
Returns the property value whether to use aliases in Filter Details.
String useSymbolsForOperators()
Returns the property value to use either symbols for operators in qualification conditions.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FloatingEditorBlockTransform
From class com.microstrategy.web.app.transforms.GuiElementsBlockTransform
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
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 FilterDetailsEditorTransform ()

Public Methods

public String attribFormNameInAQConditions ()

Returns the property value whether to Include Attribute form names in Attribute Qualification conditions.

public boolean canTransform (Transformable data)

Checks that the transform supports specified data object and that object is in the state supported by this transform.

Returns
  • true if the transform supports specified data object and the object is in the state supported by this transform.

public String carriageReturnAfterAttribName ()

Returns the property value whether to use a new line after attribute name and its in list elements.

public String carriageReturnAfterSubExpressionName ()

Returns the property value whether to include a new line after the filter type name.

public String carriageReturnBetweenConditions ()

Returns the property value whether to show new lines around conditions.

public String carriageReturnBetweenElements ()

Returns the property value whether to use new line between elements in the in list condition.

public String carriageReturnBetweenSubExpressions ()

Returns the property value whether to show a new line between filter types.

public String customSeparator ()

Returns the property value for the the custom separator if used between the last two elements in the in list condition.

public String dynamicDates ()

Returns the property value whether to show Dynamic Dates as dates or expressions.

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

public String getDescription ()

public String getObjectId ()

Returns the object id as retrieved from the request keys.

public String getProperty ()

Returns the property in string format.

public String includeBaseTemplateName ()

Returns the property value whether to include the Base template name in the Report Details.

public String includeConditionalMetricsOnly ()

Returns the property value whether to include the conditional metrics only in the Report Details.

public String includeConditionality ()

Returns the property value whether to include the conditionality of metrics in the Report Details.

public String includeDimensionality ()

Returns the property value whether to include the dimensionality of metrics in the Report Details.

public String includeFilterDetails ()

Method returns the property value for the "Filter Details" section to be included in the Filter Details Editor

public String includeFormula ()

Returns the property value whether to include the formula of metrics in the Report Details.

public String includeMetricQualInViewFilter ()

Returns the property value whether to include Metric Qualification in View Filters.

public String includeMetrics ()

Returns the property value whether to include Metrics in the Report Details.

public String includeNonMetricTemplateUnits ()

Returns the property value whether to include Non-metric template units in the Report Details.

public String includePromptDetails ()

Method returns the property value for the "Prompt Details" section to be included in the Filter Details Editor

public String includePromptTitles ()

Returns the property value whether Prompt Titles will be included in the Prompt Details. Refers to the "Include Prompt Titles" property.

public String includeReportDescription ()

Method returns the property value for the "Report Description" section to be included in the Filter Details Editor

public String includeReportFilter ()

Returns the property value whether to include "Report Filter" section in the Filter Details.

public String includeReportFilterDesc ()

Returns the property value whether to include the Report Filter's Description. Refers to the "Report Filter Description" property.

public String includeReportLimits ()

Returns the property value whether to include Report Limits.

public String includeSecurityFilter ()

Returns the property value whether to include Security Filter.

public String includeSubExpressionName ()

Returns the property value whether to include filter type name.

public String includeTemplateDesc ()

Returns the property value whether to include the Template description in the Report Details.

public String includeTemplateDetails ()

Method returns the property value for the "Template Details" section to be included in the Filter Details Editor

public String includeTransformation ()

Returns the property value whether to include the transformation of metrics in the Report Details.

public String includeUnusedPrompts ()

Returns the property value whether to include unused prompts. Refers to the "Include unused prompts" property

public String includeUserFilter ()

Returns the property value whether to include User Filter.

public String includeViewFilter ()

Returns the property value whether to include View Filters in the Filter Details contents.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the 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.

Parameters
data the bean to transform.

public boolean isRWD ()

Returns whether the Editor is opened in the Report Page or the RWD page.

public String logicalOperatorBetweenConditions ()

Returns the property value whether to show Logical operator between conditions.

public String mdDelimeter ()

Returns the property value whether to use delimiters around report object names. Refers to the "Use delimiters around report object names" property.

public String parenthesesAroundConditions ()

Returns the property value whether to show parentheses around conditions.

public String replacementPromptString ()

Returns the property value for which string would be replaced for unanswered prompts. Refers to the "Replacement string for unanswered prompts"

public String reportFilterName ()

Returns the property value whether to include the report filter's name. Refers to the "Report Filter Name" property.

public String separatorAfterAttribName ()

Returns the property value for the the separator used between the attribute name and its in list values.

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

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

public String showAttribNameInListConditions ()

Returns the property value whether to show attribute name for in list conditions.

public String showEmptyExpressions ()

Returns the property value to show empty filter expressions. Refers to the "Show empty expressions" property

public String spacing ()

Returns the property value whether to show a spacing of one line or two lines.

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

public boolean supports (Transformable data)

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.

Parameters
data a transformable object
Returns
  • true if the transform supports the data object, false otherwise.

public boolean supports (Class type)

Returns true if the transform supports objects of specified type.

Parameters
type the Java Class object representing bean type.
Returns
  • true if the transform supports objects of specified type.

public String trimElements ()

Returns the property value to trim spaces in element values.

public String unitsFromViewOrBase ()

Returns the property value whether to show units from the base template or the view template.

public String useAliasesInFilterDetails ()

Returns the property value whether to use aliases in Filter Details.

public String useSymbolsForOperators ()

Returns the property value to use either symbols for operators in qualification conditions.