org.icij.extract.report

Class Reporter

java.lang.Object

org.icij.extract.report.Reporter

All Implemented Interfaces:

AutoCloseable

public class Reporter
extends Object
implements AutoCloseable

Records the extraction result of a file to the given ReportMap.

Since:

1.0.0-beta

Constructor Summary

Constructors

Constructor and Description
Reporter(ReportMap reportMap) Create a new reporter that will record results to the given ReportMap.

Method Summary

Modifier and Type	Method and Description
boolean	check(TikaDocument tikaDocument, ExtractionStatus result) Check an extraction result.
void	close()
Report	report(TikaDocument tikaDocument) Check the extraction result of a given tikaDocument.
void	save(TikaDocument tikaDocument, ExtractionStatus status) Save the extraction status for the given tikaDocument.
void	save(TikaDocument tikaDocument, ExtractionStatus status, Exception exception) Save the extraction status and optional exception for the given tikaDocument.
void	save(TikaDocument tikaDocument, Report report) Save the extraction report for the given tikaDocument.
boolean	skip(TikaDocument tikaDocument) Check whether a path should be skipped.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reporter

public Reporter(ReportMap reportMap)

Create a new reporter that will record results to the given ReportMap.

Parameters:

reportMap - the report map

Method Detail

report

public Report report(TikaDocument tikaDocument)

Check the extraction result of a given tikaDocument.

Parameters:

tikaDocument - the tikaDocument to check

Returns:

The extraction report or null if no result was recorded for the file.

save

public void save(TikaDocument tikaDocument,
                 Report report)

Save the extraction report for the given tikaDocument.

Parameters:

tikaDocument - the tikaDocument

report - the extraction report

save

public void save(TikaDocument tikaDocument,
                 ExtractionStatus status,
                 Exception exception)

Save the extraction status and optional exception for the given tikaDocument.

Parameters:

tikaDocument - the tikaDocument

status - the extraction status

exception - any exception caught during extraction

save

public void save(TikaDocument tikaDocument,
                 ExtractionStatus status)

Save the extraction status for the given tikaDocument.

Parameters:

tikaDocument - the tikaDocument

status - the extraction status

check

public boolean check(TikaDocument tikaDocument,
                     ExtractionStatus result)

Check an extraction result.

Parameters:

tikaDocument - the tikaDocument to check

result - matched against the actual result

Returns:

true if the results match or false if there is no match or no recorded result.

skip

public boolean skip(TikaDocument tikaDocument)

Check whether a path should be skipped.

Parameters:

tikaDocument - the tikaDocument to check

Returns:

true if the tikaDocument should be skipped.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception