Package com.microstrategy.web.app

Class SectionInfoList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.SectionInfoList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class SectionInfoList
extends AbstractConfigurationElementList

The SectionInfoList class is a collection of SectionInfo instances that holds information about which file to use for that section in the Template.

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_SECTIONS

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

Method Summary

Modifier and Type	Method	Description
SectionInfoList	getDefaultSectionInfoList()	Deprecated. Not used anymore
SectionInfo	getSectionInfo(java.lang.String name)	Retrieve a SectionInfo by its name.
boolean	useDefault()	Deprecated. Use-default has been expanded to not only support Default values, but also values from config-src and customizations.

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, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, 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_SECTIONS

public static final java.lang.String NODE_SECTIONS

See Also:

Constant Field Values

Constructor Detail

SectionInfoList

public SectionInfoList()

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

SectionInfoList

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

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

Parameters:

root - Node instance representing the shortcut list information.

SectionInfoList

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

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

Parameters:

doc - Document instance representing the shortcut list information.

SectionInfoList

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

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

Parameters:

root - Node instance representing the shortcut list information.

defaultList - a SectionInfoList used as default.

SectionInfoList

public SectionInfoList(org.w3c.dom.Document doc,
                       SectionInfoList defaultList)

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

Parameters:

doc - Document instance representing the shortcut list information.

defaultList - a SectionInfoList used as default.

Method Detail

useDefault

public boolean useDefault()

Deprecated.

Use-default has been expanded to not only support Default values, but also values from config-src and customizations. To retrieve the value use AbstractConfigurationElement.getUseDefault()

Returns whether to use the DefaultSectionInfoList when when initializing this instance. If true and the defaultSectionList is not null, we'll add first all of the default SectionInfo and then add the elements on the xml.

Returns:

true if the defaultList should be used

getDefaultSectionInfoList

public SectionInfoList getDefaultSectionInfoList()

Deprecated.

Not used anymore

Returns the DefaultSectionList. This list is used when initializing the instance if the useDefault is true. All the elements in this list are automatically added, not depending if they're in the xml definition.

Returns:

the default SectionInfoList

getSectionInfo

public SectionInfo getSectionInfo(java.lang.String name)

Retrieve a SectionInfo by its name.

Parameters:

name - The name of the Section.

Returns:

the SectionInfo associated with the given name