public interface

FilterDetailsFormatting

com.microstrategy.web.objects.FilterDetailsFormatting

Class Overview

This interface governs filter detail formatting properties.

Summary

Constants
int ALWAYS Always shown/applied.
int CLEAR Clears the formatting attribute.
char DELIMITER
int FALSE Condition is false.
String KEY_EXPAND_SHORTCUT_FILTERS
String KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS
String KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS
String KEY_NEWLINE_ATTR_NAME
String KEY_NEWLINE_BETWEEN_CONDITIONS
String KEY_NEWLINE_BETWEEN_ELEMENTS
String KEY_OPERATOR_NAME_OR_SYMBOL
String KEY_PARENTHESES_AROUND_CONDITIONS
String KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS
String KEY_SHOW_ATTR_NAME_FOR_IN_LIST
String KEY_TRIM_ELEMENTS
String KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES
int MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY Metadata object names are only delimited if the name contains special characters.
int MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND Shows both the name and expansion.
int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY Display logical AND operators only.
int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY Display logical OR operators only.
int MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY Newlines are inserted between conditions for different logical operator nodes only.
int MODE_OPERATOR_DISPLAY_NAME Operators are displayed with their names.
int MODE_OPERATOR_DISPLAY_SYMBOL Operators are displayed using symbols.
int MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY Indicates parentheses are enclosed around conditions that are children of the same logical operator node only.
int NEVER Never shown/applied.
int ONCE Shown/applied once.
int REPEATED Item is repeated.
int TRUE Condition true.
Fields
public static final String DELIMITER_STR
Public Methods
abstract int delimitersAroundMetadataObjectNames()
When to use delimiters around metadata object names.
abstract int expandShortcutFilters()
When to expand shortcut filters.
abstract int includeFormNamesInAQConditions()
Whether to include form names in attribute qualification conditions.
abstract int logicalOperatorBetweenConditions()
When to display logical operators.
abstract int newlineAttrName()
Whether there is a newline after the Attr name.
abstract int newlineBetweenConditions()
When newlines are inserted between conditions.
abstract int newlineBetweenElements()
Default is FALSE.
abstract int operatorDisplay()
Describes how operators are displayed, i.e.
abstract int parenthesesAroundConditions()
When parentheses are displayed around conditions.
abstract void set(String key, String value)
Generic approach to setting a value corresponding to a key instead of using the specific setter method
abstract void setDelimitersAroundMetadataObjectNames(int delimiterCondition)
Governs when to use delimiters around metadata object names.
abstract void setExpandShortcutFilters(int mode)
Governs when to expand shortcut filters.
abstract void setIncludeFormNamesInAttrQualificationConditions(int includeFormNames)
Governs whether to include form names in attribute qualification conditions.
abstract void setLogicalOperatorBetweenConditions(int mode)
Governs when to display logical operators.
abstract void setNewlineAttrName(int mode)
Governs whether there is a newline after the Attr name.
abstract void setNewlineBetweenConditions(int mode)
Governs when newlines are inserted between conditions.
abstract void setNewlineBetweenElements(int mode)
Governs whether there is a newline between elements.
abstract void setOperatorDisplay(int mode)
Governs how operators are displayed, i.e.
abstract void setParenthesesAroundConditions(int mode)
This governs usage of parentheses around conditions.
abstract void setShowAttrNameForElementPrompts(int mode)
Whether to show Attr name for Attr element prompts according to specified argument.
abstract void setShowAttrNameForInList(int mode)
Whether to show Attr name for in list conditions according to specified argument.
abstract void setTrimElements(int mode)
Governs whether whitespaces are trimmed from elements.
abstract int showAttrNameForElementPrompts()
Whether to show Attr element names for Attr element prompts.
abstract int showAttrNameForInList()
Whether to show Attr names for list conditions.
abstract int trimElements()
Whether whitespaces are trimmed from elements.

Constants

public static final int ALWAYS

Always shown/applied. Value = 1.

Constant Value: 1 (0x00000001)

public static final int CLEAR

Clears the formatting attribute. If this is a RWUnit, then the actual format setting will be inherited from the underlying document. If this is a document format, it will be inherited from the project.

Constant Value: -1 (0xffffffff)

public static final char DELIMITER

Constant Value: 44 (0x0000002c)

public static final int FALSE

Condition is false. Value = 0.

Constant Value: 0 (0x00000000)

public static final String KEY_EXPAND_SHORTCUT_FILTERS

Constant Value: "escf"

public static final String KEY_INCLUDE_FORM_NAMES_IN_AQ_CONDITIONS

Constant Value: "iafn"

public static final String KEY_LOGICAL_OPERATOR_BETWEEN_CONDITIONS

Constant Value: "lobc"

public static final String KEY_NEWLINE_ATTR_NAME

Constant Value: "caan"

public static final String KEY_NEWLINE_BETWEEN_CONDITIONS

Constant Value: "cbc"

public static final String KEY_NEWLINE_BETWEEN_ELEMENTS

Constant Value: "cbe"

public static final String KEY_OPERATOR_NAME_OR_SYMBOL

Constant Value: "unso"

public static final String KEY_PARENTHESES_AROUND_CONDITIONS

Constant Value: "pacs"

public static final String KEY_SHOW_ATTR_NAME_FOR_ELEMENT_PROMPTS

Constant Value: "sanep"

public static final String KEY_SHOW_ATTR_NAME_FOR_IN_LIST

Constant Value: "san"

public static final String KEY_TRIM_ELEMENTS

Constant Value: "te"

public static final String KEY_USE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES

Constant Value: "daon"

public static final int MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY

Metadata object names are only delimited if the name contains special characters.

Constant Value: 2 (0x00000002)

public static final int MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND

Shows both the name and expansion.

Constant Value: 2 (0x00000002)

public static final int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY

Display logical AND operators only. Value = 2.

Constant Value: 2 (0x00000002)

public static final int MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY

Display logical OR operators only. Value = 3.

Constant Value: 3 (0x00000003)

public static final int MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY

Newlines are inserted between conditions for different logical operator nodes only. Value = 2.

Constant Value: 2 (0x00000002)

public static final int MODE_OPERATOR_DISPLAY_NAME

Operators are displayed with their names.

Constant Value: 1 (0x00000001)

public static final int MODE_OPERATOR_DISPLAY_SYMBOL

Operators are displayed using symbols.

Constant Value: 0 (0x00000000)

public static final int MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY

Indicates parentheses are enclosed around conditions that are children of the same logical operator node only. Value = 2.

Constant Value: 2 (0x00000002)

public static final int NEVER

Never shown/applied. Value = 0.

Constant Value: 0 (0x00000000)

public static final int ONCE

Shown/applied once. Value = 1.

Constant Value: 1 (0x00000001)

public static final int REPEATED

Item is repeated. Value = 2.

Constant Value: 2 (0x00000002)

public static final int TRUE

Condition true. Value = 1.

Constant Value: 1 (0x00000001)

Fields

public static final String DELIMITER_STR

Public Methods

public abstract int delimitersAroundMetadataObjectNames ()

When to use delimiters around metadata object names.

public abstract int expandShortcutFilters ()

When to expand shortcut filters.

public abstract int includeFormNamesInAQConditions ()

Whether to include form names in attribute qualification conditions.

Returns

public abstract int logicalOperatorBetweenConditions ()

public abstract int newlineAttrName ()

Whether there is a newline after the Attr name. Default is FALSE.

Returns

public abstract int newlineBetweenConditions ()

When newlines are inserted between conditions.

public abstract int newlineBetweenElements ()

Default is FALSE.

Returns

public abstract int operatorDisplay ()

Describes how operators are displayed, i.e. as symbols or names.

public abstract int parenthesesAroundConditions ()

When parentheses are displayed around conditions.

public abstract void set (String key, String value)

Generic approach to setting a value corresponding to a key instead of using the specific setter method

Parameters
key a name from the list enumerated on this interface
value value corresponding to the key

public abstract void setDelimitersAroundMetadataObjectNames (int delimiterCondition)

Governs when to use delimiters around metadata object names.

public abstract void setExpandShortcutFilters (int mode)

Governs when to expand shortcut filters.

public abstract void setIncludeFormNamesInAttrQualificationConditions (int includeFormNames)

Governs whether to include form names in attribute qualification conditions.

Parameters
includeFormNames mode options: TRUE, FALSE, CLEAR

public abstract void setLogicalOperatorBetweenConditions (int mode)

Governs when to display logical operators.

public abstract void setNewlineAttrName (int mode)

Governs whether there is a newline after the Attr name.

Parameters
mode options: TRUE, FALSE, CLEAR

public abstract void setNewlineBetweenConditions (int mode)

Governs when newlines are inserted between conditions.

public abstract void setNewlineBetweenElements (int mode)

Governs whether there is a newline between elements.

Parameters
mode options: TRUE, FALSE, CLEAR

public abstract void setOperatorDisplay (int mode)

Governs how operators are displayed, i.e. as symbols or names.

public abstract void setParenthesesAroundConditions (int mode)

This governs usage of parentheses around conditions.

public abstract void setShowAttrNameForElementPrompts (int mode)

Whether to show Attr name for Attr element prompts according to specified argument.

Parameters
mode options: ONCE, NEVER, REPEATED, CLEAR.

public abstract void setShowAttrNameForInList (int mode)

Whether to show Attr name for in list conditions according to specified argument.

Parameters
mode one of the following: ONCE, NEVER, REPEATED, CLEAR.

public abstract void setTrimElements (int mode)

Governs whether whitespaces are trimmed from elements.

Parameters
mode options: TRUE, FALSE, CLEAR

public abstract int showAttrNameForElementPrompts ()

Whether to show Attr element names for Attr element prompts.

Returns

public abstract int showAttrNameForInList ()

Whether to show Attr names for list conditions.

Returns

public abstract int trimElements ()

Whether whitespaces are trimmed from elements.

Returns