public class

ShortcutArgument

extends AbstractConfigurationElement

java.lang.Object
↳	com.microstrategy.utils.config.AbstractConfigurationElement
	↳	com.microstrategy.web.app.ShortcutArgument

Class Overview

The Shortcut class encapsulates information that can be displayed as option or shortcut for a given page.

Summary

Constants
String	ATT_BASE_BEAN
String	ATT_ENUMNAME
String	ATT_NAME
String	ATT_SOURCE
String	ATT_SYS_BEAN
String	ATT_VALUE
String	NODE_ARGUMENT	the constant for the shortcut argument

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	ShortcutArgument() Class constructor.
	ShortcutArgument(String name, String value) Class constructor.
	ShortcutArgument(String name, String value, String baseBean, String sysBean) Class constructor.
	ShortcutArgument(String name, String source, String enumname) Class constructor.
	ShortcutArgument(Node root) Class constructor.

Public Methods
String	getBaseBean() get the base bean name associated with the argument
String	getEnumName() if the value of the argument is taken from an enumerations value, it represents the fully-qualified name of such a value.
String	getName() Get the name of the Shortcut instance
String	getSource() Indicates how to calculate the runtime value of the argument.
String	getSysBean() Returns the fully-qualified name of the beans class to which the base bean is cast when the value of the argument comes from a method name of the base bean.
String	getValue() Returns the value of this argument as stored in the configuration file.
String	resolveValue() Returns the runtime value of the argument.
void	setBaseBean(String value) Sets the baseBean name associated with the argument
void	setEnumName(String value) if the value of the argument is taken from an enumerations value, it represents the fully-qualified name of such a value.
void	setName(String name) Set the name of the Shortcut instance
void	setSource(String value) Indicates how to calculate the runtime value of the argument.
void	setSysBean(String value) Represents the fully-qualified name of the interface to which the base bean is cast when the value of the argument comes from a method name of the base bean.
void	setValue(String value) Sets the value of the argument.

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)
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.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
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, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
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, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) 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, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) 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) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) 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(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
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(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(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM 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`.
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

public static final String ATT_BASE_BEAN

Constant Value: "base-bean"

public static final String ATT_ENUMNAME

Constant Value: "enumname"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_SOURCE

Constant Value: "source"

public static final String ATT_SYS_BEAN

Constant Value: "sys-bean"

public static final String ATT_VALUE

Constant Value: "value"

public static final String NODE_ARGUMENT

the constant for the shortcut argument

Constant Value: "argument"

Public Constructors

public ShortcutArgument ()

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

public ShortcutArgument (String name, String value)

Class constructor. Initializes a new instance of the Shortcut class with the information given as parameters

Parameters

name	unique name -identifier- for the shortcut argument.
value	.Value of the shortcut argument.

public ShortcutArgument (String name, String value, String baseBean, String sysBean)

Class constructor. Initializes a new instance of the Shortcut class with the information given as parameters

Parameters

name	unique name -identifier- for the shortcut argument.
value	. Value of the shortcut argument.
baseBean	. Base bean from which the argument value is to be taken.
sysBean	. Sys Bean Name of the Base bean from which the argument value is to be taken.

public ShortcutArgument (String name, String source, String enumname)

Class constructor. Initializes a new instance of the Shortcut class with the information given as parameters

Parameters

name	unique name -identifier- for the shortcut argument.
source	. Source of the value. It can be constant or enumeration as of now.
enumname	. Name of the Enumeration for the value.

public ShortcutArgument (Node root)

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

Parameters

root	Node instance representing the Shortcut information.

Public Methods

public String getBaseBean ()

get the base bean name associated with the argument

Returns

the baseBean name associated with the argument

public String getEnumName ()

if the value of the argument is taken from an enumerations value, it represents the fully-qualified name of such a value.

public String getName ()

Get the name of the Shortcut instance

Returns

the String value of the name property.

public String getSource ()

Indicates how to calculate the runtime value of the argument.

public String getSysBean ()

Returns the fully-qualified name of the beans class to which the base bean is cast when the value of the argument comes from a method name of the base bean.

public String getValue ()

Returns the value of this argument as stored in the configuration file. If you need the value of the argument as resolved at runtime, use the resolveValue() method.

public String resolveValue ()

Returns the runtime value of the argument. This is done here so that we do it only once at start up and not on each report execution.

If the source is "enum", it returns the value using the "enumname" property. Notice there can be a list of Enumerations seperated by a semicolon ";". If such is the case we will append all the enumerations as the value of the argument.

If the source is "action", it assumes "value" represents a fully qualified constant name and returns the value of the constant followed by "_".

Otherwise, it returns the value of the "value" property.

public void setBaseBean (String value)

Sets the baseBean name associated with the argument

Parameters

value	indicates the baseBean name associated with the argument

public void setEnumName (String value)

if the value of the argument is taken from an enumerations value, it represents the fully-qualified name of such a value.

public void setName (String name)

Set the name of the Shortcut instance

Parameters

name	the `String` value of the name property - unique identifier of the Shortcut instance.

public void setSource (String value)

Indicates how to calculate the runtime value of the argument.

public void setSysBean (String value)

Represents the fully-qualified name of the interface to which the base bean is cast when the value of the argument comes from a method name of the base bean.

public void setValue (String value)

Sets the value of the argument. tThe meaning of the attribute depends on the base-bean and the source attributes:

if base-bean is specified, this attribute represents the name of a bean property; the value of the argument becomes the value of the bean property.
if source=action, this value represents the fully qualified name of a constant (for example: "com.microstrategy.web.app.beans.FilterEditorBean.L_ACTION_APPLY_EDIT_EXPRESSION"); the value of the argument becomes the value of the constant followed by '_'.
if source=enum, this value is ignored; the value of the argument becomes the value of the constant specified by the enumname attribute
otherwise, this value is used literally as the value of the argument.

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

ShortcutArgument

Class Overview

Summary

Constants

public static final String ATT_BASE_BEAN

public static final String ATT_ENUMNAME

public static final String ATT_NAME

public static final String ATT_SOURCE

public static final String ATT_SYS_BEAN

public static final String ATT_VALUE

public static final String NODE_ARGUMENT

Public Constructors

public ShortcutArgument ()

public ShortcutArgument (String name, String value)

Parameters

public ShortcutArgument (String name, String value, String baseBean, String sysBean)

Parameters

public ShortcutArgument (String name, String source, String enumname)

Parameters

public ShortcutArgument (Node root)

Parameters

Public Methods

public String getBaseBean ()

Returns

public String getEnumName ()

See Also

public String getName ()

Returns

public String getSource ()

See Also

public String getSysBean ()

public String getValue ()

public String resolveValue ()

public void setBaseBean (String value)

Parameters

public void setEnumName (String value)

See Also

public void setName (String name)

Parameters

public void setSource (String value)

See Also

public void setSysBean (String value)

public void setValue (String value)

Protected Methods

protected String getKeyAttribute ()