public class

PromptHierarchyWidgetTransform

extends PromptExpressionWidgetTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
           ↳ com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
             ↳ com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
               ↳ com.microstrategy.web.app.transforms.PromptHierarchyWidgetTransform

Class Overview

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.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptHierarchyWidgetTransform()
Public Methods
List getAttributeOrElementList()
Returns the list of available list (attribute or element).
int getAvailableBlockBegin()
Returns the block begin of the available list.
int getAvailableBlockCount()
Returns the block count of the available list.
int getAvailableTotalCount()
Returns the total count of the available list.
String getCurrentTreeNodeLocation()
Returns the location of the current node in the flattened ancestor tree.
List getDrillDownPaths()
Returns a list of the drill down paths.
List getDrillUpPaths()
Returns the list of drill up paths.
List getFlattenedAvailablesAncestors()
Returns a flattened list of the ancestors tree of the available list.
Class getSupportedBeanType()
Gets the class of objects this transform is able to handle.
void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.
boolean isAttributeExpandedToElements()
Returns whether the attribute has been expanded to list its elements.
boolean isElementSearchDisabled()
Returns whether the element search is disabled.
boolean isLeafAttribute()
Returns whether the expanded attribute is leaf attribute or not.
boolean isSearchRequired()
Returns whether a search is required for element browsing.
boolean shouldHideSingleFilter()
boolean showSearchBox()
Returns whether GUI should show the search box or not.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public PromptHierarchyWidgetTransform ()

Public Methods

public List getAttributeOrElementList ()

Returns the list of available list (attribute or element).

Returns
  • The list of available list (attribute or element).

public int getAvailableBlockBegin ()

Returns the block begin of the available list.

Returns
  • The block begin of the available list.

public int getAvailableBlockCount ()

Returns the block count of the available list.

Returns
  • The block count of the available list.

public int getAvailableTotalCount ()

Returns the total count of the available list.

Returns
  • The total count of the available list.

public 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.
See Also
  • {@link PreorderEnumeration}.

public 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.

public 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.

public 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.

public Class getSupportedBeanType ()

Gets the class of objects this transform is able to handle.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public void initializeWebComponent (Transformable data)

Initialize the web component to be used by the transform.

Parameters
data the bean to transform.

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.

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.

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

public boolean isSearchRequired ()

Returns whether a search is required for element browsing.

Returns
  • Whether a search is required for element browsing.

public boolean shouldHideSingleFilter ()

public boolean showSearchBox ()

Returns whether GUI should show the search box or not.

Returns
  • whether GUI should show the search box or not.