Package com.microstrategy.web.config

Class Visualizations

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.config.Visualizations

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class Visualizations
extends AbstractConfigurationElementList

This class represents the visualizations node of the visualizations.xml
Contains a collections of VisualizationList objectcs, as well as some helper methods related to the visualizations feature.

Since:

MicroStrategy Web 9.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	NODE_VISUALIZATIONS

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
Visualizations()
Visualizations(org.w3c.dom.Node root)

Method Summary

Modifier and Type	Method	Description
static boolean	areVisualizationsAvailable(int scope, int viewMode, VisualizationList visList, WebIServerSession session)
GenericJsonGenerator	generateAllVisualizationsJson(Messages messages)	Returns a JSONGenerator object used to pass the list of all visualizations to the client side
GenericJsonGenerator	generateVisualizationsJson(Messages messages, VisualizationList visList)	Returns a JSONGenerator object used to pass the list of all visualizations to the client side
VisualizationList	getAllVisualizations()
VisualizationList	getAllVisualizations(int scope)	Deprecated. use getAllVisualizations() and filter out each visualization using (@link Visualization.isValid())
java.lang.String	getAllVisualizationsJson(Messages messages)	Deprecated. use getAllVisualizationsJson(Messages) as its more efficient
VisualizationList	getAllWebVisualizations()
java.lang.String	getNodeName()	Returns the node-name for this element.
VisualizationList	getVisualizationList(int index)
VisualizationList	getVisualizationList(java.lang.Object key)
VisualizationList	getVisualizationListForViewMode(int viewMode)
VisualizationList	getVisualizationListFromNames(java.lang.String[] visualizationNames)	Returns a list of visualizations generated from list of visualization names
java.lang.String	getVisualizationListName(int viewMode)	Return the name of the visualization that matches the specified view mode
protected void	initFromFile(java.lang.String filePath, CustomizationInfo c)	Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, 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, getKey, getLineNumber, getList, getNextKey, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, 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

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_VISUALIZATIONS

public static final java.lang.String NODE_VISUALIZATIONS

See Also:

Constant Field Values

Constructor Detail

Visualizations

public Visualizations()

Visualizations

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

Method Detail

getNodeName

public java.lang.String getNodeName()

Description copied from interface: ConfigurationElement

Returns the node-name for this element.

Specified by:

getNodeName in interface ConfigurationElement

Overrides:

getNodeName in class AbstractConfigurationElement

initFromFile

protected void initFromFile(java.lang.String filePath,
                            CustomizationInfo c)
                     throws ConfigException

Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.

Overrides:

initFromFile in class AbstractConfigurationElement

Throws:

ConfigException

Since:

MicroStrategy Web 9.0.1

getVisualizationListFromNames

public VisualizationList getVisualizationListFromNames(java.lang.String[] visualizationNames)

Returns a list of visualizations generated from list of visualization names

Parameters:

visualizationNames - a list of visualization names

Returns:

a list of visualizations generated from list of visualization names

getAllVisualizations

public VisualizationList getAllVisualizations()

Returns:

a list with all visualizations from all visualizations lists

getAllWebVisualizations

public VisualizationList getAllWebVisualizations()

Returns:

a list with all visualizations from all visualizations lists that are visible to Web (i.e. not mobile)

areVisualizationsAvailable

public static boolean areVisualizationsAvailable(int scope,
                                                 int viewMode,
                                                 VisualizationList visList,
                                                 WebIServerSession session)

getAllVisualizations

public VisualizationList getAllVisualizations(int scope)

Deprecated.

use getAllVisualizations() and filter out each visualization using (@link Visualization.isValid())

Returns a list with all visualizations with the scope specified from all visualizations lists

Parameters:

scope - the scope of the visualizations desired

Returns:

a list with all visualizations from all visualizations lists

getVisualizationList

public VisualizationList getVisualizationList(int index)

Parameters:

index - the index of the visualization list to return

Returns:

the visualization list specified

getVisualizationList

public VisualizationList getVisualizationList(java.lang.Object key)

Parameters:

key - the key (i.e. "flash") of the visualization list to return

Returns:

the visualization list specified

getVisualizationListForViewMode

public VisualizationList getVisualizationListForViewMode(int viewMode)

Parameters:

viewMode - the view mode of the visualization list to return (from EnumWebVisualizationViewModes)

Returns:

the visualization list specified

getVisualizationListName

public java.lang.String getVisualizationListName(int viewMode)

Return the name of the visualization that matches the specified view mode

Parameters:

viewMode - the view mode

Returns:

the name of the visualization that matches the specified view mode

getAllVisualizationsJson

public java.lang.String getAllVisualizationsJson(Messages messages)

Deprecated.

use getAllVisualizationsJson(Messages) as its more efficient

Returns a String that defines a JSON object used to pass the list of all visualizations to the client side

Parameters:

messages - The Messages object

Returns:

a String that defines a JSON object used to pass the list of all visualizations to the client side

Since:

MicroStrategy Web 9.0.1

generateAllVisualizationsJson

public GenericJsonGenerator generateAllVisualizationsJson(Messages messages)

Returns a JSONGenerator object used to pass the list of all visualizations to the client side

Parameters:

messages - The Messages object

Returns:

a JSONGenerator object used to pass the list of all visualizations to the client side

generateVisualizationsJson

public GenericJsonGenerator generateVisualizationsJson(Messages messages,
                                                       VisualizationList visList)

Returns a JSONGenerator object used to pass the list of all visualizations to the client side

Parameters:

messages - The Messages object

visList - the list used to build the JSON

Returns:

a JSONGenerator object used to pass the list of all visualizations to the client side