Package com.microstrategy.web.app

Class FolderMapping

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.FolderMapping

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class FolderMapping
extends AbstractConfigurationElement

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.

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_NAMED_FOLDER
static java.lang.String	ATT_TARGET_PAGE
static java.lang.String	NODE_FOLDER_MAPPING

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
FolderMapping()	Empty constructor
FolderMapping(java.lang.String namedFolder, java.lang.String target)	Constructor for an FolderMapping with the given the arguments.
FolderMapping(org.w3c.dom.Node root)	Creates an FolderMapping with the information in the xml node.

Method Summary

Modifier and Type	Method	Description
int	getFolderId()	Returns the corresponding sysFolderId of the named-folder, that is the enumeration value of associated named-folder.
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	getNamedFolder()	Returns the value of the named-folder.
java.lang.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(java.lang.String value)	Set the value for the named folder.
void	setTargetPage(java.lang.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.

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

ATT_NAMED_FOLDER

public static final java.lang.String ATT_NAMED_FOLDER

See Also:

Constant Field Values

ATT_TARGET_PAGE

public static final java.lang.String ATT_TARGET_PAGE

See Also:

Constant Field Values

NODE_FOLDER_MAPPING

public static final java.lang.String NODE_FOLDER_MAPPING

See Also:

Constant Field Values

Constructor Detail

FolderMapping

public FolderMapping()

Empty constructor

FolderMapping

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

Creates an FolderMapping with the information in the xml node.

Parameters:

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

FolderMapping

public FolderMapping(java.lang.String namedFolder,
                     java.lang.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

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

getFolderId

public int getFolderId()

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

getNamedFolder

public java.lang.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").

setNamedFolder

public void setNamedFolder(java.lang.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").

Since:

MicroStrategy Web 9.0.0

getTargetPage

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

setTargetPage

public void setTargetPage(java.lang.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.

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