public class

ActualParameterImpl

extends AbstractStyleCatalogElement
implements ActualParameter
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.ActualParameterImpl

Summary

Constants
String ATT_NAME
String ATT_ORDER
String ATT_SOURCE
String ATT_TYPE
String ATT_VALUE
String NODE_ACTUAL_PARAMETER
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ActualParameterImpl()
Public Methods
String getCatalogValue()
Returns the value of the actual parameter as registered in the StyleCatalog object.
FormalParameter getFormalParam(Transform t)
Returns the formal parameter object of a supplied Transform that is associated with the actual parameter.
FormalParameter getFormalParam()
Returns the formal parameter object associated with the actual parameter.
String getName()
Returns the name of the actual parameter object.
int getOrder()
Returns the precedence of the actual parameter.
String getSource()
Returns the source name to look up the SourceLookup object registered in the current StyleCatalog object.
int getType()
Object getValue()
Returns the value of the actual parameter.
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(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(String value)
void setOrder(int order)
Sets a precedence to the actual parameter.
void setSource(String source)
Sets the source name to look up the SourceLookup object registered in the current StyleCatalog object.
void setValue(Object value)
Sets the value of the actual parameter.
Protected Methods
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.
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.
TransformDefn getTransformDefn()
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogElement
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.ConfigurationFile
From interface com.microstrategy.web.transform.ActualParameter

Constants

protected static final String ATT_NAME

Constant Value: "name"

protected static final String ATT_ORDER

Constant Value: "order"

protected static final String ATT_SOURCE

Constant Value: "source"

protected static final String ATT_TYPE

Constant Value: "type"

protected static final String ATT_VALUE

Constant Value: "value"

protected static final String NODE_ACTUAL_PARAMETER

Constant Value: "ActualParameter"

Public Constructors

public ActualParameterImpl ()

Public Methods

public String getCatalogValue ()

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

Returns
  • the value of the actual parameter.

public FormalParameter getFormalParam (Transform t)

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

Parameters
t The Transform object to use for finding formal parameters.
Returns

public FormalParameter getFormalParam ()

Returns the formal parameter object associated with the actual parameter.

Returns

public String getName ()

Returns the name of the actual parameter object.

Returns
  • the name of the actual parameter object.

public int getOrder ()

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.

Returns
  • the precedence of the actual parameter.

public String getSource ()

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

Returns
  • the source name to look up the SourceLookup object.

public int getType ()

public Object getValue ()

Returns the value of the actual parameter.

Returns
  • the value of the actual parameter.

public Object getValue (StyleRequestContext context)

Returns the value of the actual parameter in the given context

Returns
  • the value of the actual parameter.

public boolean hasValue ()

Returns whether the actual parameter has a value.

Returns
  • whether the actual parameter has a value.

public boolean hasValue (StyleRequestContext context)

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

Returns
  • whether the actual parameter has a value.

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

Returns
  • whether the name matches or not with a formal parameter.

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

Returns
  • whether the name matches or not with a formal parameter.

public void setCatalogValue (String value)

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

Parameters
value the value of the actual parameter.

public void setFormalParam (FormalParameter param)

Associates the formal parameter object with this actual parameter.

Parameters
param the FormalParameter object associated with this actual parameter.
Throws
IllegalArgumentException

public void setName (String value)

public void setOrder (int order)

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.

Parameters
order the precedence of the actual parameter.

public void setSource (String source)

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

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

public void setValue (Object value)

Sets the value of the actual parameter.

Parameters
value the value of the actual parameter.
Throws
IllegalArgumentException

Protected Methods

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.

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.

protected TransformDefn getTransformDefn ()