Package com.microstrategy.web.app.utils.upgrade

Class StyleCatalogModule

java.lang.Object

com.microstrategy.web.app.utils.upgrade.AbstractModule

com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule

com.microstrategy.web.app.utils.upgrade.StyleCatalogModule

All Implemented Interfaces:

UpgradeModule

public class StyleCatalogModule
extends AbstractXMLConfigModule

This module is responsible for upgrading the stylecatlog.xml. After deltas have been detected, it will update file locations for context-menus and layouts to as recommended by best-practices.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
StyleCatalogModule(UpgradeManager manager)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	calculateContextMenusPath(java.lang.String sPath)
protected java.lang.String	calculateLayoutPath(java.lang.String sPath)
protected java.lang.String	calculateNewFilePath(java.lang.String sPath)
protected java.lang.Class	elementClass()	Subclasses must implement this method to identify the AbstractConfigurationElement class that represents the root node of the xml.
java.lang.String	getDescription()	A description of the task the module performs.
java.lang.String	getName()	The display name of this module.
protected java.lang.String	initParameterName()	Subclasses must implement this method to identify the name of the init-parameter that defines the location of the xml configuration file.
protected AbstractConfigurationElement	processDeltas(AbstractConfigurationElement deltas)	Changes the location of custom context-menus and layouts as recommended by best practices.

Methods inherited from class com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule

calculateDeltas, calculateNewPath, getBaseElement, getCustomElement, getUpgradeInfo, processConfigFile, run, saveDeltas

Methods inherited from class com.microstrategy.web.app.utils.upgrade.AbstractModule

canChangeEnabled, getRelativePath, getUpgradeManager, isEnabled, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StyleCatalogModule

public StyleCatalogModule(UpgradeManager manager)

Method Detail

elementClass

protected java.lang.Class elementClass()

Description copied from class: AbstractXMLConfigModule

Subclasses must implement this method to identify the AbstractConfigurationElement class that represents the root node of the xml.

Specified by:

elementClass in class AbstractXMLConfigModule

initParameterName

protected java.lang.String initParameterName()

Description copied from class: AbstractXMLConfigModule

Subclasses must implement this method to identify the name of the init-parameter that defines the location of the xml configuration file.

Specified by:

initParameterName in class AbstractXMLConfigModule

processDeltas

protected AbstractConfigurationElement processDeltas(AbstractConfigurationElement deltas)

Changes the location of custom context-menus and layouts as recommended by best practices.

Overrides:

processDeltas in class AbstractXMLConfigModule

calculateLayoutPath

protected java.lang.String calculateLayoutPath(java.lang.String sPath)

calculateContextMenusPath

protected java.lang.String calculateContextMenusPath(java.lang.String sPath)

calculateNewFilePath

protected java.lang.String calculateNewFilePath(java.lang.String sPath)

getName

public java.lang.String getName()

Description copied from interface: UpgradeModule

The display name of this module.

getDescription

public java.lang.String getDescription()

Description copied from interface: UpgradeModule

A description of the task the module performs.