Package com.microstrategy.web.app

Class ContextInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.ContextInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class ContextInfo
extends AbstractConfigurationElementList

The ContextInfo element defines a group of folder links, or shortcuts. A context is generally associated with a single editor or folder browser in the application (specified through a setting in the editor or browser). The context can include different sets of folder links for different projects.

Since:

MicroStrategy Web 8.0.0

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_DESC
static java.lang.String	ATT_ID
static java.lang.String	NODE_CONTEXT

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
ContextInfo()	Default no-arguments constructor.
ContextInfo(org.w3c.dom.Node root)	Creates a ContextInfo and populates it with the information in the Xml Node.

Method Summary

Modifier and Type	Method	Description
ProjectInfo	getDefaultProject()
java.lang.String	getDescription()	Returns a description of the context.
int	getID()	Returns the unique identifier of the context.
java.lang.Object	getKey()	Default implementation for getKey().
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.
void	setDescription(java.lang.String value)	Set the description of the context.
void	setID(int id)	Sets the unique identifier of the context.

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

clear, clone, get, get, getFilteredList, getKey, 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, 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, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_CONTEXT

public static final java.lang.String NODE_CONTEXT

See Also:

Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID

See Also:

Constant Field Values

ATT_DESC

public static final java.lang.String ATT_DESC

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

ContextInfo

public ContextInfo()

Default no-arguments constructor.

Since:

MicroStrategy Web 9.0.0

ContextInfo

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

Creates a ContextInfo and populates it with the information in the Xml Node. Internally it calls AbstractConfigurationElement.initFromXML(org.w3c.dom.Node).

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.

Overrides:

getKeyAttribute in class AbstractConfigurationElementList

Since:

MicroStrategy Web 9.0.0

getID

public int getID()

Returns the unique identifier of the context.

setID

public void setID(int id)

Sets the unique identifier of the context.

Since:

MicroStrategy Web 9.0.0

getDefaultProject

public ProjectInfo getDefaultProject()

getKey

public java.lang.Object getKey()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKey in interface ConfigurationElement

Overrides:

getKey in class AbstractConfigurationElement

Returns:

If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

Since:

MicroStrategy Web 9.0.0

getDescription

public java.lang.String getDescription()

Returns a description of the context.

Since:

MicroStrategy Web 9.0.0

setDescription

public void setDescription(java.lang.String value)

Set the description of the context.

Since:

MicroStrategy Web 9.0.0