public class

Visualization

extends AbstractConfigurationElement

java.lang.Object
↳	com.microstrategy.utils.config.AbstractConfigurationElement
	↳	com.microstrategy.web.config.Visualization

Class Overview

This class represents a visualization node of the visualizations.xml
A Visualization is a way to display the report/document data. Its name must match a style name from the style catalog.

Summary

Constants
String	ATT_ATTRIBUTE_MINIMUM	The minimum number of attributes required by the visualization
String	ATT_DESC	xml attribute name for the description of the visualization
String	ATT_DESC_ID	xml attribute name for the descriptor ID of the visualization
String	ATT_DROP_ZONES	The class name of the drop zones to a certain customized visualization
String	ATT_EDITOR_MODEL	The class name of the editor model to a certain customized visualization
String	ATT_FEATURE_ID	Feature ID that indicates whether this visualization is enabled
String	ATT_ID	xml attribute name for the id of the visualization
String	ATT_IMAGE	xml attribute name for visualization's image
String	ATT_INCLUDE_MD_PROPERTIES	xml attribute name for including the metadata properties on the visualization's XML
String	ATT_IS_MOJO	Whether the visualization is rendered using a mojo class.
String	ATT_MAX_SECONDARY_PROVIDERS	xml attribute name for the maximum number of secondary data providers
String	ATT_METRIC_MINIMUM	The minimum number of metrics required by the visualization
String	ATT_MIN_SECONDARY_PROVIDERS	xml attribute name for the minimum number of secondary data providers
String	ATT_PROJECTS	xml attribute name for the list of projects that the visualization applies to.
String	ATT_PROPS_EDITOR	xml attribute name for the block that defines the layout of the visualization properties editor
String	ATT_SCOPE	xml attribute name for the scope of the visualization
String	ATT_STYLE_NAME	xml attribute name for the style-name of the visualization
String	ATT_SUBTYPES	The visualizations subtypes.
String	ATT_WIDGET_TYPE	The widget type of this visualization (used on dashboards)
String	NODE_VISUALIZATION	constant for the shortcut list node name
int	SCOPE_ALL
int	SCOPE_DASHBOARD
int	SCOPE_REPORT
int	SCOPE_RW
int	SCOPE_RW_GRID
int	SCOPE_RW_LAYOUT

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	Visualization(Node root) Creates a Visualization with the information in the Xml Node.
	Visualization(Node root, VisualizationList parentNode) This constructor is deprecated. use `Visualization(Node)` instead
	Visualization()
	Visualization(String styleName, String description, VisualizationList parentNode) This constructor is deprecated. use `Visualization(String, String)` instead.
	Visualization(String styleName, String description)

Public Methods
String	getAttributeMinimum() The minimum number of attributes required by the visualization
String	getDescriptor() Get the identifier of the descriptor to be used for the visualization
String	getDescriptorId() Get the identifier of the descriptor to be used for the visualization
String	getDropZones() The class name of the drop zones to a certain customized visualization
String	getEditorModel() The class name of the editor model to a certain customized visualization
String	getFeatureID()
String	getId() An ID attribute used to link a visualization with a widget if the IDs are the same.
String	getImage()
String	getIncludeMDProperties() Whether to include the metadata properties on the visualization's XML
Object	getKey() Default implementation for `getKey()`.
int	getMaxSecondaryProviders()
String	getMetricMinimum() The minimum number of metrics required by the visualization
int	getMinSecondaryProviders()
String[]	getProjectList()
String	getProjects() Get the list of projects that the visualization applies to.
String	getPropsEditor()
int	getScope() A bitwise flag that the termines what type of object does this visualization applies to: `SCOPE_REPORT` `SCOPE_RW_GRID` `SCOPE_RW`
boolean	getShowInWeb() Whether the object is supposed to be displayed in Web.
String	getStyleName() Get the style-name for this visualization.
String	getSubtypes() The visualizations subtypes.
int	getViewMode() Returns the view mode from the parent `VisualizationList`.
String	getWidgetType() The widget type of this visualization
static boolean	isESRIMapVisualization(String styleName)
boolean	isMojo()
static boolean	isObjectInVisualizationMode(int visMode)
boolean	isValid(int viewMode, int scope, WebIServerSession session, WebComponent bean) Validates a visualization based on the viewMode, scope and session provided.
boolean	isValid(int viewMode, int scope, WebIServerSession session) Validates a visualization based on the viewMode, scope and session provided.
static int	resolveVisualizationViewModeFromAbbreviation(String abbreviation)
void	setAttributeMinimum(String value) Sets the minimum number of attributes required by the visualization
void	setDescriptor(String descriptor) Set the descriptor property value of the visualization instance
void	setDescriptorID(String descriptorID) Set the identifier of the descriptor to be used for the visualization
void	setDropZones(String value) The class name of the drop zones to a certain customized visualization
void	setEditorModel(String value) The class name of the editor model to a certain customized visualization
void	setFeatureID(String value) Sets the visualization's feature id that indicates whether this visualization is enabled
void	setId(String value) Sets the visualization's id.
void	setImage(String value) Sets the visualization's image
void	setIncludeMDProperties(String includeMDProperties) Whether to include the metadata properties on the visualization's XML
void	setIsMojo(boolean value) Sets the is-mojo flag for the visualization
void	setMaxSecondaryProviders(int value) Sets the maximum number of secondary data providers
void	setMetricMinimum(String value) Set the minimum number of metrics required by the visualization
void	setMinSecondaryProviders(int value) Sets the minimum number of secondary data providers
void	setProjects(String projects) Sets the list of projects that the visualization applies to.
void	setPropsEditor(String value) Sets the name of the style that renders the visualization's properties editor properties editor
void	setScope(int scope) Sets a bitwise flag that the termines what type of object does this visualization applies to: `SCOPE_REPORT` `SCOPE_RW_GRID` `SCOPE_RW`
void	setShowInWeb(boolean showInWeb) Whether the object is supposed to be displayed in Web.
void	setStyleName(String name) Sets the name for this visualization.
void	setViewMode(int viewMode) Returns the view mode from the parent `VisualizationList`.
void	setWidgetType(String value) The widget type of this visualization

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.

[Expand]

Inherited Methods

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

Constants

protected static final String ATT_ATTRIBUTE_MINIMUM

The minimum number of attributes required by the visualization

Constant Value: "attribute-minimum"

protected static final String ATT_DESC

xml attribute name for the description of the visualization

Constant Value: "desc"

protected static final String ATT_DESC_ID

xml attribute name for the descriptor ID of the visualization

Constant Value: "desc-id"

protected static final String ATT_DROP_ZONES

The class name of the drop zones to a certain customized visualization

Constant Value: "drop-zones"

protected static final String ATT_EDITOR_MODEL

The class name of the editor model to a certain customized visualization

Constant Value: "editor-model"

protected static final String ATT_FEATURE_ID

Feature ID that indicates whether this visualization is enabled

Constant Value: "feature-id"

protected static final String ATT_ID

xml attribute name for the id of the visualization

Constant Value: "id"

protected static final String ATT_IMAGE

xml attribute name for visualization's image

Constant Value: "image"

protected static final String ATT_INCLUDE_MD_PROPERTIES

xml attribute name for including the metadata properties on the visualization's XML

Constant Value: "includeMDProperties"

protected static final String ATT_IS_MOJO

Whether the visualization is rendered using a mojo class.

Constant Value: "is-mojo"

protected static final String ATT_MAX_SECONDARY_PROVIDERS

xml attribute name for the maximum number of secondary data providers

Constant Value: "maxSecondaryProviders"

protected static final String ATT_METRIC_MINIMUM

The minimum number of metrics required by the visualization

Constant Value: "metric-minimum"

protected static final String ATT_MIN_SECONDARY_PROVIDERS

xml attribute name for the minimum number of secondary data providers

Constant Value: "minSecondaryProviders"

protected static final String ATT_PROJECTS

xml attribute name for the list of projects that the visualization applies to.
The list should be separated by pipe "|"

Constant Value: "projects"

protected static final String ATT_PROPS_EDITOR

xml attribute name for the block that defines the layout of the visualization properties editor

Constant Value: "propsEditor"

protected static final String ATT_SCOPE

xml attribute name for the scope of the visualization

Constant Value: "scope"

protected static final String ATT_STYLE_NAME

xml attribute name for the style-name of the visualization

Constant Value: "style-name"

protected static final String ATT_SUBTYPES

The visualizations subtypes. Used for the graph matrix in dashboards

Constant Value: "subtypes"

protected static final String ATT_WIDGET_TYPE

The widget type of this visualization (used on dashboards)

Constant Value: "widget-type"

public static final String NODE_VISUALIZATION

constant for the shortcut list node name

Constant Value: "visualization"

public static final int SCOPE_ALL

Constant Value: -1 (0xffffffff)

public static final int SCOPE_DASHBOARD

Constant Value: 16 (0x00000010)

public static final int SCOPE_REPORT

Constant Value: 1 (0x00000001)

public static final int SCOPE_RW

Constant Value: 4 (0x00000004)

public static final int SCOPE_RW_GRID

Constant Value: 2 (0x00000002)

public static final int SCOPE_RW_LAYOUT

Constant Value: 8 (0x00000008)

Public Constructors

public Visualization (Node root)

Creates a Visualization with the information in the Xml Node. Internally it calls initFromXML(Node).

Parameters

root	the xml node.

public Visualization (Node root, VisualizationList parentNode)

This constructor is deprecated.
use Visualization(Node) instead

Creates a Visualization with the information in the Xml Node. Internally it calls initFromXML(Node).

Parameters

root	the xml node.

public Visualization ()

public Visualization (String styleName, String description, VisualizationList parentNode)

This constructor is deprecated.
use Visualization(String, String) instead.

Constructor

public Visualization (String styleName, String description)

Public Methods

public String getAttributeMinimum ()

The minimum number of attributes required by the visualization

public String getDescriptor ()

Get the identifier of the descriptor to be used for the visualization

Returns

the String value of the descriptor identifier property.

public String getDescriptorId ()

Get the identifier of the descriptor to be used for the visualization

Returns

the String value of the descriptor identifier property.

public String getDropZones ()

The class name of the drop zones to a certain customized visualization

public String getEditorModel ()

The class name of the editor model to a certain customized visualization

public String getFeatureID ()

Returns

the visualization's feature id that indicates whether this visualization is enabled

public String getId ()

An ID attribute used to link a visualization with a widget if the IDs are the same. This is not the ID of the item on the Visualization list.

Returns

the visualization's id.

public String getImage ()

Returns

the visualization's image

public String getIncludeMDProperties ()

Whether to include the metadata properties on the visualization's XML

public Object getKey ()

Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.

Returns

If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

public int getMaxSecondaryProviders ()

Returns

the maximum number of secondary data providers

public String getMetricMinimum ()

The minimum number of metrics required by the visualization

public int getMinSecondaryProviders ()

Returns

the minimum number of secondary data providers

public String[] getProjectList ()

Returns

the list of projects that the visualization applies to.

public String getProjects ()

Get the list of projects that the visualization applies to.
The list should be separated by pipe "|"

Returns

the String value of the projects property.

public String getPropsEditor ()

Returns

the name of the style that renders the visualization properties editor properties editor

public int getScope ()

A bitwise flag that the termines what type of object does this visualization applies to: SCOPE_REPORT SCOPE_RW_GRID SCOPE_RW

Returns

A bitwise flag that the termines what type of object does this visualization applies to.

public boolean getShowInWeb ()

Whether the object is supposed to be displayed in Web.
This property is read from the VisualizationList False for mobile.

Returns

Whether the object is supposed to be displayed in Web.

public String getStyleName ()

Get the style-name for this visualization.
This name must be unique on the visualization list and must match to the name of a style in the style catalog.

Returns

the String value of the name property.

public String getSubtypes ()

The visualizations subtypes. Used for the graph matrix in dashboards

public int getViewMode ()

Returns the view mode from the parent 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 String getWidgetType ()

The widget type of this visualization

public static boolean isESRIMapVisualization (String styleName)

public boolean isMojo ()

Returns

if the visualization supports mojo

public static boolean isObjectInVisualizationMode (int visMode)

public boolean isValid (int viewMode, int scope, WebIServerSession session, WebComponent bean)

Validates a visualization based on the viewMode, scope and session provided.

Parameters

viewMode	the view mode to validate (-1 means all view modes)
scope	the scope to validate (-1 means all scopes)
session	the session used to validate the project (null means ignore)
bean	used to evaluate a feature

Returns

whether the visualization is valid

public boolean isValid (int viewMode, int scope, WebIServerSession session)

Validates a visualization based on the viewMode, scope and session provided.

Parameters

viewMode	the view mode to validate (-1 means all view modes)
scope	the scope to validate (-1 means all scopes)
session	the session used to validate the project (null means ignore)

Returns

whether the visualization is valid

public static int resolveVisualizationViewModeFromAbbreviation (String abbreviation)

public void setAttributeMinimum (String value)

Sets the minimum number of attributes required by the visualization

public void setDescriptor (String descriptor)

Set the descriptor property value of the visualization instance

Parameters

descriptor	the `String` value of the descriptor property.

public void setDescriptorID (String descriptorID)

Set the identifier of the descriptor to be used for the visualization

Parameters

descriptorID	the `String` value of the descriptor identifier property.

public void setDropZones (String value)

The class name of the drop zones to a certain customized visualization

public void setEditorModel (String value)

The class name of the editor model to a certain customized visualization

public void setFeatureID (String value)

Sets the visualization's feature id that indicates whether this visualization is enabled

Parameters

value	the visualization's feature

public void setId (String value)

Sets the visualization's id. An ID attribute used to link a visualization with a widget if the IDs are the same. This is not the ID of the item on the Visualization list.

Parameters

value	the visualization's ID

public void setImage (String value)

Sets the visualization's image

Parameters

value	the visualization's image

public void setIncludeMDProperties (String includeMDProperties)

Whether to include the metadata properties on the visualization's XML

public void setIsMojo (boolean value)

Sets the is-mojo flag for the visualization

Parameters

value	boolean value if the style supports mojo

public void setMaxSecondaryProviders (int value)

Sets the maximum number of secondary data providers

Parameters

value	the maximum number of secondary data providers

public void setMetricMinimum (String value)

Set the minimum number of metrics required by the visualization

public void setMinSecondaryProviders (int value)

Sets the minimum number of secondary data providers

Parameters

value	the minimum number of secondary data providers

public void setProjects (String projects)

Sets the list of projects that the visualization applies to.
The list should be separated by pipe "|"

Parameters

projects	the list or projects

public void setPropsEditor (String value)

Sets the name of the style that renders the visualization's properties editor properties editor

Parameters

value	the name of style

public void setScope (int scope)

Sets a bitwise flag that the termines what type of object does this visualization applies to: SCOPE_REPORT SCOPE_RW_GRID SCOPE_RW

Parameters

scope	the flag

public void setShowInWeb (boolean showInWeb)

Whether the object is supposed to be displayed in Web.
This property is read from the VisualizationList False for mobile.

public void setStyleName (String name)

Sets the name for this visualization.
This name must be unique on the visualization list and must match to the name of a style in the style catalog.

public void setViewMode (int viewMode)

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

public void setWidgetType (String value)

The widget type of this visualization

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.

Classes

Visualization

Class Overview

Summary

Constants

protected static final String ATT_ATTRIBUTE_MINIMUM

protected static final String ATT_DESC

protected static final String ATT_DESC_ID

protected static final String ATT_DROP_ZONES

protected static final String ATT_EDITOR_MODEL

protected static final String ATT_FEATURE_ID

protected static final String ATT_ID

protected static final String ATT_IMAGE

protected static final String ATT_INCLUDE_MD_PROPERTIES

protected static final String ATT_IS_MOJO

protected static final String ATT_MAX_SECONDARY_PROVIDERS

protected static final String ATT_METRIC_MINIMUM

protected static final String ATT_MIN_SECONDARY_PROVIDERS

protected static final String ATT_PROJECTS

protected static final String ATT_PROPS_EDITOR

protected static final String ATT_SCOPE

protected static final String ATT_STYLE_NAME

protected static final String ATT_SUBTYPES

protected static final String ATT_WIDGET_TYPE

public static final String NODE_VISUALIZATION

public static final int SCOPE_ALL

public static final int SCOPE_DASHBOARD

public static final int SCOPE_REPORT

public static final int SCOPE_RW

public static final int SCOPE_RW_GRID

public static final int SCOPE_RW_LAYOUT

Public Constructors

public Visualization (Node root)

Parameters

public Visualization (Node root, VisualizationList parentNode)

Parameters

public Visualization ()

public Visualization (String styleName, String description, VisualizationList parentNode)

public Visualization (String styleName, String description)

Public Methods

public String getAttributeMinimum ()

public String getDescriptor ()

Returns

public String getDescriptorId ()

Returns

public String getDropZones ()

public String getEditorModel ()

public String getFeatureID ()

Returns

public String getId ()

Returns

public String getImage ()

Returns

public String getIncludeMDProperties ()

public Object getKey ()

Returns

public int getMaxSecondaryProviders ()

Returns

public String getMetricMinimum ()

public int getMinSecondaryProviders ()

Returns

public String[] getProjectList ()

Returns

public String getProjects ()

Returns

public String getPropsEditor ()

Returns

public int getScope ()

Returns

public boolean getShowInWeb ()

Returns

public String getStyleName ()

Returns

public String getSubtypes ()

public int getViewMode ()

Returns

public String getWidgetType ()

public static boolean isESRIMapVisualization (String styleName)

public boolean isMojo ()

Returns