org.apache.jmeter.reporters

Class ResultCollector

Implemented Interfaces:
Clearable, Cloneable, NoThreadClone, Remoteable, SampleListener, Serializable, TestElement, TestListener
Known Direct Subclasses:
MailerResultCollector

public class ResultCollector
extends AbstractListenerElement
implements SampleListener, Clearable, Serializable, TestListener, Remoteable, NoThreadClone

This class handles all saving of samples. The class must be thread-safe because it is shared between threads (NoThreadClone).

Field Summary

static String
FILENAME

Fields inherited from interface org.apache.jmeter.testelement.TestElement

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

ResultCollector()
No-arg constructor.

Method Summary

void
clearData()
Object
clone()
String
getFilename()
SampleSaveConfiguration
getSaveConfig()
boolean
isErrorLogging()
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.
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.
boolean
isSuccessOnlyLogging()
void
loadExistingFile()
Loads an existing sample data (JTL) file.
void
recordStats(TestElement e)
recordStats is used to save statistics generated by visualizers
void
sampleOccurred(SampleEvent event)
When a test result is received, display it and save it.
void
sampleStarted(SampleEvent e)
A sample has started.
void
sampleStopped(SampleEvent e)
A sample has stopped.
protected void
sendToVisualizer(SampleResult r)
void
setErrorLogging(boolean errorLogging)
void
setFilename(String f)
Sets the filename attribute of the ResultCollector object.
void
setSaveConfig(SampleSaveConfiguration saveConfig)
void
setSuccessOnlyLogging(boolean value)
void
testEnded()
void
testEnded(String host)
void
testIterationStart(LoopIterationEvent event)
void
testStarted()
void
testStarted(String host)

Methods inherited from class org.apache.jmeter.reporters.AbstractListenerElement

clone, getVisualizer, setListener

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Field Details

FILENAME

public static final String FILENAME

Constructor Details

ResultCollector

public ResultCollector()
No-arg constructor.

Method Details

clearData

public void clearData()
Specified by:
clearData in interface Clearable

clone

public Object clone()
Specified by:
clone in interface TestElement
Overrides:
clone in interface AbstractListenerElement

getFilename

public String getFilename()

getSaveConfig

public SampleSaveConfiguration getSaveConfig()
Returns:
Returns the saveConfig.

isErrorLogging

public boolean isErrorLogging()

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

isSuccessOnlyLogging

public boolean isSuccessOnlyLogging()

loadExistingFile

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

recordStats

public void recordStats(TestElement e)
            throws Exception
recordStats is used to save statistics generated by visualizers
Parameters:
e -

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

sampleStarted

public void sampleStarted(SampleEvent e)
A sample has started.
Specified by:
sampleStarted in interface SampleListener

sampleStopped

public void sampleStopped(SampleEvent e)
A sample has stopped.
Specified by:
sampleStopped in interface SampleListener

sendToVisualizer

protected final void sendToVisualizer(SampleResult r)

setErrorLogging

public void setErrorLogging(boolean errorLogging)

setFilename

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

setSaveConfig

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

setSuccessOnlyLogging

public void setSuccessOnlyLogging(boolean value)

testEnded

public void testEnded()
Specified by:
testEnded in interface TestListener

testEnded

public void testEnded(String host)
Specified by:
testEnded in interface TestListener

testIterationStart

public void testIterationStart(LoopIterationEvent event)
Specified by:
testIterationStart in interface TestListener

testStarted

public void testStarted()
Specified by:
testStarted in interface TestListener

testStarted

public void testStarted(String host)
Specified by:
testStarted in interface TestListener

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.