wt.query.report
Interface MacroExpressionProcessor

All Known Implementing Classes:
CurrentTimeMacroProcessor, UserNameMacroProcessor

public interface MacroExpressionProcessor

This interface defines an mechanism for associating a macro with a computed value. The macro is evaluated as part of a executing a report query. Information related to the query and its execution are passed as parameters.

Supported API: true

Extendable: true


Method Summary
 ColumnExpression buildExpression(Element a_element, Map a_parameterMap)
          Returns the ColumnExpression value associated with this macro.
 

Method Detail

buildExpression

ColumnExpression buildExpression(Element a_element,
                                 Map a_parameterMap)
                                 throws wt.query.qml.QMLException
Returns the ColumnExpression value associated with this macro.

Supported API: true

Parameters:
a_element - A DOM tree element associated with the QML query context where this macro is used.
a_parameterMap - Map of parameters associated with the query that is being executed.
Returns:
ColumnExpression
Throws:
wt.query.qml.QMLException