mondrian.recorder

Interface MessageRecorder

    • Method Detail

      • clear

        void clear()
        Clear all context, warnings and errors from the MessageRecorder. After calling this method the MessageRecorder implemenation should be in the same state as if it were just constructed.
      • getStartTimeMillis

        long getStartTimeMillis()
        Get the time when the MessageRecorder was created or the last time that the clear method was called.
        Returns:
        the start time
      • getRunTimeMillis

        long getRunTimeMillis()
        How long the MessageRecorder has been running since it was created or the last time clear was called.
      • hasInformation

        boolean hasInformation()
        Returns true if there are one or more informational messages.
        Returns:
        true if there are one or more infos.
      • hasWarnings

        boolean hasWarnings()
        Returns true if there are one or more warning messages.
        Returns:
        true if there are one or more warnings.
      • hasErrors

        boolean hasErrors()
        Returns true if there are one or more error messages.
        Returns:
        true if there are one or more errors.
      • getContext

        String getContext()
        Get the current context string.
        Returns:
        the context string.
      • pushContextName

        void pushContextName(String name)
        Add the name parameter to the current context.
        Parameters:
        name -
      • popContextName

        void popContextName()
        Remove the last context name added.
      • throwRTException

        void throwRTException()
                              throws RecorderException
        This simply throws a RTException. A client calls this if 1) there is one or more error messages reported and 2) the client wishes to stop processing. Implementations of this method should only throw the RTException if there have been errors reported - if there are no errors, then this method does nothing.
        Throws:
        RecorderException
      • reportError

        void reportError(String msg,
                       Object info)
                         throws RecorderException
        Add an error message and extra information.
        Throws:
        RecorderException - if too many error messages have been added.
        Parameters:
        msg - the text of the error message.
        info - extra information (not meant to be part of printed message)
      • reportWarning

        void reportWarning(String msg)
        Add a warning message.
        Parameters:
        msg - the text of the warning message.
      • reportWarning

        void reportWarning(String msg,
                         Object info)
        Add a warning message and extra information.
        Parameters:
        msg - the text of the warning message.
        info - extra information (not meant to be part of printed message)
      • reportInfo

        void reportInfo(String msg)
        Add an informational message.
        Parameters:
        msg - the text of the info message.
      • reportInfo

        void reportInfo(String msg,
                      Object info)
        Add an informational message and extra information.
        Parameters:
        msg - the text of the info message.
        info - extra information (not meant to be part of printed message)