Package com.microstrategy.web.app.transforms

Class PromptHierarchicalCartTransform

    • Field Detail

      • _drillList

        protected java.util.Enumeration _drillList
        Deprecated.

      • _answers

        protected java.util.Enumeration _answers
        Deprecated.

      • _selectedPane

        protected int _selectedPane
        Deprecated.

      • ARGUMENT_PANE_STATUS

        protected static final int ARGUMENT_PANE_STATUS
        Deprecated.
        See Also:
        Constant Field Values

      • ARGUMENT_PANE_SELECT

        protected static final int ARGUMENT_PANE_SELECT
        Deprecated.
        See Also:
        Constant Field Values

      • ARGUMENT_PANE_QUALIFY

        protected static final int ARGUMENT_PANE_QUALIFY
        Deprecated.
        See Also:
        Constant Field Values

      • ARGUMENT_ROOT_FOLDER_BROWSE_ID

        protected static final int ARGUMENT_ROOT_FOLDER_BROWSE_ID
        Deprecated.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • NONE_VALUE

        protected static final java.lang.String NONE_VALUE
        Deprecated.
        See Also:
        Constant Field Values

      • _showHierarchicalSubFolders

        protected boolean _showHierarchicalSubFolders
        Deprecated.
        Class variable that specifies a flag indicating whether or not to show hierarchical sub folders in pull-down menu.
        Since:
        MicroStrategy Web 7.5.1

      • _hierarchicalSubFolders

        protected java.util.Vector _hierarchicalSubFolders
        Deprecated.
        Specifies a collection of CartElementFolders to be used for rendering folders pull-down menu.
        Since:
        MicroStrategy Web 7.5.1

      • _rootFolderId

        protected java.lang.String _rootFolderId
        Deprecated.
        Class variable that specifies the root folder ID.
        Since:
        MicroStrategy Web 7.5.1

      • step1Image

        public FormalParameter step1Image
        Deprecated.
        Image to indicate the first step for hierarchical prompts.

      • _step1Image

        protected java.lang.String _step1Image
        Deprecated.

      • step2Image

        public FormalParameter step2Image
        Deprecated.
        Image to indicate the second step for hierarchical prompts.

      • _step2Image

        protected java.lang.String _step2Image
        Deprecated.

      • step2disabledImage

        public FormalParameter step2disabledImage
        Deprecated.
        Image to indicate the second step for hierarchical prompts (when disabled).

      • _step2disabledImage

        protected java.lang.String _step2disabledImage
        Deprecated.

      • selectedPaneImage

        public FormalParameter selectedPaneImage
        Deprecated.
        Image of the selected pane of the attribute qualification.

      • _selectedPaneImage

        protected java.lang.String _selectedPaneImage
        Deprecated.

      • unselectedPaneImage

        public FormalParameter unselectedPaneImage
        Deprecated.
        Image of the unselected pane of the attribute qualification.

      • _unselectedPaneImage

        protected java.lang.String _unselectedPaneImage
        Deprecated.

      • isQualifyAvailable

        public FormalParameter isQualifyAvailable
        Deprecated.
        Determine if qualification pane is available.

      • isSearchRequired

        public FormalParameter isSearchRequired
        Deprecated.
        Use PromptCartTransform.searchAvailable instead.
        Specifies whether a search is required to display the elements of the selected attribute.
        Hierarchical prompts specify in their definition whether a search is permitted on given attribute's element. Displaying a search section is controlled by this flag.
        This flag is used as a boolean value.

      • showAttributeSelection

        public FormalParameter showAttributeSelection
        Deprecated.
        Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts.
        This flag is used as a boolean value.
        Since:
        MicroStrategy Web 7.5.0

      • _1ptransImage

        protected java.lang.String _1ptransImage
        Deprecated.
        Image name for a transparent graphic.

    • Constructor Detail

      • PromptHierarchicalCartTransform

        public PromptHierarchicalCartTransform()
        Deprecated.
        Default no-args constructor, initialize all the formal parameters as Parent class has defined.

    • Method Detail

      • processHierarchicalSubFolders

        protected void processHierarchicalSubFolders()
                                      throws WebObjectsException
        Deprecated.
        Parses hierarchy sub folder list and initialize collection for its rendering.
        It parses hierarchy list and constructs a collection of sub folders to be displayed.
        Throws:
        WebObjectsException - as result of highlighting unsuccessfully an WebObjectInfo.
        Since:
        MicroStrategy Web 7.5.1

      • getLabelForFolderFirstOption

        protected java.lang.String getLabelForFolderFirstOption()
        Deprecated.
        Indicates localized label to be displayed as first option in Subfolder's pull-down menu.
        Returns:
        String localized label.
        Since:
        MicroStrategy Web 7.5.4

      • parserHierarchicalSubFolderCollection

        public void parserHierarchicalSubFolderCollection​(WebDisplayUnits subFolders,
                                                  int level)
                                           throws WebObjectsException
        Deprecated.
        Parses hierarchy list and creates all sub folder browsing in pull-down menu.
        Parameters:
        subFolders - WebDisplayUnits collection of subolfoder objects.
        level - int indentation level.
        Throws:
        WebObjectsException - thrown when an error happens while parsing folder objects.
        Since:
        MicroStrategy Web 7.5.1

      • initializeElementsForRequiredSearch

        protected void initializeElementsForRequiredSearch()
                                            throws WebObjectsException
        Deprecated.
        It initializes elements list if a required search was performed on given attribute.
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 7.5.4

      • isDimensionAttributeFiltered

        protected boolean isDimensionAttributeFiltered​(WebDimensionAttribute dimAttr)
        Deprecated.
        Checks whether given dimension attribute has a filter in its definition.
        Parameters:
        dimAttr - WebDimensionAttribute item being checked.
        Returns:
        boolean true if dimension attribute has a filter.
        Since:
        MicroStrategy Web 7.5.4

      • cleanHierarchyList

        protected void cleanHierarchyList()
        Deprecated.
        Filters out hierarchy list.
        Removes instances in collection that aren't WebDimension instances.
        Since:
        MicroStrategy Web 7.5.1

      • hasAccessGranted

        protected boolean hasAccessGranted​(WebDisplayUnit dispUnit)
        Deprecated.
        Determines whether or not end-user has access to given item.
        Parameters:
        dispUnit - WebDisplayUnit to be checked.
        Returns:
        WebDisplayUnits fitlered out list of attributes.
        Since:
        MicroStrategy Web 7.5.1

      • isNodeComplex

        protected boolean isNodeComplex​(WebNode node)
        Deprecated.
        Indicates if a single subexpression is Complex.
        An expression is complex if it cannot be created using the Web interface.
        This method overrides isNodeComplex(WebNode) by supporting ListQual expression (Element List expressions). It also checks if the styles supports Attribute qualification, if it doesn't all other type of expressions are also considered complex, if it does, then it calls super.isNodeComplex() to check if the expression is normally supported by attribute qualification
        Overrides:
        isNodeComplex in class AbstractPromptExpressionTransform
        Parameters:
        node - the root node of the subexpression to check
        Returns:
        True if the Node is complex, that is, it cannot be created using this transform.

      • getErrorMessage

        protected java.lang.String getErrorMessage​(WebBeanError promptError)
        Deprecated.
        Returns localized error message.
        Error message is associated to promptError code.
        Overrides:
        getErrorMessage in class PromptCartTransform
        Parameters:
        promptError - instance of WebBeanError, most likely an validation error thrown in process prompt phase.
        Returns:
        error message as String. Error is localized to active language

      • renderPromptSummary

        public void renderPromptSummary​(MarkupOutput out)
        Deprecated.
        Renders prompt's default answer defininiton.
        It displays default answer without any promtp question form.
        Overrides:
        renderPromptSummary in class AbstractPromptObjectTransform
        Parameters:
        out - the transform output
        Since:
        MicroStrategy Web 7.5.1

      • initializePromptContent

        public void initializePromptContent()
                             throws WebObjectsException
        Deprecated.
        Initializes prompt content to be displayed.
        Extends the initializePromptContent() by reading from the request the current attribute qualification type.
        Overrides:
        initializePromptContent in class PromptCartTransform
        Throws:
        WebObjectsException - if something goes wrong during initialization process.

      • processIncrementalFetch

        protected void processIncrementalFetch()
                                throws WebObjectsException
        Deprecated.
        Initializes incremental fetching settings.
        Overrides super.processIncrementalFetch() by not setting incremental fetch settings. Hierarchical prompts gets the available items in a different schema.
        Overrides:
        processIncrementalFetch in class PromptExpressionCartTransform
        Throws:
        WebObjectsException - if something goes wrong figuring out these values.

      • initializeDrillList

        public void initializeDrillList()
                         throws WebObjectsException
        Deprecated.
        Initializes the elements in the drill list.
        It determines also whether or not 'Down' and 'Up'
        Throws:
        WebObjectsException

      • getAvailableItems

        protected java.util.Enumeration getAvailableItems()
        Deprecated.
        Returns an enumeration with the availalbe items.
        Overrides:
        getAvailableItems in class PromptCartTransform
        Returns:
        available list enumeration.

      • areThereAvailableSelections

        public boolean areThereAvailableSelections()
        Deprecated.
        This function checks size of available selections. Returns false when selections are less or equal to zero.
        Overrides:
        areThereAvailableSelections in class PromptCartTransform
        Returns:
        boolean true if available selection is greater than 0

      • getFirstHighlightedItem

        public WebDisplayUnit getFirstHighlightedItem​(WebDisplayUnits units)
        Deprecated.
        Returns the first highlighted item found in collection.
        Parameters:
        units - WebDisplayUnits collection to be parsed.
        Returns:
        WebDisplayUnit highlighted item.

      • getFirstNonHighlightedEntryPoint

        public WebDisplayUnit getFirstNonHighlightedEntryPoint​(WebDisplayUnits units)
        Deprecated.
        Returns the first non-highlighted entry point found in collection.
        Parameters:
        units - WebDisplayUnits collection being parsed.
        Returns:
        WebDisplayUnit first non-highlighted item in collection.
        Since:
        MicroStrategy Web 7.5.0

      • getFirstNonHighlightedItem

        public WebDisplayUnit getFirstNonHighlightedItem​(WebDisplayUnits units)
        Deprecated.
        Returns the first non-highlighted item found in collection.
        Parameters:
        units - WebDisplayUnits collection to be parsed.
        Returns:
        WebDisplayUnit first non-highlighted item.

      • getCartHelper

        public CartExpression getCartHelper()
        Deprecated.
        Returns instance of cart helper object.
        Returns:
        CartExpression instance
        Since:
        MicroStrategy Web 7.5.0

      • getHierarchyAttributeList

        public WebDisplayUnits getHierarchyAttributeList()
        Deprecated.
        Returns instance of active hierarchy list of attributes.
        Returns:
        WebDisplayUnits instance
        Since:
        MicroStrategy Web 7.5.0

      • getSelectedAttribute

        public WebDisplayUnit getSelectedAttribute()
        Deprecated.
        Returns instance of active hierarchy list of attributes.
        Returns:
        WebDisplayUnit instance
        Since:
        MicroStrategy Web 7.5.0

      • getAttributeElementList

        public WebDisplayUnits getAttributeElementList()
        Deprecated.
        Returns list of all elements defined in selected Attribute.
        Returns:
        WebDisplayUnits instance
        Since:
        MicroStrategy Web 7.5.0

      • getDrillList

        public java.util.Enumeration getDrillList()
        Deprecated.
        Returns drill list.
        Returns:
        Enumeration instance
        Since:
        MicroStrategy Web 7.5.0

      • renderCart

        public void renderCart​(MarkupOutput out)
        Deprecated.
        Rendes the cart of hierarchical prompts. It calls renderAvailable, renderSelected and renderAdd/renderRemove methods.
        Overrides:
        renderCart in class PromptExpressionCartTransform
        Parameters:
        out - where to write the output of the method.

      • renderAvailable

        public void renderAvailable​(MarkupOutput out)
        Deprecated.
        Will display available list.
        Parameters:
        out - where to write the output of the method.

      • renderHierarchiesPane

        public void renderHierarchiesPane​(MarkupOutput out)
        Deprecated.
        Renders hierarchies HTML pane.
        Parameters:
        out - where to write the output of the method.

      • renderFoldersPane

        public void renderFoldersPane​(MarkupOutput out)
        Deprecated.
        Renders folder's pull-down area in current prompt question.
        Parameters:
        out - MarkupOutput where to write folder area.
        Since:
        MicroStrategy Web 7.5.4

      • renderAttributesPane

        public void renderAttributesPane​(MarkupOutput out)
        Deprecated.
        Renders attribute HTML list pane.
        Parameters:
        out - where to write the output of the method.

      • renderAttributesPaneTile

        public void renderAttributesPaneTile​(boolean enabled,
                                     MarkupOutput out)
        Deprecated.
        This method cannot be used in a layout-xml. Instead, use renderAttributesPaneTile(MarkupOutput out, boolean enabled).
        Renders attribute pane title.
        Parameters:
        enabled - indicates whether to show 'qualify' and 'select' pane.
        out - where to write the output of the method.

      • renderAttributesPaneTile

        public void renderAttributesPaneTile​(MarkupOutput out,
                                     boolean enabled)
        Deprecated.
        Renders attribute pane title.
        Parameters:
        enabled - indicates whether to show 'qualify' and 'select' pane.
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.1

      • renderAttributesPaneContent

        public void renderAttributesPaneContent​(boolean enabled,
                                        MarkupOutput out)
        Deprecated.
        This method cannot be used in a layout-xml. Instead, use renderAttributesPaneContent(MarkupOutput out, boolean enabled)
        Renders attribute pane content.
        Parameters:
        enabled - indicates whether to show 'qualify' and 'select' pane.
        out - where to write the output of the method.

      • renderAttributesPaneContent

        public void renderAttributesPaneContent​(MarkupOutput out,
                                        boolean enabled)
        Deprecated.
        Renders attribute pane content.
        Parameters:
        enabled - indicates whether to show 'qualify' and 'select' pane.
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.1

      • renderEmptyAttributeList

        public void renderEmptyAttributeList​(MarkupOutput out)
        Deprecated.
        Renders HTML empty list of attributes.
        Parameters:
        out - where to write the output of the method.

      • renderAttributeQualification

        public void renderAttributeQualification​(MarkupOutput out)
        Deprecated.
        Renders attribute HTML components for an attribute qualification.
        Parameters:
        out - where to write the output of the method.

      • renderElementList

        public void renderElementList​(MarkupOutput out)
        Deprecated.
        Renders a list of attribute elements.
        Parameters:
        out - where to write the output of the method.

      • renderFoldersPaneTile

        public void renderFoldersPaneTile​(MarkupOutput out)
        Deprecated.
        Renders Hierarchies Pane Title.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 7.5.1

      • renderHierarchiesPaneTile

        public void renderHierarchiesPaneTile​(MarkupOutput out)
        Deprecated.
        Renders Hierarchies Pane Title.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • renderFoldersPaneContent

        public void renderFoldersPaneContent​(MarkupOutput out)
        Deprecated.
        Renders Hierarchies Pane Content.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 7.5.1

      • canHierarchyPaneBeShown

        public boolean canHierarchyPaneBeShown()
        Deprecated.
        Indicates whether or not Hierarchy pane can be displayed.
        Hierarchical Cart prompt always has to display this pane when necessary.
        Returns:
        boolean true if it is to be displayed.
        Since:
        MicroStrategy Web 7.5.4

      • renderHierarchiesPaneContent

        public void renderHierarchiesPaneContent​(MarkupOutput out)
        Deprecated.
        Renders Hierarchies Pane Content.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • renderSelected

        public void renderSelected​(MarkupOutput out)
        Deprecated.
        renderSelected, will display selected list.
        Parameters:
        out - where to write the output of the method.

      • renderAdd

        public void renderAdd​(MarkupOutput out)
        Deprecated.
        renderAdd, displays add arrow button.
        Parameters:
        out - where to write the output of the method.

      • renderRemove

        public void renderRemove​(MarkupOutput out)
        Deprecated.
        renderRemove, displays remove arrow button.
        Parameters:
        out - where to write the output of the method.

      • renderMatch

        public void renderMatch​(MarkupOutput out)
        Deprecated.
        renderAdd, displays add arrow button.
        Parameters:
        out - where to write the output of the method.

      • getArgumentName

        protected java.lang.String getArgumentName​(int argumentId)
        Deprecated.
        Returns an argument name for the given id. Since the argument name depends on the PromptPosition, this method automatically returns the argument corresponding to the current Prompt
        Overrides:
        getArgumentName in class AbstractPromptObjectTransform
        Parameters:
        argumentId - the id
        Returns:
        the argument name for the given id

      • getAttributeFormattedValue

        protected java.lang.String getAttributeFormattedValue​(WebDisplayUnit attribute)
        Deprecated.
        Returns formatted string to be passed as request parameter.
        It parses attribute parameter in order to create a formatted text of its name.
        Parameters:
        attribute - to be parsed.
        Returns:
        String formatted text.
        Since:
        MicroStrategy Web 7.5.0