public class

WebBeanInfoList

extends AbstractConfigurationElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.app.WebBeanInfoList

Class Overview

The WebBeanInfoList class represents a collection of WebBeanInfo objects, corresponding to the beans defined for a given Page.

Summary

Constants
String NODE_WEB_BEANS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
WebBeanInfoList()
Class constructor.
WebBeanInfoList(Node root)
Class constructor.
WebBeanInfoList(Document doc)
Class constructor.
Public Methods
WebBeanInfo getWebBeanInfo(String name)
WebBeanInfo searchWebBeanInfo(String key)
Searches whole hierarchy rooted at the current list for the child WebBeanInfo specified the key and returns the search result.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String NODE_WEB_BEANS

Constant Value: "web-beans"

Public Constructors

public WebBeanInfoList ()

Class constructor. Initializes a new -empty- instance of the WebBeanInfoList class.

public WebBeanInfoList (Node root)

Class constructor. Initializes a WebBeanInfoList instance based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.

public WebBeanInfoList (Document doc)

Class constructor. Initializes a WebBeanInfoList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.

Public Methods

public WebBeanInfo getWebBeanInfo (String name)

Parameters
name the name of the WebBeanInfo
Returns
  • the WebBeanInfo in the collection with the given name

public WebBeanInfo searchWebBeanInfo (String key)

Searches whole hierarchy rooted at the current list for the child WebBeanInfo specified the key and returns the search result. The search starts with the first children of the current list, if not found, then it propagate to its grand children in depth-first manner.

Parameters
key the key mapped to the child WebBeanInfo to be searched.
Returns
  • the child WebComponent; null if there is no such a component existing in the hierarchy.