Package com.microstrategy.web.app

Class ProjectInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.ProjectInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class ProjectInfo
extends AbstractConfigurationElementList

Groups a set of shortcuts to system folders on a project basis. It is found inside a context and can be used to determine which folder links, or shortcuts, should appear on browsers in which MicroStrategy projects. Notice that shortcuts under the default project appear in all 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_DEFAULT
static java.lang.String	ATT_ID
static java.lang.String	ATT_NAME
static java.lang.String	NODE_PROJECT	Constant for the 'project' node used in the objBrowserFolderLinks.xml

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getID()	Returns the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts.
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.
java.lang.String	getName()	Returns the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts.
FolderLink	getRootFolder()	Return the root folder for a particular project
boolean	isDefault()	Returns whether this is the default project.
protected boolean	isKeyAttribute(java.lang.String name)	Returns true is the name is that of the key attribute.
void	setID(java.lang.String value)	Sets the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts.
void	setIsDefault(boolean isDefault)	Indicates whether this is the default project.
void	setKey(org.w3c.dom.Element element)	Default implementation for setKey().
void	setName(java.lang.String value)	Sets the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts.

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

public static final java.lang.String NODE_PROJECT

Constant for the 'project' node used in the objBrowserFolderLinks.xml

See Also:

Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID

See Also:

Constant Field Values

ATT_DEFAULT

public static final java.lang.String ATT_DEFAULT

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

ProjectInfo

public ProjectInfo()

Default no-arg constructor.

Since:

MicroStrategy Web 9.0.0

ProjectInfo

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

Creates an ProjectInfo 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

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

setKey

public void setKey(org.w3c.dom.Element element)

Description copied from class: AbstractConfigurationElement

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.

Overrides:

setKey in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

isKeyAttribute

protected boolean isKeyAttribute(java.lang.String name)

Description copied from class: AbstractConfigurationElement

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

Overrides:

isKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getID

public java.lang.String getID()

Returns the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts. If it's the default project it returns null.

setID

public void setID(java.lang.String value)

Sets the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts. If value is null, it sets this as the default project

Since:

MicroStrategy Web 9.0.0

getRootFolder

public FolderLink getRootFolder()

Return the root folder for a particular project

Returns:

FolderLink

isDefault

public boolean isDefault()

Returns whether this is the default project. Notice that when true, the shortcuts defined inside this ProjectInfo element appear in all projects.

setIsDefault

public void setIsDefault(boolean isDefault)

Indicates whether this is the default project. When true, the shortcuts defined inside this ProjetInfo element appear in all projects.

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Returns the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts. Notice however that this is not used by the application, folder-links for a specific project are always identified based on the project-id.

Returns:

the name attribute

Since:

MicroStrategy Web 9.0.0

setName

public void setName(java.lang.String value)

Sets the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts. Notice however that this is not used by the application, folder-links for a specific project are always identified based on the project-id.

Parameters:

value - the value of name attribute

Since:

MicroStrategy Web 9.0.0