public class

ProjectInfo

extends AbstractConfigurationElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.app.ProjectInfo

Class Overview

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.

Summary

Constants
String ATT_DEFAULT
String ATT_ID
String ATT_NAME
String NODE_PROJECT Constant for the 'project' node used in the objBrowserFolderLinks.xml
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ProjectInfo()
Default no-arg constructor.
ProjectInfo(Node root)
Creates an ProjectInfo and populates it with the information in the Xml Node.
Public Methods
String getID()
Returns the id of the project (from the metadata) that is associated with the group of folder links, or shortcuts.
Object getKey()
Default implementation for getKey().
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.
void setID(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(Element element)
Default implementation for setKey().
void setName(String value)
Sets the name of the project (from the metadata) that is associated with the group of folder links, or shortcuts.
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.
boolean isKeyAttribute(String name)
Returns true is the name is that of the key attribute.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_DEFAULT

Constant Value: "default"

public static final String ATT_ID

Constant Value: "id"

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_PROJECT

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

Constant Value: "project"

Public Constructors

public ProjectInfo ()

Default no-arg constructor.

public ProjectInfo (Node root)

Creates an ProjectInfo and populates it with the information in the Xml Node. Internally it calls initFromXML(Node).

Public Methods

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

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

public FolderLink getRootFolder ()

Return the root folder for a particular project

Returns
  • FolderLink

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.

public void setID (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

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.

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

public void setName (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

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 boolean isKeyAttribute (String name)

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