public class

EventMapList

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

Class Overview

The EventMapList class is a collection of EventMaps instances that holds information about how to map events. For more information about EventMapping, please check documention of the EventMap class.

Summary

Constants
String NODE_EVENT_MAPS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
EventMapList()
Class constructor.
EventMapList(Node root)
Class constructor.
EventMapList(Document doc)
Class constructor.
Public Methods
EventMap getEventMap(int eventId)
Retrieve a EventMap by the eventId it maps.
[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_EVENT_MAPS

Constant Value: "event-maps"

Public Constructors

public EventMapList ()

Class constructor. Initializes a new -empty- instance of the EventMapList class.

public EventMapList (Node root)

Class constructor. Initializes a EventMapList instance based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.

public EventMapList (Document doc)

Class constructor. Initializes a EventMapList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.

Public Methods

public EventMap getEventMap (int eventId)

Retrieve a EventMap by the eventId it maps. If there are several maps for the given id, it returns the first on the list.

Parameters
eventId The id of the event to map.
Returns
  • the EventMap associated with the given event Id