Package com.microstrategy.web.app
Class AddonInfo
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.app.AddonInfo
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
public class AddonInfo extends AbstractConfigurationElement
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- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_ID
static java.lang.String
ATT_NAME
static java.lang.String
NODE_ADDON
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description AddonInfo()
Empty constructor of a AddonInfo initialize private fields with default values.AddonInfo(java.lang.String name)
Constructor for an AddonInfo with the given the arguments.AddonInfo(org.w3c.dom.Node root)
Creates an AddonInfo with the information in the xml node.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AppAddOns
getAddOnInstance(AppContext appContext)
Returns an initialized addOns instance with the values depending on the appContextjava.lang.Object
getKey()
Default implementation forgetKey()
.protected java.lang.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 thegetKey
andsetKey
methods.java.lang.String
getName()
WebBeanPropertyList
getPropertyList()
Get the property list for the WebBeanStyle instancejava.lang.String
getXmlMergeId()
protected boolean
isKeyAttribute(java.lang.String name)
Returnstrue
is the name is that of the key attribute.void
setKey(org.w3c.dom.Element element)
Default implementation forsetKey()
.void
setName(java.lang.String name)
Set the name of the add-on to a new valuevoid
setXmlMergeId(java.lang.String xmlMergeId)
Sets the xmlMergeId of this add-on-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation
-
-
-
-
Field Detail
-
NODE_ADDON
public static final java.lang.String NODE_ADDON
- See Also:
- Constant Field Values
-
ATT_NAME
public static final java.lang.String ATT_NAME
- See Also:
- Constant Field Values
-
ATT_ID
public static final java.lang.String ATT_ID
- Since:
- MicroStrategy Web 8.0.2
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AddonInfo
public AddonInfo()
Empty constructor of a AddonInfo initialize private fields with default values.
-
AddonInfo
public AddonInfo(org.w3c.dom.Node root)
Creates an AddonInfo with the information in the xml node.- Parameters:
root
- An XML Node with the information for this event map.
-
AddonInfo
public AddonInfo(java.lang.String name)
Constructor for an AddonInfo with the given the arguments.- Parameters:
name
- The name of the Addoninfo object.
-
-
Method Detail
-
getName
public java.lang.String getName()
- Returns:
- the name of the add-on
-
setName
public void setName(java.lang.String name)
Set the name of the add-on to a new value- Parameters:
name
- The new name for the add-on- Since:
- MicroStrategy Web 9.0.0
-
getXmlMergeId
public java.lang.String getXmlMergeId()
- Returns:
- the XmlMerge id to use with this add-on.
- Since:
- MicroStrategy Web 8.0.2
-
setXmlMergeId
public void setXmlMergeId(java.lang.String xmlMergeId)
Sets the xmlMergeId of this add-on- Parameters:
xmlMergeId
- the new value to use for the xmlMergeId.- Since:
- MicroStrategy Web 8.0.2
-
getPropertyList
public WebBeanPropertyList getPropertyList()
Get the property list for the WebBeanStyle instance- Returns:
- property list for this style
-
getAddOnInstance
public AppAddOns getAddOnInstance(AppContext appContext) throws WebAppException
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.
-
getKeyAttribute
protected java.lang.String getKeyAttribute()
Description copied from class:AbstractConfigurationElement
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
getKey
public java.lang.Object getKey()
Description copied from class:AbstractConfigurationElement
Default implementation forgetKey()
. It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by thegetKeyAttribute()
method.- Specified by:
getKey
in interfaceConfigurationElement
- Overrides:
getKey
in classAbstractConfigurationElement
- Returns:
- If
getKeyAttribute()
is empty returnsnull
, otherwise it returns the value of the given attribute. - Since:
- MicroStrategy Web 9.0.0
-
setKey
public void setKey(org.w3c.dom.Element element)
Description copied from class:AbstractConfigurationElement
Default implementation forsetKey()
. 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 thegetKeyAttribute()
method.- Overrides:
setKey
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
isKeyAttribute
protected boolean isKeyAttribute(java.lang.String name)
Description copied from class:AbstractConfigurationElement
Returnstrue
is the name is that of the key attribute.- Overrides:
isKeyAttribute
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
-