public class

FolderMapping

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

Class Overview

This class represents a Folder Map. This is the mapping between the folder in the EnumDSSXMLFolderNames and it's corresponding page of the pageConfig. For example com.microstrategy.webapi.EnumDSSXMLFolderNames.DssXmlFolderNamePublicReports maps to "shared" page. This folder mapping indicates the default page that the application uses to display the contents of the metadata project folder specified by the named-page attribute.

Summary

Constants
String ATT_NAMED_FOLDER
String ATT_TARGET_PAGE
String NODE_FOLDER_MAPPING
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
FolderMapping()
Empty constructor
FolderMapping(Node root)
Creates an FolderMapping with the information in the xml node.
FolderMapping(String namedFolder, String target)
Constructor for an FolderMapping with the given the arguments.
Public Methods
int getFolderId()
Returns the corresponding sysFolderId of the named-folder, that is the enumeration value of associated named-folder.
Object getKey()
Default implementation for getKey().
String getNamedFolder()
Returns the value of the named-folder.
String getTargetPage()
The target-page attribute indicates the name of the default page to open (for example, "shared" or "my") when the application browses to the folder specified by the named-page attribute.
void setNamedFolder(String value)
Set the value for the named folder.
void setTargetPage(String value)
Set The target-page attribute indicates the name of the default page to open (for example, "shared" or "my") when the application browses to the folder specified by the named-page attribute.
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.
[Expand]
Inherited Methods
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.ConfigurationFile

Constants

public static final String ATT_NAMED_FOLDER

Constant Value: "named-page"

public static final String ATT_TARGET_PAGE

Constant Value: "target-page"

public static final String NODE_FOLDER_MAPPING

Constant Value: "mapping"

Public Constructors

public FolderMapping ()

Empty constructor

public FolderMapping (Node root)

Creates an FolderMapping with the information in the xml node.

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

public FolderMapping (String namedFolder, String target)

Constructor for an FolderMapping with the given the arguments.

Parameters
namedFolder A fully qualified enumeration value of the folder
target The name of the target page

Public Methods

public int getFolderId ()

Returns the corresponding sysFolderId of the named-folder, that is the enumeration value of associated named-folder.

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 getNamedFolder ()

Returns the value of the named-folder. The value is the fully-qualified name of the EnumDSSXMLFolderNames interface (for example, "com.microstrategy.webapi.EnumDSSXMLFolderNames.DssXmlFolderNamePublicReports").

public String getTargetPage ()

The target-page attribute indicates the name of the default page to open (for example, "shared" or "my") when the application browses to the folder specified by the named-page attribute.

public void setNamedFolder (String value)

Set the value for the named folder. Indicates the system folder to associate with the page identified by the target-page attribute. The value is the fully-qualified name of the EnumDSSXMLFolderNames interface (for example, "com.microstrategy.webapi.EnumDSSXMLFolderNames.DssXmlFolderNamePublicReports").

public void setTargetPage (String value)

Set The target-page attribute indicates the name of the default page to open (for example, "shared" or "my") when the application browses to the folder specified by the named-page 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.