Package com.microstrategy.web.app

Class ShortcutArgument

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.ShortcutArgument

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class ShortcutArgument
extends AbstractConfigurationElement

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

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_BASE_BEAN
static java.lang.String	ATT_ENUMNAME
static java.lang.String	ATT_NAME
static java.lang.String	ATT_SOURCE
static java.lang.String	ATT_SYS_BEAN
static java.lang.String	ATT_VALUE
static java.lang.String	NODE_ARGUMENT	the constant for the shortcut argument

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
ShortcutArgument()	Class constructor.
ShortcutArgument(java.lang.String name, java.lang.String value)	Class constructor.
ShortcutArgument(java.lang.String name, java.lang.String source, java.lang.String enumname)	Class constructor.
ShortcutArgument(java.lang.String name, java.lang.String value, java.lang.String baseBean, java.lang.String sysBean)	Class constructor.
ShortcutArgument(org.w3c.dom.Node root)	Class constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseBean()	get the base bean name associated with the argument
java.lang.String	getEnumName()	if the value of the argument is taken from an enumerations value, it represents the fully-qualified name of such a value.
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()	Get the name of the Shortcut instance
java.lang.String	getSource()	Indicates how to calculate the runtime value of the argument.
java.lang.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.
java.lang.String	getValue()	Returns the value of this argument as stored in the configuration file.
java.lang.String	resolveValue()	Returns the runtime value of the argument.
void	setBaseBean(java.lang.String value)	Sets the baseBean name associated with the argument
void	setEnumName(java.lang.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(java.lang.String name)	Set the name of the Shortcut instance
void	setSource(java.lang.String value)	Indicates how to calculate the runtime value of the argument.
void	setSysBean(java.lang.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(java.lang.String value)	Sets the value of the argument.

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

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, 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, getNodeName, 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, setElement, 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

Field Detail

NODE_ARGUMENT

public static final java.lang.String NODE_ARGUMENT

the constant for the shortcut argument

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_ENUMNAME

public static final java.lang.String ATT_ENUMNAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_SOURCE

public static final java.lang.String ATT_SOURCE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_VALUE

public static final java.lang.String ATT_VALUE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_SYS_BEAN

public static final java.lang.String ATT_SYS_BEAN

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_BASE_BEAN

public static final java.lang.String ATT_BASE_BEAN

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

ShortcutArgument

public ShortcutArgument()

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

ShortcutArgument

public ShortcutArgument(java.lang.String name,
                        java.lang.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.

ShortcutArgument

public ShortcutArgument(java.lang.String name,
                        java.lang.String value,
                        java.lang.String baseBean,
                        java.lang.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.

ShortcutArgument

public ShortcutArgument(java.lang.String name,
                        java.lang.String source,
                        java.lang.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.

ShortcutArgument

public ShortcutArgument(org.w3c.dom.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.

Method Detail

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Get the name of the Shortcut instance

Returns:

the String value of the name property.

setName

public void setName(java.lang.String name)

Set the name of the Shortcut instance

Parameters:

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

setBaseBean

public void setBaseBean(java.lang.String value)

Sets the baseBean name associated with the argument

Parameters:

value - indicates the baseBean name associated with the argument

getBaseBean

public java.lang.String getBaseBean()

get the base bean name associated with the argument

Returns:

the baseBean name associated with the argument

setValue

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

getValue

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

resolveValue

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

Since:

MicroStrategy Web 9.0.0

setSysBean

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

getSysBean

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

setSource

public void setSource(java.lang.String value)

Indicates how to calculate the runtime value of the argument.

See Also:

setValue(java.lang.String), resolveValue()

getSource

public java.lang.String getSource()

Indicates how to calculate the runtime value of the argument.

See Also:

setValue(java.lang.String), resolveValue()

setEnumName

public void setEnumName(java.lang.String value)

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

See Also:

setValue(java.lang.String), resolveValue()

getEnumName

public java.lang.String getEnumName()

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

See Also:

setValue(java.lang.String), resolveValue()