Class PromptExpressionCartTransform
- 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
-
- All Implemented Interfaces:
EnumPromptsBeanEvents,Transform
- Direct Known Subclasses:
PromptHierarchicalCartTransform
@Deprecated public class PromptExpressionCartTransform extends PromptCartTransform
Deprecated.UsePromptExpressionCartXHTMLTransforminsteadRenders Expression prompt in "shopping cart" style. This transforms makes use ofTaginstances to render HTML output. See reference toTagsFactory.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description FormalParameter_dottedArrowImgDeprecated.Image for dotted line to be used as graphical separator.protected java.lang.String_dottedArrowImgNameDeprecated.FormalParameterlogicalOperatorAvailableUserDefinedDeprecated.Specifies a custome boolean value indicating whether or not to displaye logical operators.FormalParameterlogicalOperatorDefaultDeprecated.Specifies 'And/Or' match case default value.FormalParameterlogicalOperatorSelectionMethodDeprecated.Specifies whether the 'And/Or' match case checkbox is displayed or not next the selected list in cart style ouput.-
Fields inherited from class com.microstrategy.web.app.transforms.PromptCartTransform
_addImage, _endImage, _findImage, _firstImage, _nextImage, _previousImage, _removeImage, addImage, availableSize, endImage, findImage, firstImage, matchCase, nextImage, previousImage, removeImage, searchAvailable, selectedSize
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
attrFormTypeInAvailableList, defaultOperatorId, editMetricQualificationOutputLevel, inputFromTextFile
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
_blockCount, _calendar, _cssPrefix, _dataTypeForCalendar, _globalCss, _imagesFolder, cssPrefix, imgBackToTop, imgCalendar, imgError, isDhtmlMode, levelFlag, showRequired
-
Fields inherited from interface com.microstrategy.web.beans.EnumPromptsBeanEvents
ANSWER_SEPARATOR, EXPRESSION_SEPARATOR, ITEM_SEPARATOR, ITEM_SPECIAL_SEPARATOR, PROMPTS_EVENT_ADD_UNITS, PROMPTS_EVENT_ANSWER_ALL_PROMPTS, PROMPTS_EVENT_ANSWER_ANY_PROMPTS, PROMPTS_EVENT_ANSWER_CONSTANT_PROMPT, PROMPTS_EVENT_ANSWER_DIMTY_PROMPT, PROMPTS_EVENT_ANSWER_ELEMENTS_PROMPT, PROMPTS_EVENT_ANSWER_EXPRESSION_PROMPT, PROMPTS_EVENT_ANSWER_OBJECTS_PROMPT, PROMPTS_EVENT_ANSWER_PROMPTS_IN_ADVANCE, PROMPTS_EVENT_ARGUMENT_ACTION_ADD_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_ANSWER_PROMPT, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_CHILD_FOLDER, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_ELEMENT, PROMPTS_EVENT_ARGUMENT_ACTION_BROWSE_PARENT_FOLDER, PROMPTS_EVENT_ARGUMENT_ACTION_CANCEL_PROMPT, PROMPTS_EVENT_ARGUMENT_ACTION_CLEAR_EXISTING_AND_ADD_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_DRILL_WITHIN_HIERARCHY, PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION, PROMPTS_EVENT_ARGUMENT_ACTION_HIGHLIGHT_DIMENSION_ATTRIBUTE, PROMPTS_EVENT_ARGUMENT_ACTION_INCREMENTAL_FETCH, PROMPTS_EVENT_ARGUMENT_ACTION_REMOVE_UNITS, PROMPTS_EVENT_ARGUMENT_ACTION_SEARCH_BY_NAME, PROMPTS_EVENT_ARGUMENT_ACTION_SHOW_SUMMARY, PROMPTS_EVENT_ARGUMENT_ANSWER, PROMPTS_EVENT_ARGUMENT_ANSWER_FORMAT, PROMPTS_EVENT_ARGUMENT_ANSWER_MODE_OPTION, PROMPTS_EVENT_ARGUMENT_ANSWER_OPTIONS, PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_ATTRIBUTE_ID_AND_FORM_ID, PROMPTS_EVENT_ARGUMENT_BLOCK_BEGIN, PROMPTS_EVENT_ARGUMENT_BLOCK_COUNT, PROMPTS_EVENT_ARGUMENT_BROWSE_PATH, PROMPTS_EVENT_ARGUMENT_CALENDAR_BUTTON, PROMPTS_EVENT_ARGUMENT_CHILD_FOLDER_ID, PROMPTS_EVENT_ARGUMENT_DIMENSION_ID, PROMPTS_EVENT_ARGUMENT_DO_NOT_AUTO_REPROMPT, PROMPTS_EVENT_ARGUMENT_DRILL_TO_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_EXEC_FLAGS, PROMPTS_EVENT_ARGUMENT_FILTER_STRING, PROMPTS_EVENT_ARGUMENT_FUNCTION, PROMPTS_EVENT_ARGUMENT_HIDDEN_ATTRIBUTE_ID, PROMPTS_EVENT_ARGUMENT_HIDDEN_DIMENSION_ID, PROMPTS_EVENT_ARGUMENT_INCREMENTAL_FETCH_GOTO_PAGE, PROMPTS_EVENT_ARGUMENT_LINK_ANSWERS, PROMPTS_EVENT_ARGUMENT_MATCH_CASE, PROMPTS_EVENT_ARGUMENT_MESSAGE_ALIAS, PROMPTS_EVENT_ARGUMENT_METRIC_ID, PROMPTS_EVENT_ARGUMENT_NAVIGATION, PROMPTS_EVENT_ARGUMENT_OBJECT_TYPE, PROMPTS_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID, PROMPTS_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML, PROMPTS_EVENT_ARGUMENT_PARENT_FOLDER_ID, PROMPTS_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER, PROMPTS_EVENT_ARGUMENT_PROMPT_POSITION, PROMPTS_EVENT_ARGUMENT_REOPEN_PROMPT, PROMPTS_EVENT_ARGUMENT_SAP_VARIABLE_EXCLUDE, PROMPTS_EVENT_ARGUMENT_SEARCH_NAME, PROMPTS_EVENT_ARGUMENT_SEARCH_ROOT, PROMPTS_EVENT_ARGUMENT_SRC_ANSWERS, PROMPTS_EVENT_ARGUMENT_SUB_ROOT_OPERATOR, PROMPTS_EVENT_ARGUMENT_SUBMIT_ANSWER, PROMPTS_EVENT_ARGUMENT_UNITS_TO_ADD, PROMPTS_EVENT_ARGUMENT_UNITS_TO_REMOVE, PROMPTS_EVENT_ARGUMENT_USE_SET_ANSWERS, PROMPTS_EVENT_ARGUMENT_USER_SEPARATOR, PROMPTS_EVENT_BROWSE_DIMENSION_ATTRIBUTE_ELEMENTS, PROMPTS_EVENT_BROWSE_ELEMENTS, PROMPTS_EVENT_BROWSE_HIERARCHICAL_CHILD_FOLDER, PROMPTS_EVENT_BROWSE_HIERARCHICAL_PARENT_FOLDER, PROMPTS_EVENT_CANCEL_ALL_PROMPTS, PROMPTS_EVENT_CANCEL_ANY_PROMPTS, PROMPTS_EVENT_CLEAR_EXISTING_AND_ADD_UNITS, PROMPTS_EVENT_CLEAR_HIERARCHICAL_SEARCH_EXPRESSION, PROMPTS_EVENT_DRILL_WITHIN_HIERARCHY, PROMPTS_EVENT_HIGHLIGHT_DIMENSION, PROMPTS_EVENT_HIGHLIGHT_DIMENSION_ATTRIBUTE, PROMPTS_EVENT_INCREMENTAL_FETCH, PROMPTS_EVENT_NAVIGATE_PROMPTS_BEAN, PROMPTS_EVENT_PROCESS_ALL_PROMPTS, PROMPTS_EVENT_PROCESS_ANY_PROMPTS, PROMPTS_EVENT_REMOVE_UNITS, PROMPTS_EVENT_SEARCH_BY_NAME, PROMPTS_EVENT_SHOW_ALL_PROMPTS_SUMMARY, PROMPTS_EVENT_SHOW_ANY_PROMPTS_SUMMARY, SIMPLE_SEPARATOR_CARET, SIMPLE_SEPARATOR_COMMA, SIMPLE_SEPARATOR_SEMICOLON, UNIT_SEPARATOR
-
-
Constructor Summary
Constructors Constructor Description PromptExpressionCartTransform()Deprecated.Default no-args constructor, initialize all the formal parameters as Parent class has defined.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancanTransform(Transformable data)Deprecated.Indicates whether or not given component, denoted by data, can be processed by this transform.protected booleancheckLogicalOperatorMethod(int iConst)Deprecated.Indicates if the logicalOperatorSelectionMethod parameter value contains this flag.protected WebExpressiongetAnswer()Deprecated.Returns Expression prompt answer.protected CartgetCart()Deprecated.Indicates an instance of a Cart object.protected CartExpressiongetCartExpression()Deprecated.Indicates an instance of CartExpression object.java.lang.StringgetDescription()Deprecated.Indicates this transforms description.protected java.util.EnumerationgetSelectedItems()Deprecated.Returns Expression prompt answer in an Enumeration instance.voidinitializeCart()Deprecated.Initializes Cart properties to default values.voidinitializeImages()Deprecated.Initializes the images for this transform.booleanisAnswerComplex()Deprecated.Indicates whether or not current prompt answer is complex.protected voidprocessAvailableItems()Deprecated.Initializes the available units display list.protected voidprocessIncrementalFetch()Deprecated.Initializes incremental fetching settings for Available list.protected voidprocessSelectedItems()Deprecated.Initializes Selected list in Expression Prompt.voidrenderCart(MarkupOutput out)Deprecated.Renders an HTML shopping cart.voidrenderInputTextFile(MarkupOutput out)Deprecated.Renders HTML for input text file.voidrenderPromptContent(MarkupOutput out)Deprecated.Renders the prompt's content Question area.-
Methods inherited from class com.microstrategy.web.app.transforms.PromptCartTransform
areThereAvailableSelections, getAvailableItems, getErrorMessage, getSearchPattern, initializeFormalParameters, initializePromptContent, isIncrementalFetchAvailable, isSearchActive, isSearchPossible, setExtraArguments, updateIncrementalFetchCartProperties
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptExpressionTransform
getDimtyAsString, getDimtyAttributesAsString, getOutputLevel, isBrowserIE6, isCart, isMQLevelEditingSupported, isNodeComplex, isNodeDimtyEmpty, renderHiddenInputsForMQEditor, renderOutputLevelLabel, renderPromptHiddenInputs, setMetricQualOutputLevelAndDimty
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
addFormalParameter, arePromptsLoadedFirstTime, checkLevel, getAnswerEvent, getArgumentName, getAttrElemBlockCount, getAvailableDisplayUnits, getCalendar, getContainerServices, getDescriptor, getDescriptor, getDescriptor, getDimensionAttribute, getDisplayHelper, getIntValue, getLocale, getMatchCaseSensitivity, getMultipleEvent, getMultipleEventArgumentString, getObjectsBlockCount, getPrompt, getPromptsAppContext, getPromptsBean, getPromptsList, getRequestKeys, getShowRequired, getStringValue, getSupportedBeanType, getTagsFactory, hasAnswer, initializeCss, initializePromptObject, isBackToTopAnchorEnabled, isDhtmlMode, isDimensionalPrompt, isForDefinition, isIFrameRequest, isItemKeptInCartAvailable, isLocked, isLockedForSearch, isPromptObjectInitialized, isPromptRequired, isPromptSummaryEnabled, isTrue, isXDA_CustomSQL_Report, isXDA_MDX_Report, isXDAReport, newHiddenInputBuilder, newNamespaceEncoder, onBeforeApplyDefaultDisplaySettings, renderLayout, renderMinMaxHiddenValues, renderPromptAnswerMeaning, renderPromptBackToTopAnchor, renderPromptDefaultAnswer, renderPromptErrorMessage, renderPromptIFrameRequest, renderPromptMeaning, renderPromptNoSelectionsAvailable, renderPromptNotAnswered, renderPromptQuestion, renderPromptRestrictions, renderPromptSummary, renderPromptSummaryAnswer, renderPromptSummaryTitle, renderPromptTitle, setArgumentValue, setAttrElemBlockCount, setEnableBackToTopAnchor, setIsItemKeptInCartAvailable, setLevelFlag, setLocale, setMatchCaseSensitivity, setObjectsBlockCount, setPromptSummary, setShowRequired, transform
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutContext, getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports
-
-
-
-
Field Detail
-
_dottedArrowImg
public FormalParameter _dottedArrowImg
Deprecated.Image for dotted line to be used as graphical separator.
-
_dottedArrowImgName
protected java.lang.String _dottedArrowImgName
Deprecated.
-
logicalOperatorSelectionMethod
public FormalParameter logicalOperatorSelectionMethod
Deprecated.Specifies whether the 'And/Or' match case checkbox is displayed or not next the selected list in cart style ouput.- Since:
- MicroStrategy Web 7.5.0
-
logicalOperatorAvailableUserDefined
public FormalParameter logicalOperatorAvailableUserDefined
Deprecated.Specifies a custome boolean value indicating whether or not to displaye logical operators.- Since:
- MicroStrategy Web 8.0.0
-
logicalOperatorDefault
public FormalParameter logicalOperatorDefault
Deprecated.Specifies 'And/Or' match case default value.- Since:
- MicroStrategy Web 7.5.0
-
-
Method Detail
-
processAvailableItems
protected void processAvailableItems() throws WebObjectsExceptionDeprecated.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.- Overrides:
processAvailableItemsin classAbstractPromptObjectTransform- Throws:
WebObjectsException- if something wrong happens when populating an specific item.
-
processSelectedItems
protected void processSelectedItems() throws WebObjectsExceptionDeprecated.Initializes Selected list in Expression Prompt.
It populates selected items collection by getting expression prompt answer. Each item in answer collection corresponds to aWebNodeinstance. Each node is parsed and if it isn't considered complex, then it gets added to selected list.- Overrides:
processSelectedItemsin classPromptCartTransform- Throws:
WebObjectsException- if something goes wrong when parsing Expression prompt answer.
-
getAnswer
protected WebExpression getAnswer()
Deprecated.Returns Expression prompt answer.
Answer is an instance ofWebExpressionobject.- Returns:
- WebExpression prompt answer.
-
isAnswerComplex
public boolean isAnswerComplex()
Deprecated.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 ofWebExpressionisn't either an OR/AND logical operator.- Overrides:
isAnswerComplexin classPromptCartTransform- Returns:
- true if answer is complex
-
processIncrementalFetch
protected void processIncrementalFetch() throws WebObjectsExceptionDeprecated.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.- Overrides:
processIncrementalFetchin classAbstractPromptObjectTransform- Throws:
WebObjectsException- if something goes wrong figuring out these values.
-
initializeCart
public void initializeCart()
Deprecated.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.- Overrides:
initializeCartin classPromptCartTransform
-
initializeImages
public void initializeImages()
Deprecated.Initializes the images for this transform.
It also invokes parent method to initialized all shared images.- Overrides:
initializeImagesin classPromptCartTransform
-
getSelectedItems
protected java.util.Enumeration getSelectedItems()
Deprecated.Returns Expression prompt answer in an Enumeration instance.
Returns enumeration consisted ofWebNodeobjects that were parsed in functionprocessSelectedItems().- Overrides:
getSelectedItemsin classPromptCartTransform- Returns:
- selected items enumeration
-
renderCart
public void renderCart(MarkupOutput out)
Deprecated.Renders an HTML shopping cart.- Overrides:
renderCartin classPromptCartTransform- Parameters:
out-MarkupOutputwhere to write the output of the method.
-
getCart
protected Cart getCart()
Deprecated.Indicates an instance of a Cart object.
Overrides getCart by providing a CartExpression.- Overrides:
getCartin classPromptCartTransform- Returns:
- Cart instance
-
getCartExpression
protected CartExpression getCartExpression()
Deprecated.Indicates an instance of CartExpression object.
It returns a new empty CartExpression instance if null.- Returns:
- cart instance.
-
renderPromptContent
public void renderPromptContent(MarkupOutput out)
Deprecated.Renders the prompt's content Question area.- Overrides:
renderPromptContentin classPromptCartTransform- Parameters:
out-MarkupOutputwhere to write the output of the method.
-
renderInputTextFile
public void renderInputTextFile(MarkupOutput out)
Deprecated.Renders HTML for input text file.- Parameters:
out-MarkupOutputwhere to write the output of the method.
-
canTransform
public boolean canTransform(Transformable data)
Deprecated.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 typeEnumWebPromptType.WebPromptTypeExpression- Specified by:
canTransformin interfaceTransform- Overrides:
canTransformin classPromptCartTransform- Parameters:
data- object (PromptObject) to transform- Returns:
- true if the data is a PromptObject of a Expression WebPrompt.
-
getDescription
public java.lang.String getDescription()
Deprecated.Indicates this transforms description.- Specified by:
getDescriptionin interfaceTransform- Overrides:
getDescriptionin classPromptCartTransform- Returns:
- the description of a shopping cart.
-
checkLogicalOperatorMethod
protected boolean checkLogicalOperatorMethod(int iConst)
Deprecated.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
- Since:
- MicroStrategy Web 7.5.0
-
-