public class

AddonInfo

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

Class Overview

AddonInfo objects are executed right before calling the collectData method on the WebComponents of the beans hirarchy. Developers can write any piece of code they want to be executed as part of the execution cicle of the web beans

Summary

Constants
String ATT_ID
String ATT_NAME
String NODE_ADDON
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
AddonInfo()
Empty constructor of a AddonInfo initialize private fields with default values.
AddonInfo(Node root)
Creates an AddonInfo with the information in the xml node.
AddonInfo(String name)
Constructor for an AddonInfo with the given the arguments.
Public Methods
AppAddOns getAddOnInstance(AppContext appContext)
Returns an initialized addOns instance with the values depending on the appContext
Object getKey()
Default implementation for getKey().
String getName()
WebBeanPropertyList getPropertyList()
Get the property list for the WebBeanStyle instance
String getXmlMergeId()
void setKey(Element element)
Default implementation for setKey().
void setName(String name)
Set the name of the add-on to a new value
void setXmlMergeId(String xmlMergeId)
Sets the xmlMergeId of this add-on
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
boolean isKeyAttribute(String name)
Returns true is the name is that of the key attribute.
[Expand]
Inherited Methods
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.ConfigurationFile

Constants

public static final String ATT_ID

Constant Value: "XMLmerge_id"

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_ADDON

Constant Value: "addon"

Public Constructors

public AddonInfo ()

Empty constructor of a AddonInfo initialize private fields with default values.

public AddonInfo (Node root)

Creates an AddonInfo with the information in the xml node.

Parameters
root An XML Node with the information for this event map.

public AddonInfo (String name)

Constructor for an AddonInfo with the given the arguments.

Parameters
name The name of the Addoninfo object.

Public Methods

public AppAddOns getAddOnInstance (AppContext appContext)

Returns an initialized addOns instance with the values depending on the appContext

Parameters
appContext the current application context
Returns
  • an AddOns instance
Throws
WebAppException if the class doesn't exist or the instance can be created.

public Object getKey ()

Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.

Returns
  • If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

public String getName ()

Returns
  • the name of the add-on

public WebBeanPropertyList getPropertyList ()

Get the property list for the WebBeanStyle instance

Returns
  • property list for this style

public String getXmlMergeId ()

Returns
  • the XmlMerge id to use with this add-on.

public void setKey (Element element)

Default implementation for setKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings and adds this attribute to the given element; the attribute to use is specified by the getKeyAttribute() method.

public void setName (String name)

Set the name of the add-on to a new value

Parameters
name The new name for the add-on

public void setXmlMergeId (String xmlMergeId)

Sets the xmlMergeId of this add-on

Parameters
xmlMergeId the new value to use for the xmlMergeId.

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected boolean isKeyAttribute (String name)

Returns true is the name is that of the key attribute.