public class

PromptExpressionTransform

extends AbstractExpressionTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.app.transforms.AbstractExpressionTransform
       ↳ com.microstrategy.web.app.transforms.PromptExpressionTransform

Class Overview

This transform is meant to be used by Expression and Hierarchical prompts through CartExpression class. Pretty much, it parses current active node and renders HTML option element. It uses Expression transforms for getting sub expression output and it parses active node for constructing HTML and DHTML option values.

Summary

Constants
int DHTML Denotes a constant indicating DHTML mode.
int HTML Denotes a constant indicating HTML mode.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ExpressionMessages
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractExpressionTransform
Public Constructors
PromptExpressionTransform()
Default no-args constructor, initialize all the formal parameters.
Public Methods
String getDescription()
Indicates class description.
void setExcludeForNOTNodes(boolean flag)
Specifies whether or not to add exclude for Nodes with NOT as parent Node.
void setExpressionValueSeparator(String value)
Specifies separator character for Expression answer.
void setIncludeExtraSelectedInfo(boolean flag)
Specifies whether or not to include extra HTML properties to option in Selected list.
void setPrependEmptySpaces(boolean flag)
Specifies whether or not to prepend empty spaces on the display portion.
void setRenderMode(int mode)
Specifies current render mode.
void setTruncateMode(boolean flag)
Specifies whether or not to truncate expression value output to custom size of characters.
void setTruncateSize(int size)
Specifies lenght of expression value to be displayed.
Protected Methods
void doTransform(MarkupOutput transOut)
Executes transform logic on Prompt object.
void doTransform(WebNode activeNode, MarkupOutput transOut)
Executes transform logic on Prompt object.
String getDescriptor(int key)
Indicates localized descriptor associated to given key or Id.
String getDimensionalityInfo(WebNode node)
Indicates current expression prompt dimensionality type.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractExpressionTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Constants

public static final int DHTML

Denotes a constant indicating DHTML mode.

Constant Value: 1 (0x00000001)

public static final int HTML

Denotes a constant indicating HTML mode.

Constant Value: 2 (0x00000002)

Public Constructors

public PromptExpressionTransform ()

Default no-args constructor, initialize all the formal parameters.

Public Methods

public String getDescription ()

Indicates class description.

Returns
  • description string.

public void setExcludeForNOTNodes (boolean flag)

Specifies whether or not to add exclude for Nodes with NOT as parent Node.

Parameters
flag boolean true to add extra HTML.

public void setExpressionValueSeparator (String value)

Specifies separator character for Expression answer.
For those expressions whose answer is consisted of multiple values, a custom separator might be specified.

Parameters
value String new separator.

public void setIncludeExtraSelectedInfo (boolean flag)

Specifies whether or not to include extra HTML properties to option in Selected list.

Parameters
flag boolean true to add extra HTML.

public void setPrependEmptySpaces (boolean flag)

Specifies whether or not to prepend empty spaces on the display portion.

Parameters
flag boolean true to add empty spaces.

public void setRenderMode (int mode)

Specifies current render mode.
Intended to set transform style, either flat HTML or linked DHTML.

Parameters
mode transform style to be used .

public void setTruncateMode (boolean flag)

Specifies whether or not to truncate expression value output to custom size of characters.

Parameters
flag true if truncate should be performed.

public void setTruncateSize (int size)

Specifies lenght of expression value to be displayed.
This property goes along with truncate mode which needs to be enabled in order to truncate value to be displayed. Size is defined by this property.

Parameters
size int value indicating size for truncated strings.

Protected Methods

protected void doTransform (MarkupOutput transOut)

Executes transform logic on Prompt object.
It checks whether there's an active node and starts processing from there. If there isn't active node, then by default it points to root node.

Parameters
transOut MarkupOutput instance that will be the output by this transform

protected void doTransform (WebNode activeNode, MarkupOutput transOut)

Executes transform logic on Prompt object.
Generates HTML option for cart expression prompt.

Parameters
activeNode node where transform will be applied to
transOut MarkupOutput instance that will be the output by this transform

protected String getDescriptor (int key)

Indicates localized descriptor associated to given key or Id.

Parameters
key unique descriptor id.
Returns
  • descriptor localized string.

protected String getDimensionalityInfo (WebNode node)

Indicates current expression prompt dimensionality type.
Based on dimty unit data type, a String gets returned with formatted dimensionality information.

Parameters
node WebNode instance, likely to be a dimty node.
Returns
  • String formatted text with dimensionality info.