org.alfresco.bm.driver.test

Class AbstractCompletionEstimator

java.lang.Object

org.alfresco.bm.driver.test.AbstractCompletionEstimator

All Implemented Interfaces:

CompletionEstimator

Direct Known Subclasses:

CompoundCompletionEstimator, ElapsedTimeCompletionEstimator, EventCountCompletionEstimator, SessionCountCompletionEstimator, UnknownCompletionEstimator

public abstract class AbstractCompletionEstimator
extends Object
implements CompletionEstimator

General support and controls for a CompletionEstimator implementation.

This class ensures that checks are done periodically, requiring that implementations supply results for the abstract methods only.

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
protected EventService	eventService
protected ResultService	resultService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCompletionEstimator(EventService eventService, ResultService resultService)

Method Summary

Modifier and Type	Method and Description
long	getCheckPeriod()
double	getCompletion() Get the latest test completion estimate
protected abstract double	getCompletionImpl() Implementation of a fetch to get the completion state.
long	getResultsFail()
protected long	getResultsFailImpl() Implementation of a fetch to fetch the number of failed results
long	getResultsSuccess()
protected long	getResultsSuccessImpl() Implementation of a fetch to fetch the number of successful results
boolean	isCompleted() Shortcut method to determine if the test run has completed or not.
boolean	isStarted() Shortcut method to determine if the test run has started or not If it has not started, the completion value will be 0.0
void	setCheckPeriod(long checkPeriod) Override the default time between calls to the underlying data providers

Methods inherited from class java.lang.Object

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

Field Detail

eventService

protected final EventService eventService

resultService

protected final ResultService resultService

Constructor Detail

AbstractCompletionEstimator

protected AbstractCompletionEstimator(EventService eventService,
                                      ResultService resultService)

Parameters:

eventService - used to do the final check when completion reachers 1.0

resultService - generally-useful service for estimation

Method Detail

getCheckPeriod

public final long getCheckPeriod()

Returns:

the minimum time between real completion checks

setCheckPeriod

public final void setCheckPeriod(long checkPeriod)

Override the default time between calls to the underlying data providers

getCompletion

public final double getCompletion()

Description copied from interface: CompletionEstimator

Get the latest test completion estimate

Specified by:

getCompletion in interface CompletionEstimator

Returns:

a value from 0.0 (0%) to 1.0 (100%)

getResultsSuccess

public final long getResultsSuccess()

Specified by:

getResultsSuccess in interface CompletionEstimator

Returns:

the number of successful results

getResultsFail

public final long getResultsFail()

Specified by:

getResultsFail in interface CompletionEstimator

Returns:

the number of failed results

isStarted

public final boolean isStarted()

Description copied from interface: CompletionEstimator

Shortcut method to determine if the test run has started or not If it has not started, the completion value will be 0.0

Specified by:

isStarted in interface CompletionEstimator

Returns:

true if the test run has started

isCompleted

public final boolean isCompleted()

Description copied from interface: CompletionEstimator

Shortcut method to determine if the test run has completed or not. If it has completed, the completion value will be 1.0

Specified by:

isCompleted in interface CompletionEstimator

Returns:

true if the test run has finished

getResultsSuccessImpl

protected long getResultsSuccessImpl()

Implementation of a fetch to fetch the number of successful results

Returns:

the number of successful event results

getResultsFailImpl

protected long getResultsFailImpl()

Implementation of a fetch to fetch the number of failed results

Returns:

the number of failed event results

getCompletionImpl

protected abstract double getCompletionImpl()

Implementation of a fetch to get the completion state. Once the estimate gets to or exceeds 1.0, the test will be flagged as complete.

Returns:

the data-led completion done as accurately as possible