Package com.microstrategy.web.app

Class TemplateInfoList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.TemplateInfoList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class TemplateInfoList
extends AbstractConfigurationElementList

The TemplateInfoList class is a collection of TemplateInfos instances that holds information about how to map events. For more information about TemplateInfoping, please check documention of the TemplateInfo class.

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	NODE_TEMPLATES

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

ATT_VERSION

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
TemplateInfoList()	Class constructor.
TemplateInfoList(org.w3c.dom.Document doc)	Class constructor.
TemplateInfoList(org.w3c.dom.Node root)	Class constructor.
TemplateInfoList(org.w3c.dom.Node root, TemplateInfoList defaultList)	Class constructor.

Method Summary

Modifier and Type	Method	Description
TemplateInfo	getTemplateInfo(int status)	Retrieve a TemplateInfo by its status.
protected void	removeDefaults(CustomizationInfo c)	This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
protected void	setPrototype(AbstractConfigurationElement prototype)	Sets the prototype object for this instance.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, 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, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_TEMPLATES

public static final java.lang.String NODE_TEMPLATES

See Also:

Constant Field Values

Constructor Detail

TemplateInfoList

public TemplateInfoList()

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

TemplateInfoList

public TemplateInfoList(org.w3c.dom.Node root)

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

Parameters:

root - Node instance representing the shortcut list information.

TemplateInfoList

public TemplateInfoList(org.w3c.dom.Node root,
                        TemplateInfoList defaultList)

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

Parameters:

defaultList - a TemplateInfoList instance containing the default template list to use for the page.

root - Node instance representing the shortcut list information.

TemplateInfoList

public TemplateInfoList(org.w3c.dom.Document doc)

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

Parameters:

doc - Document instance representing the shortcut list information.

Method Detail

removeDefaults

protected void removeDefaults(CustomizationInfo c)

Description copied from class: AbstractConfigurationElement

This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.

Overrides:

removeDefaults in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getTemplateInfo

public TemplateInfo getTemplateInfo(int status)

Retrieve a TemplateInfo by its status. This method returns the best possible TemplateInfo for the given status, for this it uses the list of default templates as well.
The TemplateInfo returned is in order:

1. The TemplateInfo for the given status in this list
2. The TemplateInfo for the given status in the default list
3. The TemplateInfo for the status 0 (use for all status) in this list
4. The TemplateInfo for the status 0 (use for all status) in the default list

If none TemplateInfo is found, then null is returned.

Parameters:

status - the status associated with the TemplateInfo

Returns:

the TemplateInfo associated with the given status

setPrototype

protected void setPrototype(AbstractConfigurationElement prototype)

Description copied from class: AbstractConfigurationElement

Sets the prototype object for this instance. The attributes and elements of the prototype are copied into this instance.

Overrides:

setPrototype in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0