com.workfusion.vds.sdk.nlp.component.statistics.printer

Class BaseIeGoldVsExtractedPrinter

java.lang.Object

com.workfusion.vds.sdk.nlp.component.statistics.printer.BaseIeGoldVsExtractedPrinter

All Implemented Interfaces:

StatisticsPrinter<IeDocumentResult>

Direct Known Subclasses:

IeGoldVsExtractedCSVPrinter, IeGoldVsExtractedPerGroupCSVPrinter

public abstract class BaseIeGoldVsExtractedPrinter
extends Object
implements StatisticsPrinter<IeDocumentResult>

Base class for Information Extraction gold vs extracted statistics printers.

Since:

9.1.0

Author:

Alena Zaitsava, Aliaksei Kushunin, Olga Pilipets

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	filePerField

Constructor Summary

Constructors

Constructor and Description
BaseIeGoldVsExtractedPrinter()

Method Summary

Modifier and Type	Method and Description
BaseIeGoldVsExtractedPrinter	filePerField(boolean filePerField) Configure printing into one file per field or one file for all fields.
protected abstract Set<StatisticsEvaluationType>	getEvaluationTypes(Collection<IeDocumentResult> results) Returns a set of StatisticsEvaluationType defined for IeStatisticsCalculator.
protected String	getFieldResult(StatisticsField statisticsField, StatisticsEvaluationType evaluationType) Returns StatisticsField value/text/position depending on StatisticsEvaluationType.
void	print(Collection<IeDocumentResult> results, Path output) This method accept a collection of DocumentResult over all dataset to perform some calculation actions and print results into final format.
protected abstract void	printForAllFields(Collection<IeDocumentResult> results, Path output, StatisticsEvaluationType evaluationType) Prints result statistics into file for all fields.
protected abstract void	printPerField(Collection<IeDocumentResult> results, Path output, StatisticsEvaluationType evaluationType) Prints result statistics into file per field.

Methods inherited from class java.lang.Object

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

Field Detail

filePerField

protected boolean filePerField

Constructor Detail

BaseIeGoldVsExtractedPrinter

public BaseIeGoldVsExtractedPrinter()

Method Detail

filePerField

public BaseIeGoldVsExtractedPrinter filePerField(boolean filePerField)

Configure printing into one file per field or one file for all fields.

Parameters:

filePerField - if true - statistics results will be printed into one file per each field, otherwise - into one file for all fields.

Returns:

current instance

print

public void print(Collection<IeDocumentResult> results,
                  Path output)

Description copied from interface: StatisticsPrinter

This method accept a collection of DocumentResult over all dataset to perform some calculation actions and print results into final format.

Specified by:

print in interface StatisticsPrinter<IeDocumentResult>

Parameters:

results - of all documents processed by StatisticsCalculator

output - path to folder where result statistic files should be stored

getEvaluationTypes

protected abstract Set<StatisticsEvaluationType> getEvaluationTypes(Collection<IeDocumentResult> results)

Returns a set of StatisticsEvaluationType defined for IeStatisticsCalculator.

Parameters:

results - collection of IeDocumentResult

Returns:

set of StatisticsEvaluationType

printPerField

protected abstract void printPerField(Collection<IeDocumentResult> results,
                                      Path output,
                                      StatisticsEvaluationType evaluationType)

Prints result statistics into file per field.

Parameters:

results - collection of IeDocumentResult

output - path to folder where result statistics files should be stored

evaluationType - strategy of statistics evaluation

printForAllFields

protected abstract void printForAllFields(Collection<IeDocumentResult> results,
                                          Path output,
                                          StatisticsEvaluationType evaluationType)

Prints result statistics into file for all fields.

Parameters:

results - collection of IeDocumentResult

output - path to folder where result statistics files should be stored

evaluationType - strategy of statistics evaluation

getFieldResult

protected String getFieldResult(StatisticsField statisticsField,
                                StatisticsEvaluationType evaluationType)

Returns StatisticsField value/text/position depending on StatisticsEvaluationType.

Parameters:

statisticsField - collection of IeDocumentResult

evaluationType - strategy of statistics evaluation

Returns:

String value/text/position