Package com.microstrategy.web.transform

Class ActualParameterImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.ActualParameterImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, ActualParameter, java.lang.Cloneable

public class ActualParameterImpl
extends AbstractStyleCatalogElement
implements ActualParameter

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
protected static java.lang.String	ATT_NAME
protected static java.lang.String	ATT_ORDER
protected static java.lang.String	ATT_SOURCE
protected static java.lang.String	ATT_TYPE
protected static java.lang.String	ATT_VALUE
protected static java.lang.String	NODE_ACTUAL_PARAMETER

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
ActualParameterImpl()

Method Summary

Modifier and Type	Method	Description
protected void	clearCaches()	This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.
java.lang.String	getCatalogValue()	Returns the value of the actual parameter as registered in the StyleCatalog object.
FormalParameter	getFormalParam()	Returns the formal parameter object associated with the actual parameter.
FormalParameter	getFormalParam(Transform t)	Returns the formal parameter object of a supplied Transform that is associated with the actual parameter.
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()	Returns the name of the actual parameter object.
int	getOrder()	Returns the precedence of the actual parameter.
java.lang.String	getSource()	Returns the source name to look up the SourceLookup object registered in the current StyleCatalog object.
protected TransformDefn	getTransformDefn()
int	getType()
java.lang.Object	getValue()	Returns the value of the actual parameter.
java.lang.Object	getValue(StyleRequestContext context)	Returns the value of the actual parameter in the given context
boolean	hasValue()	Returns whether the actual parameter has a value.
boolean	hasValue(StyleRequestContext context)	Returns whether the actual parameter has a value based on the context.
boolean	isMatched()	Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter.
boolean	isMatched(StyleRequestContext context)	Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter in the given context.
void	setCatalogValue(java.lang.String value)	Sets the value of the actual parameter to be saved in the StyleCatalog object.
void	setFormalParam(FormalParameter param)	Associates the formal parameter object with this actual parameter.
void	setName(java.lang.String value)
void	setOrder(int order)	Sets a precedence to the actual parameter.
void	setSource(java.lang.String source)	Sets the source name to look up the SourceLookup object registered in the current StyleCatalog object.
void	setValue(java.lang.Object value)	Sets the value of the actual parameter.

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogElement

copyContents, getStyleCatalog, hasChanged, reload, resetChanged, setStrAttribute

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, 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, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_ACTUAL_PARAMETER

protected static final java.lang.String NODE_ACTUAL_PARAMETER

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_NAME

protected static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_TYPE

protected static final java.lang.String ATT_TYPE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_VALUE

protected static final java.lang.String ATT_VALUE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_ORDER

protected static final java.lang.String ATT_ORDER

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_SOURCE

protected static final java.lang.String ATT_SOURCE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

ActualParameterImpl

public ActualParameterImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

clearCaches

protected void clearCaches()

Description copied from class: AbstractStyleCatalogElement

This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.

Overrides:

clearCaches in class AbstractStyleCatalogElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Description copied from interface: ActualParameter

Returns the name of the actual parameter object.

Specified by:

getName in interface ActualParameter

Returns:

the name of the actual parameter object.

setName

public void setName(java.lang.String value)

Since:

MicroStrategy Web 9.0.0

getFormalParam

public FormalParameter getFormalParam(Transform t)

Description copied from interface: ActualParameter

Returns the formal parameter object of a supplied Transform that is associated with the actual parameter.

Specified by:

getFormalParam in interface ActualParameter

Parameters:

t - The Transform object to use for finding formal parameters.

Returns:

the FormalParameter object associated with the acutal parameter.

getFormalParam

public FormalParameter getFormalParam()

Description copied from interface: ActualParameter

Returns the formal parameter object associated with the actual parameter.

Specified by:

getFormalParam in interface ActualParameter

Returns:

the FormalParameter object associated with the acutal parameter.

setFormalParam

public void setFormalParam(FormalParameter param)
                    throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameter

Associates the formal parameter object with this actual parameter.

Specified by:

setFormalParam in interface ActualParameter

Parameters:

param - the FormalParameter object associated with this actual parameter.

Throws:

java.lang.IllegalArgumentException

isMatched

public boolean isMatched()

Description copied from interface: ActualParameter

Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter.

Specified by:

isMatched in interface ActualParameter

Returns:

whether the name matches or not with a formal parameter.

isMatched

public boolean isMatched(StyleRequestContext context)

Description copied from interface: ActualParameter

Returns whether the name of the actual parameter matches a formal parameter and if its value is valid for the corresponding formal parameter in the given context.

Specified by:

isMatched in interface ActualParameter

Returns:

whether the name matches or not with a formal parameter.

Since:

MicroStrategy Web 8.0.0

getCatalogValue

public java.lang.String getCatalogValue()

Description copied from interface: ActualParameter

Returns the value of the actual parameter as registered in the StyleCatalog object.

Specified by:

getCatalogValue in interface ActualParameter

Returns:

the value of the actual parameter.

Since:

MicroStrategy Web 9.0.0

setCatalogValue

public void setCatalogValue(java.lang.String value)

Description copied from interface: ActualParameter

Sets the value of the actual parameter to be saved in the StyleCatalog object.

Specified by:

setCatalogValue in interface ActualParameter

Parameters:

value - the value of the actual parameter.

Since:

MicroStrategy Web 9.0.0

getValue

public java.lang.Object getValue()

Description copied from interface: ActualParameter

Returns the value of the actual parameter.

Specified by:

getValue in interface ActualParameter

Returns:

the value of the actual parameter.

getValue

public java.lang.Object getValue(StyleRequestContext context)

Description copied from interface: ActualParameter

Returns the value of the actual parameter in the given context

Specified by:

getValue in interface ActualParameter

Returns:

the value of the actual parameter.

Since:

MicroStrategy Web 8.0.0

hasValue

public boolean hasValue()

Description copied from interface: ActualParameter

Returns whether the actual parameter has a value.

Specified by:

hasValue in interface ActualParameter

Returns:

whether the actual parameter has a value.

hasValue

public boolean hasValue(StyleRequestContext context)

Description copied from interface: ActualParameter

Returns whether the actual parameter has a value based on the context.

Specified by:

hasValue in interface ActualParameter

Returns:

whether the actual parameter has a value.

Since:

MicroStrategy Web 8.0.0

setValue

public void setValue(java.lang.Object value)
              throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameter

Sets the value of the actual parameter.

Specified by:

setValue in interface ActualParameter

Parameters:

value - the value of the actual parameter.

Throws:

java.lang.IllegalArgumentException - thrown if the value is null.

getOrder

public int getOrder()

Description copied from interface: ActualParameter

Returns the precedence of the actual parameter. This precedence is used to resolve which actual parameter to use if there are multiple actual parameters matching the same formal parameter. Higher this number, higher precedence.

Specified by:

getOrder in interface ActualParameter

Returns:

the precedence of the actual parameter.

Since:

MicroStrategy Web 8.0.0

setOrder

public void setOrder(int order)

Description copied from interface: ActualParameter

Sets a precedence to the actual parameter. This precedence is used to resolve which actual parameter to use if there are multiple actual parameters matching the same formal parameter. Higher this number, higher precedence.

Specified by:

setOrder in interface ActualParameter

Parameters:

order - the precedence of the actual parameter.

Since:

MicroStrategy Web 8.0.0

getSource

public java.lang.String getSource()

Description copied from interface: ActualParameter

Returns the source name to look up the SourceLookup object registered in the current StyleCatalog object.

Specified by:

getSource in interface ActualParameter

Returns:

the source name to look up the SourceLookup object.

Since:

MicroStrategy Web 8.0.0

setSource

public void setSource(java.lang.String source)

Description copied from interface: ActualParameter

Sets the source name to look up the SourceLookup object registered in the current StyleCatalog object.

Specified by:

setSource in interface ActualParameter

Parameters:

source - the source name to look up the SourceLookup object.

Since:

MicroStrategy Web 8.0.0

getType

public int getType()

Since:

MicroStrategy Web 9.0.0

getTransformDefn

protected TransformDefn getTransformDefn()

Since:

MicroStrategy Web 9.0.0

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