Package com.microstrategy.web.app.taglibs

Class PerformanceTimerTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class PerformanceTimerTag
extends AbstractNoBodyTag
    Since:
    MicroStrategy Web 7.3.1 or earlier
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext

      • Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

        EVAL_BODY_AGAIN

      • Fields inherited from interface javax.servlet.jsp.tagext.Tag

        EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doStartTag()
      Processes the start tag for this instance.
      AbstractNoBodyTagHelper getHelper()
      Method for retrieving the helper associated with the tag.
      void setAction​(java.lang.String value)
      Indicates the action to be peformed by this tag, which indicates the type of JavaScript code that it will generate.
      void setLogResults​(java.lang.String value)
      Indicates if the results should be logged at this time or not.
      void setPageId​(java.lang.String value)
      Indicates the identifier for the page to be analyzed.

      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

        doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PerformanceTimerTag

        public PerformanceTimerTag()

    • Method Detail

      • doStartTag

        public int doStartTag()
               throws javax.servlet.jsp.JspException
        Processes the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before.
        Specified by:
        doStartTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class AbstractNoBodyTag
        Returns:
        SKIP_BODY since it does not want to process or display it.
        Throws:
        javax.servlet.jsp.JspException - if an error is risen when displaying the custom tag contents

      • setPageId

        public void setPageId​(java.lang.String value)
        Indicates the identifier for the page to be analyzed.
        Usage:
        The log results obtained will make reference to this identifier, for it to be possible to collect multiple pages analyzed multiple times.
        Parameters:
        value - String value to identify the page analyzed.

      • setLogResults

        public void setLogResults​(java.lang.String value)
        Indicates if the results should be logged at this time or not.
        Usage:
        This attribute should be specified as a boolean. If the value is True it means all the information from the timers that were stopped and recorded will be organized on a message, html page report of file, as indicated by the user on the application's configuration file.
        Parameters:
        value - String with value true if the statistics should now be obtained

      • setAction

        public void setAction​(java.lang.String value)
        Indicates the action to be peformed by this tag, which indicates the type of JavaScript code that it will generate.
        Usage:
        The possible values of this attribute include:
      • initialize> if the initialization has been requested
      • start if the start timer has been asked for
      • stop if the timer should now be stopped and the information for the processing time for this counter should be collected.
Parameters:
value - String with the action requested by the user