Package com.microstrategy.web.app

Class SectionInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.SectionInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class SectionInfo
extends AbstractConfigurationElement

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_FILE_NAME
static java.lang.String	ATT_NAME
static java.lang.String	NODE_SECTION

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
SectionInfo()	Empty constructor of a SectionInfo initialize private fields with default values.
SectionInfo(java.lang.String name, java.lang.String fileName)	Constructor for an SectionInfo with the given the arguments.
SectionInfo(org.w3c.dom.Node root)	Creates a SectionInfo with the information in the xml node.

Method Summary

Modifier and Type	Method	Description
protected boolean	fromDefault()	Deprecated. This method is not used by the application and will be removed in future versions of the product.
java.lang.String	getFileName()
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 the getKey and setKey methods.
java.lang.String	getName()
void	setFileName(java.lang.String newValue)
protected void	setFromDefault(boolean newValue)	Deprecated. This method is not used by the application and will be removed in future versions of the product.
void	setName(java.lang.String newValue)

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, 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

Field Detail

NODE_SECTION

public static final java.lang.String NODE_SECTION

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

See Also:

Constant Field Values

ATT_FILE_NAME

public static final java.lang.String ATT_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

SectionInfo

public SectionInfo()

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

SectionInfo

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

Creates a SectionInfo with the information in the xml node.

Parameters:

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

SectionInfo

public SectionInfo(java.lang.String name,
                   java.lang.String fileName)

Constructor for an SectionInfo with the given the arguments.

Parameters:

name - the section name

fileName - The name of the file to associate with this section

Method Detail

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 the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

setName

public void setName(java.lang.String newValue)

getName

public java.lang.String getName()

Returns:

the name of the section

setFileName

public void setFileName(java.lang.String newValue)

getFileName

public java.lang.String getFileName()

Returns:

the fileName associated with this section

setFromDefault

protected void setFromDefault(boolean newValue)

Deprecated.

This method is not used by the application and will be removed in future versions of the product.

Indicates the section it comes from a default on the default page

Parameters:

newValue - boolean value

fromDefault

protected boolean fromDefault()

Deprecated.

This method is not used by the application and will be removed in future versions of the product.

Returns whether the section it comes from a default on the default page

Returns:

true if the section it comes from a default on the default page