public class

EventInfo

extends AbstractConfigurationElement

java.lang.Object
↳	com.microstrategy.utils.config.AbstractConfigurationElement
	↳	com.microstrategy.web.beans.EventInfo

Class Overview

This class represents the "event" node from the XML. Each event is identified by its id and holds a list of all the arguments associated with the event. Children : The arguments node which holds the list of all the arguments. Attributes: "id" - The event id "name" - The name of the event "target" - The target for the event "event-class" - A fully qualified class name of the concrete WebEvent that should be instantiated for this event. Key : "id" attribute.

Summary

Constants
String	ATT_DEPRECATED
String	ATT_EVENT_CLASS
String	ATT_ID
String	ATT_NAME
String	ATT_TARGET
String	ATT_WINDOW
String	NODE_EVENT

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	EventInfo() Default constructor.
	EventInfo(int id) Constructor: Set the id field for the event
	EventInfo(int id, String name) Set the id and name for the event
	EventInfo(int id, String name, String target) Set the id, name and target for the event

Public Methods
void	deleteArgument(int id) Delete the argument with the given id.
EventArgumentInfo	getArgument(int argID) Return the event argument with the given id from the arguments list
EventArgumentInfoList	getArguments() Return the list of arguments associated with this event
String	getDeprecated() Returns the deprecated field value.
String	getEventClass() Returns the fully qualified class name of the a class that implements `WebEvent` and that should be instantiated when creating concrete WebEvent instances for this EventInfo.
int	getID() Return the id field value.
String	getName() Returns the name field value.
String	getTarget() Returns the target field value.
String	getWindow() Returns the window attribute value.
EventArgumentInfo	newArgument(int id) Create a new argument and add it to the arguments list.
void	setDeprecated(String message) Sets the deprecated field value.
void	setEventClass(String value) Indicates the fully qualified class name of the a class that implements `WebEvent` and that should be instantiated when creating concrete WebEvent instances for this EventInfo.
void	setID(int id) Sets the id field value.
void	setName(String name) Sets the name field value.
void	setTarget(String target) Set the target field value.
void	setWindow(String value) Set the window attribute.

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_DEPRECATED

Constant Value: "deprecated"

protected static final String ATT_EVENT_CLASS

Constant Value: "event-class"

protected static final String ATT_ID

Constant Value: "id"

protected static final String ATT_NAME

Constant Value: "name"

protected static final String ATT_TARGET

Constant Value: "target"

protected static final String ATT_WINDOW

Constant Value: "window"

protected static final String NODE_EVENT

Constant Value: "event"

Public Constructors

public EventInfo ()

Default constructor. Set the node name and register the child element

public EventInfo (int id)

Constructor: Set the id field for the event

Parameters

id	The event "id" for this object

public EventInfo (int id, String name)

Set the id and name for the event

Parameters

id	The event "id" for this object
name	The event "name" for this object

public EventInfo (int id, String name, String target)

Set the id, name and target for the event

Parameters

id	The event "id" for this object
name	The event "name" for this object
target	The event "target" for this object

Public Methods

public void deleteArgument (int id)

Delete the argument with the given id. This is a shortcut to EventArgumentInfoList#deleteArgument()

Parameters

id	The id of the argument to be deleted

public EventArgumentInfo getArgument (int argID)

Return the event argument with the given id from the arguments list

Parameters

argID	The id for the argument to be returned

Returns

The event argument with the given id

public EventArgumentInfoList getArguments ()

Return the list of arguments associated with this event

Returns

The arguments list for this event

public String getDeprecated ()

Returns the deprecated field value. When an event is marked as deprecated and the events is used, the deprecated message is log as a warning. The event will still be executed. If the event is not deprecated, this method returns null

public String getEventClass ()

Returns the fully qualified class name of the a class that implements WebEvent and that should be instantiated when creating concrete WebEvent instances for this EventInfo. If an event-class is not specified, is up to the EventHandler to decide what class to use (typically GenericWebEvent).

public int getID ()

Return the id field value. The id uniquely identifies the event across the application.

Returns

The "id" associated with this event

public String getName ()

Returns the name field value. The name can be used to identify the action associated with the event

Returns

The "name" associated with this event

public String getTarget ()

Returns the target field value. The target indicates the bean (if other than the source bean) who should handle the request for this event.

Returns

The "target" associated with this event

public String getWindow ()

Returns the window attribute value. The window identifies the browser's window name where the event should be open when triggered.

public EventArgumentInfo newArgument (int id)

Create a new argument and add it to the arguments list. This is a shortcut method to EventArgumentInfoList#newArgument()

Parameters

id	The id (key) for the new argument to be created

Returns

The new argument created and added to the list with the given id

public void setDeprecated (String message)

Sets the deprecated field value. When an event is marked as deprecated and the events is used, the deprecated message is log as a warning. The event will still be executed.

Parameters

message	The message to display indicating the event has been deprecated.

public void setEventClass (String value)

Indicates the fully qualified class name of the a class that implements WebEvent and that should be instantiated when creating concrete WebEvent instances for this EventInfo.

public void setID (int id)

Sets the id field value. The id most be unique across the application.

Parameters

id	The new value for the "id" attribute

public void setName (String name)

Sets the name field value. Set the name to identify the action associated with this event.

Parameters

name	The new value for the "name" attribute

public void setTarget (String target)

Set the target field value. The target indicates the bean (if other than the source bean) who should handle the request for this event.

Parameters

target	The new value for the "target" attribute

public void setWindow (String value)

Set the window attribute. The window identifies the browser's window name where the event should be open when triggered. To always open in a new window, use "_blank"; if no value is specified it opens in the current window.

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.

Interfaces

Classes

Exceptions

EventInfo

Class Overview

Summary

Constants

protected static final String ATT_DEPRECATED

protected static final String ATT_EVENT_CLASS

protected static final String ATT_ID

protected static final String ATT_NAME

protected static final String ATT_TARGET

protected static final String ATT_WINDOW

protected static final String NODE_EVENT

Public Constructors

public EventInfo ()

public EventInfo (int id)

Parameters

public EventInfo (int id, String name)

Parameters

public EventInfo (int id, String name, String target)

Parameters

Public Methods

public void deleteArgument (int id)

Parameters

public EventArgumentInfo getArgument (int argID)

Parameters

Returns

public EventArgumentInfoList getArguments ()

Returns

public String getDeprecated ()

public String getEventClass ()

public int getID ()

Returns

public String getName ()

Returns

public String getTarget ()

Returns

public String getWindow ()

public EventArgumentInfo newArgument (int id)

Parameters

Returns

public void setDeprecated (String message)

Parameters

public void setEventClass (String value)

public void setID (int id)

Parameters

public void setName (String name)

Parameters

public void setTarget (String target)

Parameters

public void setWindow (String value)

Protected Methods

protected String getKeyAttribute ()