public class

TemplateInfo

extends AbstractConfigurationElement

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

Class Overview

This class holds the information required by a Page Template to render. This is information is only required by the jsps and not at runtime.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	TemplateInfo(Node root) Creates a TemplateInfo with the information in the xml node.
	TemplateInfo(Node root, TemplateInfo defaultTemplate) Creates a TemplateInfo with the information in the xml node.
	TemplateInfo() Empty constructor of a TemplateInfo initialize private fields with default values.

Public Methods
void	addSection(String sectionName, String fileName) Adds a page section file name.
void	addShortcutList(String name, ShortcutList shortcutList) Adds a ShortcutList
void	deleteSection(String sectionName) Deletes a page section file name
void	deleteShortcutList(String name) Deletes a ShortcutList
boolean	getAllowCancel()
TemplateInfo	getDefaultTemplate() Returns the default template of the application
String	getErrorDesc()
String	getErrorTitleId()
String	getFileName()
boolean	getIframe()
Object	getKey() Default implementation for `getKey()`.
String	getPageName()
String	getSection(String sectionName) Returns the file name of the section associated with the given section name.
SectionInfoList	getSectionInfoList() Returns the available sections for this template.
ShortcutList	getShortcutList(String name) Returns the ShorcutList associated with the given name.
ShortcutListSet	getShortcutListSet() Returns the set of ShortcutLists for this template.
boolean	getShowWait()
int	getStatus() Return the status of this Template.
WebGuiComponentList	getWebGuiComponentList() Returns the available Web Components for this template.
String	getXmlMergeId()
void	setAllowCancel(boolean newValue)
void	setErrorDesc(String errorDesc) Sets the descriptor Desc of the title of the error section if an error happens on this page.
void	setErrorTitleId(String errorTitleId) Sets the descriptor Id of the title of the error section if an error happens on this page.
void	setFileName(String fileName) Sets the fileName of this template
void	setIframe(boolean newValue) Sets if the template uses the iframe functionality
void	setShowWait(boolean newValue)
void	setStatus(int status) Sets that status of this Template.
void	setWebGuiComponentList(WebGuiComponentList webGuiComponentList)
void	setXmlMergeId(String xmlMergeId) Sets the xmlMergeId of this template

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.
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initPrototype(String protoName) Extends initPrototype to provide support for a default template.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	setKey(Element element) Default implementation for `setKey()`.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.

[Expand]

Inherited Methods

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
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.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

Public Constructors

public TemplateInfo (Node root)

Creates a TemplateInfo with the information in the xml node.

Parameters

root	An XML Node with the information for this TemplateInfo.

public TemplateInfo (Node root, TemplateInfo defaultTemplate)

Creates a TemplateInfo with the information in the xml node.

Parameters

root	An XML Node with the information for this TemplateInfo.
defaultTemplate	a TemplateInfo used as default.

public TemplateInfo ()

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

Public Methods

public void addSection (String sectionName, String fileName)

Adds a page section file name.

Parameters

sectionName	the section's name.
fileName	file name associated with the given section.

public void addShortcutList (String name, ShortcutList shortcutList)

Adds a ShortcutList

Parameters

name	the ShorcutList's name.
shortcutList	the ShortcutList.

public void deleteSection (String sectionName)

Deletes a page section file name

Parameters

sectionName	the section's name.

public void deleteShortcutList (String name)

Deletes a ShortcutList

Parameters

name	the ShorcutList's name.

public boolean getAllowCancel ()

Returns

the value of the property indicating if the cancel button on the wait box should be displayed or not

public TemplateInfo getDefaultTemplate ()

Returns the default template of the application

Returns

the default template of the application

public String getErrorDesc ()

Returns

the desc of the description to use as title for the error page.

public String getErrorTitleId ()

Returns

the id of the description to use as title for the error page.

public String getFileName ()

Returns

the file name to use with this template.

public boolean getIframe ()

Returns

true if the template uses the iframe functionality.

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 getPageName ()

Returns

the page name from the to use in place of this template.

public String getSection (String sectionName)

Returns the file name of the section associated with the given section name.

Parameters

sectionName	the section's name.

Returns

file name associated with the given section.

public SectionInfoList getSectionInfoList ()

Returns the available sections for this template.

Returns

the template's SectionList

public ShortcutList getShortcutList (String name)

Returns the ShorcutList associated with the given name.

Parameters

name	the ShorcutList's name.

Returns

the ShorcutList associated with the given name.

public ShortcutListSet getShortcutListSet ()

Returns the set of ShortcutLists for this template.

Returns

the template's ShortcutListSet

public boolean getShowWait ()

Returns

the value of the property indicating if the wait should be displayed or not

public int getStatus ()

Return the status of this Template. The status indicates to use this template only if the page is in the same status. An status of 0 indicates to use this template with any status.

Returns

the status associated.

public WebGuiComponentList getWebGuiComponentList ()

Returns the available Web Components for this template.

Returns

the template's WebGuiComponentList

public String getXmlMergeId ()

Returns

the XmlMerge id to use with this template.

public void setAllowCancel (boolean newValue)

Parameters

newValue	boolean value indicating if the cancel button on the wait box should be displayed or not

public void setErrorDesc (String errorDesc)

Sets the descriptor Desc of the title of the error section if an error happens on this page.

Parameters

errorDesc	the new descriptor Desc.

public void setErrorTitleId (String errorTitleId)

Sets the descriptor Id of the title of the error section if an error happens on this page.

Parameters

errorTitleId	the new descriptor Id.

public void setFileName (String fileName)

Sets the fileName of this template

Parameters

fileName	the new file to use.

public void setIframe (boolean newValue)

Sets if the template uses the iframe functionality

Parameters

newValue	iframe usage.

public void setShowWait (boolean newValue)

Parameters

newValue	boolean value indicating if the wait should be displayed or not

public void setStatus (int status)

Sets that status of this Template. If a Template has an associated status, it should only be used when the pageComponent is in this status.

Parameters

status	value indicating the current status

public void setWebGuiComponentList (WebGuiComponentList webGuiComponentList)

public void setXmlMergeId (String xmlMergeId)

Sets the xmlMergeId of this template

Parameters

xmlMergeId	the new file to use.

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 void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)

protected void initPrototype (String protoName)

Extends initPrototype to provide support for a default template. When a new TemplateInfo is created, if it doesn't have a prototype yet, it should will use the default template from the default list as prototype.
This functionality has been added to provide backwards compatibility, but this behavior is intended to be removed in the future. The correct behavior is that each template should have its definition complete, and not rely on the definition of the default template. Make sure the definition in the pageConfig reflects this.

Parameters

protoName	Prototype name, typically the name of a sibling node in the xml.

protected boolean isKeyAttribute (String name)

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

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

protected void setPrototype (AbstractConfigurationElement prototype)

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

Interfaces

Classes

Exceptions

TemplateInfo

Class Overview

Summary

Public Constructors

public TemplateInfo (Node root)

Parameters

public TemplateInfo (Node root, TemplateInfo defaultTemplate)

Parameters

public TemplateInfo ()

Public Methods

public void addSection (String sectionName, String fileName)

Parameters

public void addShortcutList (String name, ShortcutList shortcutList)

Parameters

public void deleteSection (String sectionName)

Parameters

public void deleteShortcutList (String name)

Parameters

public boolean getAllowCancel ()

Returns

public TemplateInfo getDefaultTemplate ()

Returns

public String getErrorDesc ()

Returns

public String getErrorTitleId ()

Returns

public String getFileName ()

Returns

public boolean getIframe ()

Returns

public Object getKey ()

Returns

public String getPageName ()

Returns

public String getSection (String sectionName)

Parameters

Returns

public SectionInfoList getSectionInfoList ()

Returns

public ShortcutList getShortcutList (String name)

Parameters

Returns

public ShortcutListSet getShortcutListSet ()

Returns

public boolean getShowWait ()

Returns

public int getStatus ()

Returns

public WebGuiComponentList getWebGuiComponentList ()

Returns

public String getXmlMergeId ()

Returns

public void setAllowCancel (boolean newValue)

Parameters

public void setErrorDesc (String errorDesc)

Parameters

public void setErrorTitleId (String errorTitleId)

Parameters

public void setFileName (String fileName)

Parameters

public void setIframe (boolean newValue)

Parameters

public void setShowWait (boolean newValue)

Parameters

public void setStatus (int status)

Parameters

public void setWebGuiComponentList (WebGuiComponentList webGuiComponentList)

public void setXmlMergeId (String xmlMergeId)

Parameters

Protected Methods

protected String getKeyAttribute ()

protected void initDefaultAttributes ()

protected void initPrototype (String protoName)

Parameters

protected boolean isKeyAttribute (String name)

protected void setKey (Element element)

protected void setPrototype (AbstractConfigurationElement prototype)