com.workfusion.vds.sdk.api.nlp.statistics

Interface StatisticsCalculator<I extends Document,O extends DocumentResult>

All Known Implementing Classes:

BaseStatisticsCalculator, ClassificationStatisticsCalculator, IeStatisticsCalculator

public interface StatisticsCalculator<I extends Document,O extends DocumentResult>

The StatisticsCalculator interface represents a component that performs statistics calculation. At the first phase of calculation, it accepts all Document one by one and produces statistics results DocumentResult. At the second phase, it accepts a collection of produced results to aggregate and print statistics into some source. Implementation of that interface can have some lifecycle methods annotated by follow annotations:

OnInit - method annotated by this annotation will be invoked after constructor

OnDestroy - method annotated by this annotation will be invoked once for one class instance after all another events. The method annotated with Destroy is typically used to release resources that it has been holding.

Since:

9.1.0

Author:

Aliaksei Kushunin, Artem Strok, Alena Zaitsava, Heorhi Stsefanovich

Method Summary

Modifier and Type	Method and Description
void	calculate(Collection<O> results) Accepts a collection of of results for all documents that was produced in {process(Document) method.
O	process(I document) Accepts document to process and produces statistic result for that document.

Method Detail

process

O process(I document)

Accepts document to process and produces statistic result for that document.

Parameters:

document - to process

Returns:

document result

calculate

void calculate(Collection<O> results)

Accepts a collection of of results for all documents that was produced in {process(Document) method. This method aggregates results and produce statistics into some source.

Parameters:

results - to aggregate