public class

PromptExpressionCartTransform

extends PromptCartTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
			↳	com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
				↳	com.microstrategy.web.app.transforms.PromptCartTransform
					↳	com.microstrategy.web.app.transforms.PromptExpressionCartTransform

Known Direct Subclasses

PromptHierarchicalCartTransform

Known Indirect Subclasses

PromptHierarchicalTreeTransform

This class is deprecated.
Use PromptExpressionCartXHTMLTransform instead

Class Overview

Renders Expression prompt in "shopping cart" style. This transforms makes use of Tag instances to render HTML output. See reference to TagsFactory.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.beans.EnumPromptsBeanEvents

Fields
public FormalParameter	_dottedArrowImg	Image for dotted line to be used as graphical separator.
protected String	_dottedArrowImgName
public FormalParameter	logicalOperatorAvailableUserDefined	Specifies a custome boolean value indicating whether or not to displaye logical operators.
public FormalParameter	logicalOperatorDefault	Specifies 'And/Or' match case default value.
public FormalParameter	logicalOperatorSelectionMethod	Specifies whether the 'And/Or' match case checkbox is displayed or not next the selected list in cart style ouput.

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.PromptCartTransform

From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform

From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform

protected int	_blockCount	Denotes generic block count.
protected GGCalendar	_calendar	Represents calendar object.
protected String	_cssPrefix	Property for storing the value of the `cssPrefix` formal parameter, initialized with the `initializeCss` method.
protected int	_dataTypeForCalendar	Specifies data type for calendar.
protected String	_globalCss	Specifies CSS class of the main HTML container tag of the prompt information.
protected String	_imagesFolder	Indicates images folder path.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	imgBackToTop	This field is deprecated. This formal parameter is no longer used. There are no references to this formal parameter in the code
public FormalParameter	imgCalendar	Specifies image to use when Calendar object is enabled and visible.
public FormalParameter	imgError	Specifies the image to use to highlight an error in a prompt.
protected boolean	isDhtmlMode	Indicates whether or not DHTML mode is enabled.
public FormalParameter	levelFlag	Specifies what fields in prompt question are displayed.
public FormalParameter	showRequired	Specifies whether or not to display 'Required' message at the end of prompt title.

Public Constructors
	PromptExpressionCartTransform() Default no-args constructor, initialize all the formal parameters as Parent class has defined.

Public Methods
boolean	canTransform(Transformable data) Indicates whether or not given component, denoted by data, can be processed by this transform.
String	getDescription() Indicates this transforms description.
void	initializeCart() Initializes Cart properties to default values.
void	initializeImages() Initializes the images for this transform.
boolean	isAnswerComplex() Indicates whether or not current prompt answer is complex.
void	renderCart(MarkupOutput out) Renders an HTML shopping cart.
void	renderInputTextFile(MarkupOutput out) Renders HTML for input text file.
void	renderPromptContent(MarkupOutput out) Renders the prompt's content Question area.

Protected Methods
boolean	checkLogicalOperatorMethod(int iConst) Indicates if the logicalOperatorSelectionMethod parameter value contains this flag.
WebExpression	getAnswer() Returns Expression prompt answer.
Cart	getCart() Indicates an instance of a Cart object.
CartExpression	getCartExpression() Indicates an instance of CartExpression object.
Enumeration	getSelectedItems() Returns Expression prompt answer in an Enumeration instance.
void	processAvailableItems() Initializes the available units display list.
void	processIncrementalFetch() Initializes incremental fetching settings for Available list.
void	processSelectedItems() Initializes Selected list in Expression Prompt.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.PromptCartTransform

boolean	areThereAvailableSelections() Indicates whether or not there is a least one item in available collection, Verifies size of available selections is greater than zero.
boolean	canTransform(Transformable data) Indicates whether or not this given transform can be used to transform given component.
Enumeration	getAvailableItems() Returns all available items encapsulated in Enumeration class.
Cart	getCart() Returns active cart instance.
String	getDescription() Returns a description of this transform.
String	getErrorMessage(WebBeanError promptError) Returns a localized error message.
String	getSearchPattern() Returns search pattern text defined in Prompt Object.
Enumeration	getSelectedItems() Returns an enumeration of all selected items.
void	initializeCart() Initializes all Cart properties to default values.
void	initializeFormalParameters() Initialize formal parameters.
void	initializeImages() Initializes the images for this transform.
void	initializePromptContent() Initializes prompt's content.
boolean	isAnswerComplex() Determines if the answer can be rendered in the GUI.
boolean	isIncrementalFetchAvailable() Indicates whether or not, incremental fetch feature is available.
boolean	isSearchActive() Indicates whether a search patter was entered or not.
boolean	isSearchPossible(WebDisplayUnit unit) Indicates whether or not it's possible to filter elements based on the display unit object.
void	processSelectedItems() Initialize selected items list.
void	renderCart(MarkupOutput out) Renders shopping's cart area.
void	renderPromptContent(MarkupOutput out) Renders layout where prompt's content will displayed.
void	setExtraArguments() Specifies extra arguments for this prompt.
void	updateIncrementalFetchCartProperties() Updates incremental fetch properties in Cart object.

From class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform

String	getDimtyAsString() Returns the dimensionality of a metric qualification as a string.
String	getDimtyAttributesAsString() Returns the dimensionality of a metric qualification as a string.
int	getOutputLevel() Returns the output level of the prompt if it is a metric qualification prompt
boolean	isBrowserIE6() Utility method that checks if the browser is IE 6.0 version or higher.
boolean	isCart()
boolean	isMQLevelEditingSupported() Indicates whether or not metric qualification level editing is supported or not.
boolean	isNodeComplex(WebNode node) This method is deprecated. This method has been deprecated since this is specific to expression prompts. Use the method on AbstractPromptExpressionTransform.
boolean	isNodeDimtyEmpty(WebNode node) Indicates whether or not node parameter has dimensionality.
void	renderHiddenInputsForMQEditor(MarkupOutput out) Renders hidden inputs used in the MQLevel Editor.
void	renderOutputLevelLabel(MarkupOutput out) Renders label for output level button.
void	renderPromptHiddenInputs(MarkupOutput out) Renders all hidden inputs of this prompt.
void	setExtraArguments() Sets extra arguments and properties for this prompt.
void	setMetricQualOutputLevelAndDimty() Determines the output level and dimensionality for current prompt being processed.

From class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

From class java.lang.Object

From interface com.microstrategy.web.transform.Transform

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Fields

public FormalParameter _dottedArrowImg

Image for dotted line to be used as graphical separator.

protected String _dottedArrowImgName

public FormalParameter logicalOperatorAvailableUserDefined

Specifies a custome boolean value indicating whether or not to displaye logical operators.

public FormalParameter logicalOperatorDefault

Specifies 'And/Or' match case default value.

public FormalParameter logicalOperatorSelectionMethod

Specifies whether the 'And/Or' match case checkbox is displayed or not next the selected list in cart style ouput.

Public Constructors

public PromptExpressionCartTransform ()

Default no-args constructor, initialize all the formal parameters as Parent class has defined.

Public Methods

public boolean canTransform (Transformable data)

Indicates whether or not given component, denoted by data, can be processed by this transform.
Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeExpression

Parameters

data	object (PromptObject) to transform

Returns

true if the data is a PromptObject of a Expression WebPrompt.

public String getDescription ()

Indicates this transforms description.

Returns

the description of a shopping cart.

public void initializeCart ()

Initializes Cart properties to default values.
It invokes parent method so all shared properties get initialized first and immediately after this invokation, only expression cart specific properties get initialized.

public void initializeImages ()

Initializes the images for this transform.
It also invokes parent method to initialized all shared images.

public boolean isAnswerComplex ()

Indicates whether or not current prompt answer is complex.
An Expression prompt answer is considered complex if it is consisted of nested sub expression which can't be rendered in a HTML select list. Also, if root node of WebExpression isn't either an OR/AND logical operator.

Returns

true if answer is complex

public void renderCart (MarkupOutput out)

Renders an HTML shopping cart.

Parameters

out	`MarkupOutput` where to write the output of the method.

public void renderInputTextFile (MarkupOutput out)

Renders HTML for input text file.

Parameters

out	`MarkupOutput` where to write the output of the method.

public void renderPromptContent (MarkupOutput out)

Renders the prompt's content Question area.

Parameters

out	`MarkupOutput`where to write the output of the method.

Protected Methods

protected boolean checkLogicalOperatorMethod (int iConst)

Indicates if the logicalOperatorSelectionMethod parameter value contains this flag.

Parameters

iConst	logical operator mode flag

Returns

true means the level logical operator mode flag is included in the logicalOperatorSelectionMethod parameter value

protected WebExpression getAnswer ()

Returns Expression prompt answer.
Answer is an instance of WebExpression object.

Returns

WebExpression prompt answer.

protected Cart getCart ()

Indicates an instance of a Cart object.
Overrides getCart by providing a CartExpression.

Returns

Cart instance

protected CartExpression getCartExpression ()

Indicates an instance of CartExpression object.
It returns a new empty CartExpression instance if null.

Returns

cart instance.

protected Enumeration getSelectedItems ()

Returns Expression prompt answer in an Enumeration instance.
Returns enumeration consisted of WebNode objects that were parsed in function processSelectedItems().

Returns

selected items enumeration

protected void processAvailableItems ()

Initializes the available units display list.
It processes prompts available displayable units. It determines which item requires being marked as selected. It populates selected item if necessary by getting all Attribute's elements or forms.

Throws

WebObjectsException	if something wrong happens when populating an specific item.

protected void processIncrementalFetch ()

Initializes incremental fetching settings for Available list.
It figures out block count size for Incremental fetch of items in Available list. If Expression type in Prompt is associated with a Metric Qualification, then block count is determined by invoking function getObjectsBlockCount(). Similar with Attribute Qualification, function getAttrElemBlockCount() gets invoked.
Both values are specified as Project preferences.

Throws

WebObjectsException	if something goes wrong figuring out these values.

protected void processSelectedItems ()

Initializes Selected list in Expression Prompt.
It populates selected items collection by getting expression prompt answer. Each item in answer collection corresponds to a WebNode instance. Each node is parsed and if it isn't considered complex, then it gets added to selected list.

Throws

WebObjectsException	if something goes wrong when parsing Expression prompt answer.

Interfaces

Classes

PromptExpressionCartTransform

Class Overview

Summary

Fields

public FormalParameter _dottedArrowImg

protected String _dottedArrowImgName

public FormalParameter logicalOperatorAvailableUserDefined

public FormalParameter logicalOperatorDefault

public FormalParameter logicalOperatorSelectionMethod

Public Constructors

public PromptExpressionCartTransform ()

Public Methods

public boolean canTransform (Transformable data)

Parameters

Returns

public String getDescription ()

Returns

public void initializeCart ()

public void initializeImages ()

public boolean isAnswerComplex ()

Returns

public void renderCart (MarkupOutput out)

Parameters

public void renderInputTextFile (MarkupOutput out)

Parameters

public void renderPromptContent (MarkupOutput out)

Parameters

Protected Methods

protected boolean checkLogicalOperatorMethod (int iConst)

Parameters

Returns

protected WebExpression getAnswer ()

Returns

protected Cart getCart ()

Returns

protected CartExpression getCartExpression ()

Returns

protected Enumeration getSelectedItems ()

Returns

protected void processAvailableItems ()

Throws

protected void processIncrementalFetch ()

Throws

protected void processSelectedItems ()

Throws