Package org.monarchinitiative.lirical.core.analysis

Class ProgressReporter

java.lang.Object

org.monarchinitiative.lirical.core.analysis.ProgressReporter

public class ProgressReporter
extends Object

Class for pretty progress reporting using logger. The ProgressReporter is thread-safe.

Constructor Summary

Constructors

Constructor	Description
ProgressReporter()	Report each 5,000-th item using DEFAULT_COLLECTION_ITEM_NAME.
ProgressReporter(int tick)	Report each n-th item using DEFAULT_COLLECTION_ITEM_NAME.
ProgressReporter(int tick, String itemTemplateName)	Report each n-th item using provided progress message template.

Method Summary

Modifier and Type	Method	Description
void	log()	Log processing of an item.
void	summarize()	Log summary after processing.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressReporter

public ProgressReporter()

Report each 5,000-th item using DEFAULT_COLLECTION_ITEM_NAME.

ProgressReporter

public ProgressReporter(int tick)

Report each n-th item using DEFAULT_COLLECTION_ITEM_NAME.

Parameters:

tick - a positive integer.

ProgressReporter

public ProgressReporter(int tick,
 String itemTemplateName)

Report each n-th item using provided progress message template.

Parameters:

tick - a positive integer used to report each n-th item.

itemTemplateName - plural noun denoting the elements being processing (e.g. items, variants, diseases).

Method Details

log

public void log()

Log processing of an item.

summarize

public void summarize()

Log summary after processing.