public class

ExpressionFilterTransform

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

Class Overview

Creates consistent text for expressions

Summary

Constants
int FLAT Render mode values
int LINKS
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ExpressionMessages
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractExpressionTransform
Public Constructors
ExpressionFilterTransform()
Default no-args constructor.
Public Methods
String getDescription()
this function returns class description only.
void renderFlatExpression(MarkupOutput transOut, WebNode node)
this function constructs an HTML flat expression text.
void renderLinkedExpression(MarkupOutput transOut, WebNode node)
this function constructs an HTML linked expression text.
void renderSimpleExpression(MarkupOutput transOut, WebNode node)
this function constructs an HTML linked expression text.
void setCancelledPromptCSPAN(String value)
void setDataSests(RWDataSets value)
void setDormantPromptStyle(String style)
void setDormantPromptTitle(String title)
void setEmbeddedFilterSeparator(String value)
this function is intended to set separator character.
void setEmbeddedObjCSPAN(String value)
this function returns is used for setting name of CSPAN to be used in embedded names.
void setEmbeddedPromptJS(String value)
void setExpandEmbeddedFilter(boolean value)
this function returns is used for setting name of CSPAN to be used in operator and right operand in expression text.
void setFormName(String value)
function used for setting name of the form to be rendered.
void setLinkArg(String value)
this function returns is used for setting argument name for link in expression text.
void setLinkCSPAN(String value)
this function returns is used for setting name of CSPAN to be used in right operand in expression text.
void setLinkJS(String value)
this function returns is used for setting javascript used for link in expression text.
void setOperatorCSPAN(String value)
this function returns is used for setting name of CSPAN to be used in operator in expression text.
void setRenderMode(int mode)
this function is intended to set transform style, either flat or linked HTML.
void setSeparator(String value)
this function is intended to set separator character.
void setTruncateText(boolean flag)
Changes flag value for either truncating condition text or not.
void setUnitDescCSPAN(String value)
this function returns is used for setting name of CSPAN to be used in description in expression text.
void setValueCSPAN(String value)
this function returns is used for setting name of CSPAN to be used in operator and right operand in expression text.
void setWhereClauseStr(String value)
this function ris used for setting text for where clause..
Protected Methods
void doTransform(WebNode node, MarkupOutput transOut)
this function checks transform type and triggers corresponding function, either render a flat or HTML linked expression.
void doTransform(MarkupOutput transOut)
this function checks transform type and triggers corresponding function, either render a flat or HTML linked expression.
ExpressionParts newExpressionParts(WebNode node)
Creates a new instance of ExpressionParts object.
[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 FLAT

Render mode values

Constant Value: 1 (0x00000001)

public static final int LINKS

Constant Value: 2 (0x00000002)

Public Constructors

public ExpressionFilterTransform ()

Default no-args constructor. Initializes properties to default values.

Public Methods

public String getDescription ()

this function returns class description only.

Returns
  • String class description.

public void renderFlatExpression (MarkupOutput transOut, WebNode node)

this function constructs an HTML flat expression text. It uses formal parameters for determining styles to be applied to text. These styles define HTML output format.

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

public void renderLinkedExpression (MarkupOutput transOut, WebNode node)

this function constructs an HTML linked expression text. It uses formal parameters for determining styles to be applied to text. These styles define HTML links and HTML output format.

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

public void renderSimpleExpression (MarkupOutput transOut, WebNode node)

this function constructs an HTML linked expression text. It uses formal parameters for determining styles to be applied to text. These styles define HTML links and HTML output format.

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

public void setCancelledPromptCSPAN (String value)

public void setDataSests (RWDataSets value)

public void setDormantPromptStyle (String style)

public void setDormantPromptTitle (String title)

public void setEmbeddedFilterSeparator (String value)

this function is intended to set separator character. If not set, default character will be used.

Parameters
value string to be used as separator.

public void setEmbeddedObjCSPAN (String value)

this function returns is used for setting name of CSPAN to be used in embedded names.

Parameters
value CSPAN name for formatting right operand in embedded names.

public void setEmbeddedPromptJS (String value)

public void setExpandEmbeddedFilter (boolean value)

this function returns is used for setting name of CSPAN to be used in operator and right operand in expression text.

public void setFormName (String value)

function used for setting name of the form to be rendered.

Parameters
value String

public void setLinkArg (String value)

this function returns is used for setting argument name for link in expression text.

Parameters
value argument name for HTML link name.

public void setLinkCSPAN (String value)

this function returns is used for setting name of CSPAN to be used in right operand in expression text.

Parameters
value CSPAN name for formatting right operand in expression text.

public void setLinkJS (String value)

this function returns is used for setting javascript used for link in expression text. This will override the default javascript text.

Parameters
value argument name for HTML link name.

public void setOperatorCSPAN (String value)

this function returns is used for setting name of CSPAN to be used in operator in expression text.

Parameters
value CSPAN name for formatting operator in expression text.

public void setRenderMode (int mode)

this function is intended to set transform style, either flat or linked HTML. If not set, default flat value will be used.

Parameters
mode transform style to be used.

public void setSeparator (String value)

this function is intended to set separator character. If not set, default character will be used.

Parameters
value string to be used as separator.

public void setTruncateText (boolean flag)

Changes flag value for either truncating condition text or not.

Parameters
flag true for truncating text.

public void setUnitDescCSPAN (String value)

this function returns is used for setting name of CSPAN to be used in description in expression text.

Parameters
value CSPAN name for description in expression text.

public void setValueCSPAN (String value)

this function returns is used for setting name of CSPAN to be used in operator and right operand in expression text.

Parameters
value CSPAN name for formatting operator and right operand in expression text.

public void setWhereClauseStr (String value)

this function ris used for setting text for where clause..

Parameters
value where localized text

Protected Methods

protected void doTransform (WebNode node, MarkupOutput transOut)

this function checks transform type and triggers corresponding function, either render a flat or HTML linked expression.

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

protected void doTransform (MarkupOutput transOut)

this function checks transform type and triggers corresponding function, either render a flat or HTML linked expression. This function takes current active node and from there transform takes place

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

protected ExpressionParts newExpressionParts (WebNode node)

Creates a new instance of ExpressionParts object. This implementation creates an istance of ExpressionPartsImpl object. Override this method if you wont to use a custom ExpressionParts implementaion.

Parameters
node where to extract expression parts from
Returns