org.ice4j.ice.harvest

Class HarvestStatistics

java.lang.Object

org.ice4j.ice.harvest.HarvestStatistics

public class HarvestStatistics
extends Object

Manages statistics about harvesting time.

Author:

Vincent Lucas, Emil Ivov

Field Summary

Fields

Modifier and Type	Field and Description
private int	harvestCount The number of harvesting for this harvester.
protected String	harvesterName The name of the harvester associated with these stats.
private long	lastHarvestingTime The last ended harvesting time for this harvester.
private long	lastStartHarvestingTime The last harvest start time for this harvester.
private int	totalCandidateCount The number of non-redundant candidates that this harvester has discovered during all its harvests.

Constructor Summary

Constructors

Constructor and Description
HarvestStatistics()

Method Summary

Modifier and Type	Method and Description
int	getHarvestCount() Returns the number of harvests that the harvester associated with these statistics has completed so far.
long	getHarvestDuration() Returns the current harvesting time in ms.
String	getName() Returns the name of the associated harvester.
int	getTotalCandidateCount() Returns the number of candidates gathered by the associated harvester.
protected void	setName(String harvesterName) Specifies the name of the associated harvester.
protected void	startHarvestTiming() Starts the harvesting timer.
protected void	stopHarvestTiming(Collection<LocalCandidate> harvest) Stops the harvesting timer.
protected void	stopHarvestTiming(int candidateCount) Stops the harvesting timer.
String	toString() Returns a string representation of these statistics in a concise format.

Methods inherited from class java.lang.Object

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

Field Detail

harvestCount

private int harvestCount

The number of harvesting for this harvester.

lastStartHarvestingTime

private long lastStartHarvestingTime

The last harvest start time for this harvester. -1 if this harvester is not currently harvesting.

lastHarvestingTime

private long lastHarvestingTime

The last ended harvesting time for this harvester. -1 if this harvester has never harvested yet.

totalCandidateCount

private int totalCandidateCount

The number of non-redundant candidates that this harvester has discovered during all its harvests.

harvesterName

protected String harvesterName

The name of the harvester associated with these stats.

Constructor Detail

HarvestStatistics

public HarvestStatistics()

Method Detail

startHarvestTiming

protected void startHarvestTiming()

Starts the harvesting timer. Called when the harvest begins.

stopHarvestTiming

protected void stopHarvestTiming(Collection<LocalCandidate> harvest)

Stops the harvesting timer. Called when the harvest ends.

Parameters:

harvest - the harvest that we just concluded.

stopHarvestTiming

protected void stopHarvestTiming(int candidateCount)

Stops the harvesting timer. Called when the harvest ends.

Parameters:

candidateCount - the number of candidates we harvested.

getHarvestDuration

public long getHarvestDuration()

Returns the current harvesting time in ms. If this harvester is not currently harvesting, then returns the value of the last harvesting time. 0 if this harvester has never harvested.

Returns:

The current harvesting time in ms.

getTotalCandidateCount

public int getTotalCandidateCount()

Returns the number of candidates gathered by the associated harvester.

Returns:

the total number of candidates gatherer by this harvester.

getHarvestCount

public int getHarvestCount()

Returns the number of harvests that the harvester associated with these statistics has completed so far.

Returns:

the number of harvests that the associated harvester has engaged in.

setName

protected void setName(String harvesterName)

Specifies the name of the associated harvester.

Parameters:

harvesterName - the name of the associated harvester.

getName

public String getName()

Returns the name of the associated harvester.

Returns:

the name of the associated harvester.

toString

public String toString()

Returns a string representation of these statistics in a concise format.

Overrides:

toString in class Object

Returns:

a string representation of these stats.