public class

Visualizations

extends AbstractConfigurationElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.config.Visualizations
Known Direct Subclasses

Class Overview

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.

Summary

Constants
String NODE_VISUALIZATIONS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
Visualizations()
Visualizations(Node root)
Public Methods
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(int scope)
This method is deprecated. use getAllVisualizations() and filter out each visualization using (@link Visualization.isValid())
VisualizationList getAllVisualizations()
String getAllVisualizationsJson(Messages messages)
This method is deprecated. use getAllVisualizationsJson(Messages) as its more efficient
VisualizationList getAllWebVisualizations()
String getNodeName()
Returns the node-name for this element.
VisualizationList getVisualizationList(Object key)
VisualizationList getVisualizationList(int index)
VisualizationList getVisualizationListForViewMode(int viewMode)
VisualizationList getVisualizationListFromNames(String[] visualizationNames)
Returns a list of visualizations generated from list of visualization names
String getVisualizationListName(int viewMode)
Return the name of the visualization that matches the specified view mode
Protected Methods
void initFromFile(String filePath, CustomizationInfo c)
Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.
[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 NODE_VISUALIZATIONS

Constant Value: "visualizations"

Public Constructors

public Visualizations ()

public Visualizations (Node root)

Public Methods

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

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

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

public VisualizationList getAllVisualizations (int scope)

This method is 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

public VisualizationList getAllVisualizations ()

Returns
  • a list with all visualizations from all visualizations lists

public String getAllVisualizationsJson (Messages messages)

This method is 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

public VisualizationList getAllWebVisualizations ()

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

public String getNodeName ()

Returns the node-name for this element.

public VisualizationList getVisualizationList (Object key)

Parameters
key the key (i.e. "flash") of the visualization list to return
Returns
  • the visualization list specified

public VisualizationList getVisualizationList (int index)

Parameters
index the index of the visualization list to return
Returns
  • the visualization list specified

public VisualizationList getVisualizationListForViewMode (int viewMode)

Parameters
viewMode the view mode of the visualization list to return (from EnumWebVisualizationViewModes)
Returns
  • the visualization list specified

public VisualizationList getVisualizationListFromNames (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

public 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

Protected Methods

protected void initFromFile (String filePath, CustomizationInfo c)

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