Package com.microstrategy.web.app.transforms

Class PromptHierarchyWidgetTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class PromptHierarchyWidgetTransform
extends PromptExpressionWidgetTransform
    This transform is used to render a hierarchy qualification prompt. This transform is responsible for the initial rendering of the prompt. Subsequent calls to browse each hierarchy element is done using a call to the 'browseHierarchy' task. Please check the task definition (browseHierarchy.xml) for more information about the style/transform used for rendering incremental hierarchy information.
    Since:
    MicroStrategy Web 9.0.0

    • Constructor Detail

      • PromptHierarchyWidgetTransform

        public PromptHierarchyWidgetTransform()

    • Method Detail

      • isSearchRequired

        public boolean isSearchRequired()
        Returns whether a search is required for element browsing.
        Returns:
        Whether a search is required for element browsing.

      • getAttributeOrElementList

        public java.util.List getAttributeOrElementList()
        Returns the list of available list (attribute or element).
        Returns:
        The list of available list (attribute or element).

      • getFlattenedAvailablesAncestors

        public java.util.List getFlattenedAvailablesAncestors()
        Returns a flattened list of the ancestors tree of the available list. Refer to PreorderEnumeration for how the ancestor tree has been flattened.
        Returns:
        A flattened list of the ancestor tree of the available list.

      • getCurrentTreeNodeLocation

        public java.lang.String getCurrentTreeNodeLocation()
        Returns the location of the current node in the flattened ancestor tree. The available list is the content of the current node.
        Returns:
        the location of the current node in the flattened ancestor tree.

      • isAttributeExpandedToElements

        public boolean isAttributeExpandedToElements()
        Returns whether the attribute has been expanded to list its elements. When this is true, then the available list could contain elements instead of hierarchies or attributes. This is important since both attribute and hierarchy are of WebObjectInfo type, but element is of WebElement type.
        Returns:
        Whether the attribute has been expanded to list its elements.

      • getAvailableBlockBegin

        public int getAvailableBlockBegin()
        Returns the block begin of the available list.
        Returns:
        The block begin of the available list.

      • getAvailableBlockCount

        public int getAvailableBlockCount()
        Returns the block count of the available list.
        Returns:
        The block count of the available list.

      • getAvailableTotalCount

        public int getAvailableTotalCount()
        Returns the total count of the available list.
        Returns:
        The total count of the available list.

      • getDrillUpPaths

        public java.util.List getDrillUpPaths()
        Returns the list of drill up paths. When the first entry point attribute has been expanded, this method would return the drill up paths for that entry point. In other case, it would just return an empty list.
        Returns:
        The list of drill up paths.

      • showSearchBox

        public boolean showSearchBox()
        Returns whether GUI should show the search box or not.
        Overrides:
        showSearchBox in class AbstractPromptWidgetTransform
        Returns:
        whether GUI should show the search box or not.

      • isElementSearchDisabled

        public boolean isElementSearchDisabled()
        Returns whether the element search is disabled. For example, currently we can not perform search on certain XDA/MDX prompt.
        Returns:
        Whether the element search is disabled.

      • getDrillDownPaths

        public java.util.List getDrillDownPaths()
        Returns a list of the drill down paths. When the first entry point attribute has been expanded, this method would return the drill down paths for that entry point. In other case, it would just return an empty list.
        Returns:
        A list of the drill down paths.

      • isLeafAttribute

        public boolean isLeafAttribute()
        Returns whether the expanded attribute is leaf attribute or not. When the first entry point attribute has been expanded, this method would return whether the current attribute is the leaf attribute in the hierarchy. In other case, it would just return false.
        Returns:
        true if expanded attribute is the leaf attribute in hierarchy. Otherwise returns false

      • shouldHideSingleFilter

        public boolean shouldHideSingleFilter()