Package 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 when generating an input user interface or as part of a executing the report query.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    ColumnExpression
    buildExpression(Element a_element, Map a_parameterMap)
    Returns the ColumnExpression value associated with this macro.
    Object
    getValue()
    Returns the value associated with this macro.

  • Method Details

    • buildExpression

      ColumnExpression buildExpression(Element a_element, Map a_parameterMap) throws QMLException
      Returns the ColumnExpression value associated with this macro. This method is called during report query execution and information related to macro's context are passed as parameters.

      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 value to be used in a QuerySpec
      Throws:
      QMLException

    • getValue

      Object getValue() throws WTException
      Returns the value associated with this macro. This method is called when rendering pre-specified values on the report input user interface.

      Supported API: true
      Returns:
      Object value to be used to populate a field in the UI
      Throws:
      WTException