Package com.nuix.superutilities.annotations

Class BulkRedactor

java.lang.Object

com.nuix.superutilities.annotations.BulkRedactor

public class BulkRedactor
extends java.lang.Object

Provides bulk redaction functionality, as found in the GUI, but (as of Nuix 7.8.0.10) is not present in the Nuix API.

Constructor Summary

Constructors

Constructor	Description
BulkRedactor()

Method Summary

Modifier and Type	Method	Description
java.util.List<NuixImageAnnotationRegion>	findAndMarkup(nuix.Case nuixCase, BulkRedactorSettings settings, java.util.Collection<nuix.Item> scopeItems, int concurrency)	Finds text in PDFs of given items.
java.util.List<NuixImageAnnotationRegion>	findExpressionsInPdfFile(java.io.File file, java.util.Collection<java.lang.String> expressions)	Generates NuixImageAnnotationRegion objects for matches found by Aspose in the given PDF based on the provided regular expressions.
void	whenMessageLogged(java.util.function.Consumer<java.lang.String> callback)	Allows you to provide a callback which will be invoked when this instance emits a log message.
void	whenProgressUpdated(java.util.function.Consumer<BulkRedactorProgressInfo> callback)	Allows you to provide a callback which will be invoked when this instance emits a progress update.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkRedactor

public BulkRedactor()

Method Detail

whenMessageLogged

public void whenMessageLogged(java.util.function.Consumer<java.lang.String> callback)

Allows you to provide a callback which will be invoked when this instance emits a log message.

Parameters:

callback - The callback to receive logged messages

whenProgressUpdated

public void whenProgressUpdated(java.util.function.Consumer<BulkRedactorProgressInfo> callback)

Allows you to provide a callback which will be invoked when this instance emits a progress update.

Parameters:

callback - The callback to invoke when progress is updated

findExpressionsInPdfFile

public java.util.List<NuixImageAnnotationRegion> findExpressionsInPdfFile(java.io.File file,
                                                                          java.util.Collection<java.lang.String> expressions)

Generates NuixImageAnnotationRegion objects for matches found by Aspose in the given PDF based on the provided regular expressions.

Parameters:

file - The PDF file to search

expressions - The regular expressions to look for.

Returns:

A List of annotation region objects representing the matches.

findAndMarkup

public java.util.List<NuixImageAnnotationRegion> findAndMarkup(nuix.Case nuixCase,
                                                               BulkRedactorSettings settings,
                                                               java.util.Collection<nuix.Item> scopeItems,
                                                               int concurrency)
                                                        throws java.lang.Exception

Finds text in PDFs of given items. Then generates redactions based on the matches.

Parameters:

nuixCase - The source Nuix case. Needed to obtain items (if none were given) and/or obtain the appropriate markup set.

settings - The settings used to find and generate the redactions.

scopeItems - Items to find and redact.

concurrency - How many threads to put in ForkJoinPool

Returns:

Returns a list of all match region objects (so they can be reported, inspected, etc)

Throws:

java.lang.Exception - If something goes wrong