public class

VisualizationList

extends AbstractConfigurationElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.config.VisualizationList

Class Overview

This class represents a visualization list node of the visualizations.xml.
Contains a collection of Visualization

Summary

Constants
String ATT_NAME xml attribute name for the name of the visualization-list
String ATT_SHOW_IN_WEB xml attribute name for the show-in-web property of the visualization-list
String ATT_VIEW_MODE xml attribute name for the view-mode of the visualization-list
String NODE_VISUALIZATION_LIST
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
VisualizationList()
Public Methods
String getName()
Returns the name of the visualization list.
String getNodeName()
Returns the node-name for this element.
boolean getShowInWeb()
Whether the list is supposed to be displayed in Web.
int getViewMode()
Returns the view mode for the VisualizationList.
Visualization getVisualization(String key)
Returns a Visualization from the visualization list with the key specified
Visualization getVisualization(int index)
Returns a Visualization from the visualization list with the index specified
Visualization newVisualization(String styleName, String description)
Creates a new visualization and adds it to the list of visualizations that belong to this list.
void put(Object key, ConfigurationElement element)
Add an element to the collection
void setName(String name)
Sets the name of the visualization list.
void setShowInWeb(boolean value)
Sets Whether the list is supposed to be displayed in Web.
void setViewMode(int value)
Sets the view mode for the VisualizationList.
void sort(boolean accending, Messages msgs)
Sorts the list of visualizations
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.
void setElement(Object key, ConfigurationElement child)
Allows users to add or replace an element.
[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

protected static final String ATT_NAME

xml attribute name for the name of the visualization-list

Constant Value: "name"

protected static final String ATT_SHOW_IN_WEB

xml attribute name for the show-in-web property of the visualization-list

Constant Value: "show-in-web"

protected static final String ATT_VIEW_MODE

xml attribute name for the view-mode of the visualization-list

Constant Value: "view-mode"

public static final String NODE_VISUALIZATION_LIST

Constant Value: "visualization-list"

Public Constructors

public VisualizationList ()

Public Methods

public String getName ()

Returns the name of the visualization list.
This name will be used to show a different icon while folder browsing and on the hostory list

Returns
  • the name of the visualization list.

public String getNodeName ()

Returns the node-name for this element.

public boolean getShowInWeb ()

Whether the list is supposed to be displayed in Web.
False for mobile.

Returns
  • Whether the list is supposed to be displayed in Web.

public int getViewMode ()

Returns the view mode for the VisualizationList.
This value will be used to display a specific icon while folder browsing.
The values should not overlap with the values from EnumWebReportViewMode

Returns
  • the view mode.

public Visualization getVisualization (String key)

Returns a Visualization from the visualization list with the key specified

Parameters
key the key of the Visualization
Returns
  • a Visualization from the visualization list with the key specified

public Visualization getVisualization (int index)

Returns a Visualization from the visualization list with the index specified

Parameters
index the index of the Visualization
Returns
  • a Visualization from the visualization list with the index specified

public Visualization newVisualization (String styleName, String description)

Creates a new visualization and adds it to the list of visualizations that belong to this list.

Parameters
styleName The style name associated with this visualization
Returns
  • The new visualization instance.

public void put (Object key, ConfigurationElement element)

Add an element to the collection

Parameters
key the key of the object
element the configelement to add

public void setName (String name)

Sets the name of the visualization list.
This name will be used to show a different icon while folder browsing and on the hostory list

Parameters
name the name of the visualization list

public void setShowInWeb (boolean value)

Sets Whether the list is supposed to be displayed in Web.
False for mobile.

Parameters
value Whether the list is supposed to be displayed in Web.

public void setViewMode (int value)

Sets the view mode for the VisualizationList.
This value will be used to display a specific icon while folder browsing.
The values should not overlap with the values from EnumWebReportViewMode

Parameters
value The view mode.

public void sort (boolean accending, Messages msgs)

Sorts the list of visualizations

Parameters
accending whether to sort ascending or descending

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.

protected void setElement (Object key, ConfigurationElement child)

Allows users to add or replace an element. If an element with the given key already exists it gets replaced, otherwise it's simply added.