Class ResultCollector

    • Constructor Detail

      • ResultCollector

        public ResultCollector()
        No-arg constructor.
      • ResultCollector

        public ResultCollector​(Summariser summer)
        Constructor which sets the used Summariser
        Parameters:
        summer - The Summariser to use
    • Method Detail

      • getFilename

        public String getFilename()
        Get the filename of the file this collector uses
        Returns:
        The name of the file
      • isErrorLogging

        public boolean isErrorLogging()
        Get the state of error logging
        Returns:
        Flag whether errors should be logged
      • setErrorLogging

        public final void setErrorLogging​(boolean errorLogging)
        Sets error logging flag
        Parameters:
        errorLogging - The flag whether errors should be logged
      • setSuccessOnlyLogging

        public final void setSuccessOnlyLogging​(boolean value)
        Sets the flag whether only successful samples should be logged
        Parameters:
        value - The flag whether only successful samples should be logged
      • isSuccessOnlyLogging

        public boolean isSuccessOnlyLogging()
        Get the state of successful only logging
        Returns:
        Flag whether only successful samples should be logged
      • isSampleWanted

        public boolean isSampleWanted​(boolean success)
        Decides whether or not to a sample is wanted based on:
        • errorOnly
        • successOnly
        • sample success
        Should only be called for single samples.
        Parameters:
        success - is sample successful
        Returns:
        whether to log/display the sample
      • isSampleWanted

        public static boolean isSampleWanted​(boolean success,
                                             boolean errorOnly,
                                             boolean successOnly)
        Decides whether or not to a sample is wanted based on:
        • errorOnly
        • successOnly
        • sample success
        This version is intended to be called by code that loops over many samples; it is cheaper than fetching the settings each time.
        Parameters:
        success - status of sample
        errorOnly - if errors only wanted
        successOnly - if success only wanted
        Returns:
        whether to log/display the sample
      • setFilename

        public void setFilename​(String f)
        Sets the filename attribute of the ResultCollector object.
        Parameters:
        f - the new filename value
      • testEnded

        public void testEnded​(String host)
        Description copied from interface: TestStateListener

        Called once for all threads after the end of a test. This will use the same element instances as at the start of the test.

        N.B. testStarted() and testEnded() are called from different threads.

        Specified by:
        testEnded in interface TestStateListener
        Parameters:
        host - name of host
        See Also:
        StandardJMeterEngine.stopTest()
      • testStarted

        public void testStarted​(String host)
        Description copied from interface: TestStateListener

        Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.

        N.B. testStarted() and testEnded() are called from different threads.

        Specified by:
        testStarted in interface TestStateListener
        Parameters:
        host - name of host
        See Also:
        StandardJMeterEngine.run()
      • testEnded

        public void testEnded()
        Description copied from interface: TestStateListener

        Called once for all threads after the end of a test. This will use the same element instances as at the start of the test.

        N.B. testStarted() and testEnded() are called from different threads.

        Specified by:
        testEnded in interface TestStateListener
        See Also:
        StandardJMeterEngine.stopTest()
      • testStarted

        public void testStarted()
        Description copied from interface: TestStateListener

        Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.

        N.B. testStarted() and testEnded() are called from different threads.

        Specified by:
        testStarted in interface TestStateListener
        See Also:
        StandardJMeterEngine.run()
      • loadExistingFile

        public void loadExistingFile()
        Loads an existing sample data (JTL) file. This can be one of:
        • XStream format
        • Avalon format
        • CSV format
      • sampleOccurred

        public void sampleOccurred​(SampleEvent event)
        When a test result is received, display it and save it.
        Specified by:
        sampleOccurred in interface SampleListener
        Parameters:
        event - the sample event that was received
      • sendToVisualizer

        protected final void sendToVisualizer​(SampleResult r)
      • recordStats

        public void recordStats​(TestElement e)
                         throws IOException
        recordStats is used to save statistics generated by visualizers
        Parameters:
        e - The data to save
        Throws:
        IOException - when data writing fails
      • flushFile

        protected void flushFile()
        Flush PrintWriter to synchronize file contents
      • setSaveConfig

        public void setSaveConfig​(SampleSaveConfiguration saveConfig)
        Parameters:
        saveConfig - The saveConfig to set.
      • clearData

        public void clearData()
        Description copied from interface: Clearable
        Clears the current data of the object.
        Specified by:
        clearData in interface Clearable