Package org.apache.jmeter.report.processor

Class AbstractSummaryConsumer

  • All Implemented Interfaces:
    org.apache.jmeter.report.processor.SampleConsumer , org.apache.jmeter.report.processor.SampleProcessor , org.apache.jmeter.report.processor.SampleProducer 
    
public abstract class AbstractSummaryConsumer<TData>
extends AbstractSampleConsumer

    The class AbstractSummaryConsumer provides a base class for data of the dashboard page.

    Since:

    3.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final boolean hasOverallResult() Defines whether the result contains an overall item.
      final boolean suppportsControllersDiscrimination() Indicates whether this summary can discriminate controller samples
      void startConsuming() Start the sample consuming.
      void consume(Sample sample, int channel) Consumes the specified sample ton the specified channel.
      void stopConsuming() Stops the consuming process.
      final void setHasOverallResult(boolean hasOverallResult) Defines whether the result contains an overall item.

      • Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleConsumer

        addSampleConsumer, getConsumedChannelCount, getConsumedMetadata, getName, getWorkingDirectory, produce, removeSampleConsumer, setChannelAttribute, setConsumedMetadata, setName, setProducedMetadata, setSampleConsumer, setSampleConsumers, setSampleContext, startProducing, stopProducing

      • Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleProcessor

        getChannelAttribute, getSampleContext

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • hasOverallResult

         final boolean hasOverallResult()

        Defines whether the result contains an overall item.

        Returns:

        true, if the result contains an overall item

      • suppportsControllersDiscrimination

         final boolean suppportsControllersDiscrimination()

        Indicates whether this summary can discriminate controller samples

        Returns:

        true, if this summary can discriminate controller samples; false otherwise.

      • startConsuming

         void startConsuming()

        Start the sample consuming. This step is used by consumer to initialize their process.

      • consume

         void consume(Sample sample, int channel)

        Consumes the specified sample ton the specified channel.

        Parameters:
        channel - The channel on which the sample is consumed

      • stopConsuming

         void stopConsuming()

        Stops the consuming process. No sample will be processed after this service has been called.

      • setHasOverallResult

         final void setHasOverallResult(boolean hasOverallResult)

        Defines whether the result contains an overall item.

        Parameters:
        hasOverallResult - true, if the result contains an overall item; false otherwise