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.
Object	getValue() Deprecated. as of R6.2, use buildExpression(Element, Map).

Method Detail

buildExpression

public ColumnExpression buildExpression(Element a_element,
                                        Map a_parameterMap)
                                 throws 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:

QMLException

getValue

public Object getValue()
                throws WTException

Deprecated. as of R6.2, use buildExpression(Element, Map).

Returns the value associated with this macro.

Supported API: false

Returns:

Object

Throws:

WTException