Package com.microstrategy.web.config

Class VisualizationList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.config.VisualizationList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class VisualizationList
extends AbstractConfigurationElementList

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

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
protected static java.lang.String	ATT_NAME	xml attribute name for the name of the visualization-list
protected static java.lang.String	ATT_SHOW_IN_WEB	xml attribute name for the show-in-web property of the visualization-list
protected static java.lang.String	ATT_VIEW_MODE	xml attribute name for the view-mode of the visualization-list
static java.lang.String	NODE_VISUALIZATION_LIST

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
VisualizationList()

Method Summary

Modifier and Type	Method	Description
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	getName()	Returns the name of the visualization list.
java.lang.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(int index)	Returns a Visualization from the visualization list with the index specified
Visualization	getVisualization(java.lang.String key)	Returns a Visualization from the visualization list with the key specified
Visualization	newVisualization(java.lang.String styleName, java.lang.String description)	Creates a new visualization and adds it to the list of visualizations that belong to this list.
void	put(java.lang.Object key, ConfigurationElement element)	Add an element to the collection
protected void	setElement(java.lang.Object key, ConfigurationElement child)	Allows users to add or replace an element.
void	setName(java.lang.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

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

clear, clone, get, get, getFilteredList, getKey, getList, getValues, getVersion, init, isEmpty, 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, 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, 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_VISUALIZATION_LIST

public static final java.lang.String NODE_VISUALIZATION_LIST

See Also:

Constant Field Values

ATT_NAME

protected static final java.lang.String ATT_NAME

xml attribute name for the name of the visualization-list

See Also:

Constant Field Values

ATT_VIEW_MODE

protected static final java.lang.String ATT_VIEW_MODE

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

See Also:

Constant Field Values

ATT_SHOW_IN_WEB

protected static final java.lang.String ATT_SHOW_IN_WEB

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

See Also:

Constant Field Values

Constructor Detail

VisualizationList

public VisualizationList()

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

put

public void put(java.lang.Object key,
                ConfigurationElement element)

Add an element to the collection

Specified by:

put in interface ConfigurationElementList

Overrides:

put in class AbstractConfigurationElementList

Parameters:

key - the key of the object

element - the configelement to add

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.

Overrides:

getKeyAttribute in class AbstractConfigurationElementList

getName

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

setName

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

getViewMode

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.

setViewMode

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.

getShowInWeb

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.

setShowInWeb

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.

newVisualization

public Visualization newVisualization(java.lang.String styleName,
                                      java.lang.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.

getVisualization

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

getVisualization

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

sort

public void sort(boolean accending,
                 Messages msgs)

Sorts the list of visualizations

Parameters:

accending - whether to sort ascending or descending

setElement

protected void setElement(java.lang.Object key,
                          ConfigurationElement child)

Description copied from class: AbstractConfigurationElement

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.

Overrides:

setElement in class AbstractConfigurationElement