Index (SuperUtilities API)

A B C D E F G H I J L M N O P Q R S T U V W Y Z
All Classes All Packages

A

abort() - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Signals that you wish to abort.
abort() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Notifies BulkCaseProcessor that all further processing should be aborted
abort() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Notifies BulkCaseProcessor that all further processing should be aborted
abort() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Notifies BulkCaseProcessor that all further processing should be aborted
Abort - com.nuix.superutilities.cases.CaseIssueReaction
abortScan() - Method in class com.nuix.superutilities.regex.RegexScanner: When running a scan by providing a Consumer callback, this will signal that further scanning should be aborted.
accept(T) - Method in class com.nuix.superutilities.misc.PeriodicGatedConsumer: Will periodically forward call to wrapped Consumer and then reset current interval
acceptCase(Case, CaseInfo, int, int) - Method in interface com.nuix.superutilities.cases.CaseConsumer
acceptImmediately(T) - Method in class com.nuix.superutilities.misc.PeriodicGatedConsumer: Will immediately forward call to wrapped Consumer and then reset current interval
add(int, String) - Method in class com.nuix.superutilities.misc.NamedStringList
add(String) - Method in class com.nuix.superutilities.misc.NamedStringList
addAll(int, Collection<? extends String>) - Method in class com.nuix.superutilities.misc.NamedStringList
addAll(Collection<? extends String>) - Method in class com.nuix.superutilities.misc.NamedStringList
addAllBuiltInEntities() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Adds the names of all the built-in entities as of Nuix 7.8: company, country, credit-card-num, email, ip-address, money, person, personal-id-num, url and phone-number
addCaseDirectory(File) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Adds a case directory to be iterated.
addCaseDirectory(String) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Adds a case directory to be iterated.
addColCriterion(NamedQuery) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Adds a single NamedQuery to the list of primary column criteria.
addColCriterion(String, String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Adds a single NamedQuery, constructed from the provided arguments, to the list of primary column criteria.
addColor(int, int, int) - Method in class com.nuix.superutilities.reporting.ColorRing
addCommonFieldsOfRelatedItem(Item, String, String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
addEntityNames(Collection<String>) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Adds entity names to this instance.
addExpression(String) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Adds a regular expression to the list of expressions used to locate text to markup.
addItem(Item) - Method in class com.nuix.superutilities.misc.DigestList: Adds the MD5 of the provided item to this instance (if not already present).
addItems(Collection<Item>) - Method in class com.nuix.superutilities.misc.DigestList: Adds the MD5s of the provided items to this instance (if not already present).
addItemsToItemSet(Case, String, String, Collection<Item>) - Method in class com.nuix.superutilities.misc.ProfileDigester: Adds items to an item set using "Scripted" deduplication, providing a MD5 hash generated from the concatenation of the values yielded by the MetadataProfile associated with this instance.
addMatch(PatternInfo, String, boolean, String, String, int, int) - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Adds a match to this instance.
addMd5(byte[]) - Method in class com.nuix.superutilities.misc.DigestList: Adds the given MD5 to this instance (if not already present).
addMd5(String) - Method in class com.nuix.superutilities.misc.DigestList: Adds the given MD5 to this instance (if not already present).
addMonitoredLocation(String, double) - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Adds a location to be monitored
addNamedEntity(String) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Adds a named entity type to the list of types to be redacted.
addPattern(String, String) - Method in class com.nuix.superutilities.regex.RegexScanner: Adds a regular expression to be part of the scan with a given title.
addPhrase(String) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Adds a phrase to the list of expressions used to find and markup text.
addPhrases(Collection<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Adds multiple phrases to the list of expressions used to find and markup text.
addRecord(OptRecord) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
addRowCriterion(NamedQuery) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Adds a single NamedQuery to the list of row criteria.
addRowCriterion(String, String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Adds a single NamedQuery, constructed from the provided arguments, to the list of row criteria.
addScriptedValueGenerator(String, BiFunction<Case, String, Object>) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Adds a ColumnValueGenerator which calculates its value using the expression provided.
addTintSeries(Color, int) - Method in class com.nuix.superutilities.reporting.ColorRing: Adds the provided base color and series of tinted variations to this instance.
AnnotationEvent - Class in com.nuix.superutilities.annotations
AnnotationEvent() - Constructor for class com.nuix.superutilities.annotations.AnnotationEvent
AnnotationHistoryRepository - Class in com.nuix.superutilities.annotations: Class for recording annotation in a source case and replaying on a destination case.
AnnotationHistoryRepository(File) - Constructor for class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Creates a new instance against the given and database file.
AnnotationHistoryRepository(String) - Constructor for class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Creates a new instance against the given and database file.
AnnotationHistoryRepositorySummary - Class in com.nuix.superutilities.annotations
AnnotationHistoryRepositorySummary() - Constructor for class com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary
AnnotationMatchingMethod - Enum in com.nuix.superutilities.annotations
AnnotationRepository - Class in com.nuix.superutilities.annotations: This class leverages a SQLite database file to export and import annotations between Nuix cases.
AnnotationRepository(File) - Constructor for class com.nuix.superutilities.annotations.AnnotationRepository: Creates a new instance associated to the specified SQLite DB file.
AnnotationRepository(String) - Constructor for class com.nuix.superutilities.annotations.AnnotationRepository: Creates a new instance associated to the specified SQLite DB file.
AnnotationSyncSettings - Class in com.nuix.superutilities.annotations
AnnotationSyncSettings() - Constructor for class com.nuix.superutilities.annotations.AnnotationSyncSettings
appendRow(List<? extends Object>) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
appendRow(List<Object>, Style) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
applyHighlight(MarkupSet) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion: Applies a highlight based on the region defined by this instance.
applyMarkupsFromDatabaseToCase(Case, boolean, AnnotationMatchingMethod) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Applies markups present in the SQLite DB file associated to this instance to the provided Nuix case.
applyRedaction(MarkupSet) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion: Applies a redaction based on the region defined by this instance.
applyTagsFromDatabaseToCase(Case, AnnotationMatchingMethod) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Applies tags to items in the provided case based on tag records in the DB file associated to this instance.
archiveCase(File, File, boolean, int) - Method in class com.nuix.superutilities.cases.CaseUtility: Archives a Nuix case into a Zip file, optionally deleting the case once completed.
archiveCase(String, String, boolean, int) - Method in class com.nuix.superutilities.cases.CaseUtility: Archives a Nuix case into a Zip file, optionally deleting the case once completed.
AsposeCellsColorHelper - Class in com.nuix.superutilities.reporting: A class containing helper methods for working with Aspose Cells colors.
AsposeCellsColorHelper() - Constructor for class com.nuix.superutilities.reporting.AsposeCellsColorHelper
AsposeCellsStyleHelper - Class in com.nuix.superutilities.reporting: A class containing helper methods for working with Aspose Cells Styles.
AsposeCellsStyleHelper() - Constructor for class com.nuix.superutilities.reporting.AsposeCellsStyleHelper
autoFitColumns() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
autoFitRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet

B

beforeOpeningCase(Consumer<CaseInfo>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Optional callback which is called before opening each case.
beforeSerialization(Consumer<Map<String, Object>>) - Method in class com.nuix.superutilities.export.JsonExporter: Allows you to provide a callback which can inspect or modify the nested series of Maps before they are serialized by GSON to JSON by JsonExporter.exportItemAsJson(Item, File) or JsonExporter.convertItemToJsonString(Item).
beginMonitoring() - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Begins monitoring locations by polling them at intervals.
binaryCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
booleanCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
booleanParser - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser
BoundedProgressInfo - Class in com.nuix.superutilities.misc: Represents progress of an operation which has a bounded value, that is, we know what progress value is considered maximum/done.
BoundedProgressInfo(String, long, long) - Constructor for class com.nuix.superutilities.misc.BoundedProgressInfo
buildSettingsSummary() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
buildStandardCopy() - Static method in class com.nuix.superutilities.misc.PrimitiveTypeParser
buildSummary() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
BulkCaseProcessor - Class in com.nuix.superutilities.cases: This class assists with iteratively doing some form of work in multiple cases.
BulkCaseProcessor() - Constructor for class com.nuix.superutilities.cases.BulkCaseProcessor
BulkRedactor - Class in com.nuix.superutilities.annotations: Provides bulk redaction functionality, as found in the GUI, but (as of Nuix 7.8.0.10) is not present in the Nuix API.
BulkRedactor() - Constructor for class com.nuix.superutilities.annotations.BulkRedactor
BulkRedactorProgressInfo - Class in com.nuix.superutilities.annotations
BulkRedactorProgressInfo() - Constructor for class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
BulkRedactorSettings - Class in com.nuix.superutilities.annotations: Provides settings regarding bulk redaction performed by BulkRedactor.findAndMarkup(Case, BulkRedactorSettings, Collection, int).
BulkRedactorSettings() - Constructor for class com.nuix.superutilities.annotations.BulkRedactorSettings
bytesToDynamicSize(long, int) - Static method in class com.nuix.superutilities.misc.FormatUtility: Converts size in bytes to a String representing the file size, as you might see it represented by the OS, such as "1.24 KB" or "3.42 GB"
bytesToGigaBytes(long, int) - Static method in class com.nuix.superutilities.misc.FormatUtility: Converts size specified in bytes to size specified in giga bytes, rounding to specified number of decimal places.
bytesToHex(byte[]) - Static method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for converting a byte array to a hex string.
bytesToKiloBytes(long, int) - Static method in class com.nuix.superutilities.misc.FormatUtility: Converts size specified in bytes to size specified in kilo bytes, rounding to specified number of decimal places.
bytesToMegaBytes(long, int) - Static method in class com.nuix.superutilities.misc.FormatUtility: Converts size specified in bytes to size specified in mega bytes, rounding to specified number of decimal places.

C

calculate(String, String) - Static method in class com.nuix.superutilities.misc.LevenshteinDistance
calculateJaroWinklerSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
calculateLastDbEventStart() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
CaseConsumer - Interface in com.nuix.superutilities.cases: Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
caseExists() - Method in class com.nuix.superutilities.cases.CaseInfo: Whether a case was determined to exist in the directory specified, as determined by presence of FBI2 file in directory.
CaseHistoryHelper - Class in com.nuix.superutilities.cases: Helper class for iterating a case's history.
CaseHistoryHelper(Case, List<String>, DateTime, DateTime) - Constructor for class com.nuix.superutilities.cases.CaseHistoryHelper
CaseInfo - Class in com.nuix.superutilities.cases: Represents some information which can be determined about a Nuix case directory without having yet opened the case through the API.
CaseInfo(File) - Constructor for class com.nuix.superutilities.cases.CaseInfo: Creates a new instance associated to the specified case directory.
CaseInfo(String) - Constructor for class com.nuix.superutilities.cases.CaseInfo: Creates a new instance associated to the specified case directory.
CaseIssueReaction - Enum in com.nuix.superutilities.cases: Used to respond to issues opening a case by BulkCaseProcessor.
CaseLockedEventInfo - Class in com.nuix.superutilities.cases: This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was locked.
CaseLockedEventInfo(CaseInfo) - Constructor for class com.nuix.superutilities.cases.CaseLockedEventInfo: Creates a new instance
CaseLockInfo - Class in com.nuix.superutilities.cases: Represents information parsed from a case lock file.
CaseLockInfo() - Constructor for class com.nuix.superutilities.cases.CaseLockInfo
CaseOpenErrorEvent - Class in com.nuix.superutilities.cases: This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had and error when opened.
CaseOpenErrorEvent(CaseInfo, Exception) - Constructor for class com.nuix.superutilities.cases.CaseOpenErrorEvent: Creates a new instance
CaseUtility - Class in com.nuix.superutilities.cases: Class which provides some additional functionality regarding Nuix cases, mainly finding cases present in directories and their sub directories.
CaseUtility() - Constructor for class com.nuix.superutilities.cases.CaseUtility
ChunkedDATExporter - Class in com.nuix.superutilities.export: Generates a series of DAT loadfiles, based on a metadata profile.
ChunkedDATExporter() - Constructor for class com.nuix.superutilities.export.ChunkedDATExporter
ChunkedDATExporter.ChunkInfo - Class in com.nuix.superutilities.export
chunkIndex - Variable in class com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
ChunkInfo(int) - Constructor for class com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
cleanPathString(String) - Static method in class com.nuix.superutilities.misc.PlaceholderResolver: Helper method to strip common illegal path characters from a string
cleanupTemporaryPdfs() - Method in class com.nuix.superutilities.export.PdfWorkCache: Calling this will delete all temporary PDFs created by this instance, as well as clear internal listing of PDFs and their associated file paths.
clear() - Method in class com.nuix.superutilities.misc.NamedStringList
clear() - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Clears all currently associated placeholders (keys and values)
clearAllDynamicPlaholders() - Method in class com.nuix.superutilities.export.CustomExporter: Removes all previously added dynamic placeholders.
clearColors() - Method in class com.nuix.superutilities.reporting.ColorRing: Clears all colors currently assigned to this instance.
clearEntityNames() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Clears all entity names associated with this instance
clearRowCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Removes all currently assigned row criteria.
close() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
close() - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
close() - Method in class com.nuix.superutilities.misc.SQLiteBacked
close() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
ColorRing - Class in com.nuix.superutilities.reporting: Iterator over a collection of Aspose Cells Color objects.
ColorRing() - Constructor for class com.nuix.superutilities.reporting.ColorRing
columnLabel - Variable in class com.nuix.superutilities.reporting.ColumnValueGenerator
ColumnValueGenerator - Class in com.nuix.superutilities.reporting: Base class for reporting.
ColumnValueGenerator() - Constructor for class com.nuix.superutilities.reporting.ColumnValueGenerator
com.nuix.superutilities - package com.nuix.superutilities
com.nuix.superutilities.annotations - package com.nuix.superutilities.annotations
com.nuix.superutilities.cases - package com.nuix.superutilities.cases
com.nuix.superutilities.export - package com.nuix.superutilities.export
com.nuix.superutilities.items - package com.nuix.superutilities.items
com.nuix.superutilities.loadfiles - package com.nuix.superutilities.loadfiles
com.nuix.superutilities.misc - package com.nuix.superutilities.misc
com.nuix.superutilities.namedentities - package com.nuix.superutilities.namedentities
com.nuix.superutilities.query - package com.nuix.superutilities.query
com.nuix.superutilities.regex - package com.nuix.superutilities.regex
com.nuix.superutilities.reporting - package com.nuix.superutilities.reporting
combineDigestFiles(File, Collection<File>) - Static method in class com.nuix.superutilities.misc.DigestList: Create a new digest list file from multiple source digest lists.
combineDigestFiles(String, Collection<String>) - Static method in class com.nuix.superutilities.misc.DigestList: Create a new digest list file from multiple source digest lists.
compareTo(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion: Provides comparison logic when comparing two instances.
compile(boolean, boolean, boolean) - Method in class com.nuix.superutilities.regex.PatternInfo: Compiles the regular expression String provided into a Java Pattern object
compressDirectoryToSevenZipFile(String, String) - Static method in class com.nuix.superutilities.misc.ZipHelper
compressDirectoryToZipFile(String, String, int) - Static method in class com.nuix.superutilities.misc.ZipHelper: Compresses the contents of the given directory (files and sub-directories) in to a Zip file.
contains(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
containsAll(Collection<?>) - Method in class com.nuix.superutilities.misc.NamedStringList
containsMd5(byte[]) - Method in class com.nuix.superutilities.misc.DigestList: Gets whether the given MD5 is present in this instance.
containsMd5(String) - Method in class com.nuix.superutilities.misc.DigestList: Gets whether the given MD5 is present in this instance.
convertItemToJsonString(Item) - Method in class com.nuix.superutilities.export.JsonExporter: Converts an item to a JSON String representation.
convertSourceItemToJsonString(SourceItem) - Method in class com.nuix.superutilities.export.JsonExporter: Converts a SourceItem to a JSON String representation.
convertToString(Object) - Method in class com.nuix.superutilities.misc.FormatUtility: Attempts to convert data types, which may be values of metadata properties or custom metadata, to a String.
convertWorkerItemToJsonString(WorkerItem) - Method in class com.nuix.superutilities.export.JsonExporter: Converts a WorkerItem to a JSON String representation.
createBulkCaseProcessor() - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of BulkCaseProcessor.
createCaseHistoryHelper(Case, List<String>, DateTime, DateTime) - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of CaseHistoryHelper.
createFreeSpaceMonitor() - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of FreeSpaceMonitor.
createJsonExporter() - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of JsonExporter
createRegexScanner() - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of RegexScanner
createStyle() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
createTemplateExporter(File) - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of TemplateExporter with a template based on the specified file.
createTemplateExporter(String) - Method in class com.nuix.superutilities.SuperUtilities: Creates a new instance of TemplateExporter with a template based on the specified file.
createWaterMarkedPdf(File, File, String, int, float, float) - Static method in class com.nuix.superutilities.misc.PdfUtility: Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
createWaterMarkedPdf(String, String, String, int, float, float) - Static method in class com.nuix.superutilities.misc.PdfUtility: Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
current - Variable in class com.nuix.superutilities.misc.ProgressInfo: The current progress value
CustodianEvent - Class in com.nuix.superutilities.annotations
CustodianEvent() - Constructor for class com.nuix.superutilities.annotations.CustodianEvent
CustomExporter - Class in com.nuix.superutilities.export: Provides customized exports while still leveraging the performance of BatchExporter.
CustomExporter() - Constructor for class com.nuix.superutilities.export.CustomExporter
CustomMetadataEvent - Class in com.nuix.superutilities.annotations
CustomMetadataEvent() - Constructor for class com.nuix.superutilities.annotations.CustomMetadataEvent

D

dateTimeCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
DatLoadFile - Class in com.nuix.superutilities.loadfiles
DatLoadFile() - Constructor for class com.nuix.superutilities.loadfiles.DatLoadFile
DatLoadFileReader - Class in com.nuix.superutilities.loadfiles
DatLoadFileReader() - Constructor for class com.nuix.superutilities.loadfiles.DatLoadFileReader
DatLoadFileWriter - Class in com.nuix.superutilities.loadfiles
DatLoadFileWriter(File) - Constructor for class com.nuix.superutilities.loadfiles.DatLoadFileWriter
debugString(Exception) - Static method in class com.nuix.superutilities.misc.FormatUtility
debugString(Map<String, ?>) - Static method in class com.nuix.superutilities.misc.FormatUtility
decimalParser - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser
deduplicateCustomTieBreaker(Collection<Item>, BiFunction<Item, Item, Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Custom deduplication implementation allowing code to specify which original is kept.
destinationFile - Variable in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
determineStoreCount() - Method in class com.nuix.superutilities.cases.CaseInfo: Determines case store count by counting store directories in case directory.
DigestList - Class in com.nuix.superutilities.misc: This class provides an in-memory representation of a Nuix binary digest list.
DigestList() - Constructor for class com.nuix.superutilities.misc.DigestList: Creates a new empty instance.
DigestList(File...) - Constructor for class com.nuix.superutilities.misc.DigestList: Creates a new instance and then imports digests from each provided source Nuix binary digest list file by iteratively calling DigestList.importFile(File) for each.
DriveSpaceInfo - Class in com.nuix.superutilities.misc: Encapsulates drive space information to callback responding to events fired by FreeSpaceMonitor.
DriveSpaceInfo(String) - Constructor for class com.nuix.superutilities.misc.DriveSpaceInfo: Creates a new instance for the specified file path.
durationAutomaticParsing - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser
durationCategory - Static variable in class com.nuix.superutilities.export.JsonExporter

E

eachCell(int, int, int, int, Consumer<Cell>) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
eachDigest(File, Consumer<String>) - Static method in class com.nuix.superutilities.misc.DigestList: Provides a way to iterate each MD5 string present in a given digest list file without first reading the entirety of that digest list file into memory.
eachRecordedCustodianEvent(long, Consumer<CustodianEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedCustodianEvent(DateTime, Consumer<CustodianEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedCustomMetadataEvent(long, Consumer<CustomMetadataEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedCustomMetadataEvent(DateTime, Consumer<CustomMetadataEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedExclusionEvent(long, Consumer<ExclusionEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedExclusionEvent(DateTime, Consumer<ExclusionEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedItemSetEvent(long, Consumer<ItemSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedItemSetEvent(DateTime, Consumer<ItemSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedProductionSetEvent(long, Consumer<ProductionSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedProductionSetEvent(DateTime, Consumer<ProductionSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedTagEvent(long, Consumer<TagEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
eachRecordedTagEvent(DateTime, Consumer<TagEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
enableAllBorders(Style) - Static method in class com.nuix.superutilities.reporting.AsposeCellsStyleHelper: Convenience method for applying a thin black border to all sides of a given cell style.
encounteredPropertyNameCounts - Static variable in class com.nuix.superutilities.export.JsonExporter
enrichInPlace(Map<String, Object>) - Method in class com.nuix.superutilities.misc.PrimitiveTypeParser
equals(Object) - Method in class com.nuix.superutilities.cases.CaseInfo
equals(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
escapeForSearch(String) - Static method in class com.nuix.superutilities.query.QueryHelper
escapeRegexSpecialCharacters(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Escapes regular expression characters in the input string.
escapeTagForSearch(String) - Static method in class com.nuix.superutilities.misc.FormatUtility
ExclusionEvent - Class in com.nuix.superutilities.annotations
ExclusionEvent() - Constructor for class com.nuix.superutilities.annotations.ExclusionEvent
executeInsert(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeInsert(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes an insert query against the SQLite database file
executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Executes an insert query against the SQLite database file
executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes an insert query against the SQLite database file
executeLongScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeLongScalar(String) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
executeLongScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeLongScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
executeLongScalar(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeLongScalar(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
executeQuery(String, List<Object>, Consumer<ResultSet>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Executes a query which is expected to return row data, providing the result set to the provided callback.
executeQuery(String, List<Object>, Consumer<ResultSet>) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes a query which is expected to return row data, providing the result set to the provided callback.
executeScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked
executeStringScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeStringScalar(String) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single string value.
executeStringScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeStringScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single string value.
executeStringScalar(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeStringScalar(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes SQL which is expected to return a single string value.
executeUpdate(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeUpdate(String) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes an update query against the SQLite database file
executeUpdate(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
executeUpdate(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes an update query against the SQLite database file
executeUpdate(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Executes an update query against the SQLite database file
executeUpdate(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked: Executes an update query against the SQLite database file
ExpandedTermInfo - Class in com.nuix.superutilities.misc: Encapsulates information about a term designated as a match result generated by TermExpander.
ExpandedTermInfo() - Constructor for class com.nuix.superutilities.misc.ExpandedTermInfo
expandTerm(Case, boolean, boolean, String) - Method in class com.nuix.superutilities.misc.TermExpander: This method "expands" a term to related terms in the specified case.
expandTerm(Case, boolean, boolean, String, String) - Method in class com.nuix.superutilities.misc.TermExpander: This method "expands" a term to related terms in the specified case.
expandTerm(Case, String) - Method in class com.nuix.superutilities.misc.TermExpander: This method "expands" a term to related terms in the specified case.
export(List<Item>) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
exportItemAsJson(Item, File) - Method in class com.nuix.superutilities.export.JsonExporter: Exports an item as a JSON representation.
exportItems(Case, File, List<Item>) - Method in class com.nuix.superutilities.export.CustomExporter: Exports given items in custom structure.
exportItems(Case, String, List<Item>) - Method in class com.nuix.superutilities.export.CustomExporter: Exports given items in custom structure.
exportJson(String) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of JSON files using the provided settings.
exportJson(String, JsonExporter) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of JSON files using the provided settings.
exportNatives(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of natives using the provided settings.
exportPdfs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of PDF files using the provided settings.
exportSourceItemAsJson(SourceItem, File) - Method in class com.nuix.superutilities.export.JsonExporter: Exports an source item as a JSON representation.
exportText(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of text files using the provided settings.
exportTiffs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Enables export of TIFF files using the provided settings.
exportToFile(ChunkedDATExporter.ChunkInfo) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
exportWorkerItemAsJson(WorkerItem, File) - Method in class com.nuix.superutilities.export.JsonExporter: Exports a worker item as a JSON representation.

F

findAncestor(Item, Predicate<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Traverses an item's ancestors bottom up, until the first item for which the predicate yields true or null if no ancestor matches the predicate.
findAndMarkup(Case, BulkRedactorSettings, Collection<Item>, int) - Method in class com.nuix.superutilities.annotations.BulkRedactor: Finds text in PDFs of given items.
findBatchLoadsInDateRange(Case, DateTime, DateTime) - Static method in class com.nuix.superutilities.reporting.IntersectionReport: Analyzes batch loads in the given case, determining which have a loaded datetime that falls within the specified range, returning the GUIDs of the batch loads which qualify.
findCaseDirectories(File) - Method in class com.nuix.superutilities.cases.CaseUtility: Searches for case directories in a given directory and sub-directories.
findCaseDirectories(String) - Method in class com.nuix.superutilities.cases.CaseUtility: Searches for case directories in a given directory and sub-directories.
findCaseDirectoryPaths(File) - Method in class com.nuix.superutilities.cases.CaseUtility: Searches for case directories in a given directory and sub-directories.
findCaseDirectoryPaths(String) - Method in class com.nuix.superutilities.cases.CaseUtility: Searches for case directories in a given directory and sub-directories.
findCaseInformation(File) - Method in class com.nuix.superutilities.cases.CaseUtility: Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
findCaseInformation(String) - Method in class com.nuix.superutilities.cases.CaseUtility: Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
findContainerAncestor(Item) - Method in class com.nuix.superutilities.items.SuperItemUtility: Traverses up an item's path to locate the nearest ancestor container item (kind:container) or null if there is no container ancestor item.
findContainerAncestors(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Similar to SuperItemUtility.findContainerAncestor(Item), but resolves nearest container ancestor items for multiple items at once.
findExpressionsInPdfFile(File, Collection<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactor: Generates NuixImageAnnotationRegion objects for matches found by Aspose in the given PDF based on the provided regular expressions.
findFamiliesWithoutItemsResponsiveToQuery(Case, Collection<Item>, String) - Method in class com.nuix.superutilities.items.SuperItemUtility
findItemsAndParents(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Resolves input collection of items to a set which includes both parents of input items and the input items themselves.
findMatchingItems(Case) - Method in class com.nuix.superutilities.misc.DigestList: Finds items in given case which have MD5s matching those found in this instance.
findMatchingItems(Case, int) - Method in class com.nuix.superutilities.misc.DigestList: Finds items in given case which have MD5s matching those found in this instance.
findParents(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Resolves input collection of items to parent items.
findPhysicalFileAncestor(Item) - Method in class com.nuix.superutilities.items.SuperItemUtility: Traverses up an item's path to locate the ancestor physical file item (flag:physical_file) or null if there is no physical file ancestor item.
findPhysicalFileAncestors(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Similar to SuperItemUtility.findPhysicalFileAncestor(Item), but resolves physical file ancestor items for multiple items at once.
fireProgressUpdated(int) - Method in class com.nuix.superutilities.regex.RegexScanner: Fires progress update if there is a callback listening
fireScanError(RegexScanError) - Method in class com.nuix.superutilities.regex.RegexScanner: Fires error event if there is a callback listening.
floatCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
forEach(Consumer<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
forgetItem(Item) - Method in class com.nuix.superutilities.export.PdfWorkCache: Removes PDF from cache and deletes it from the file system.
formatAsTextualTable(List<List<String>>) - Static method in class com.nuix.superutilities.misc.FormatUtility
formatNumber(double) - Method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for formatting numeric value using US locale.
formatNumber(int) - Method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for formatting numeric value using US locale.
formatNumber(long) - Method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for formatting numeric value using US locale.
FormatUtility - Class in com.nuix.superutilities.misc: Class which offers methods for formatting values.
FormatUtility() - Constructor for class com.nuix.superutilities.misc.FormatUtility
FreeSpaceMonitor - Class in com.nuix.superutilities.misc: Provides a way to monitor file system locations and act when available disk space drops below a specified threshold.
FreeSpaceMonitor() - Constructor for class com.nuix.superutilities.misc.FreeSpaceMonitor
FreeSpaceMonitorEventCallback - Interface in com.nuix.superutilities.misc: Interface for callback for free space monitoring offered by FreeSpaceMonitor.
fromCaseDirectories(List<File>) - Static method in class com.nuix.superutilities.cases.CaseInfo: Given a list of case paths (specified as File objects) creates a series of CaseInfo objects.
fromCasePaths(List<String>) - Static method in class com.nuix.superutilities.cases.CaseInfo: Given a list of case paths (specified as Strings) creates a series of CaseInfo objects.
fromFile(File) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
fromFile(String) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
fromLine(String) - Static method in class com.nuix.superutilities.loadfiles.OptRecord
fromLine(String[], String) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
FuzzyTermInfo - Class in com.nuix.superutilities.misc: Encapsulates information about a fuzzy term expression.
FuzzyTermInfo() - Constructor for class com.nuix.superutilities.misc.FuzzyTermInfo
fw - Variable in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter

G

generate(Case, String, IntersectionReportSheetConfiguration) - Method in class com.nuix.superutilities.reporting.IntersectionReport: Generates a new report sheet using the row criteria, column criteria and value generators currently assigned to this instance
generateMd5Bytes(Item) - Method in class com.nuix.superutilities.misc.ProfileDigester: Generates MD5 digest byte array for a given item.
generateMd5String(Item) - Method in class com.nuix.superutilities.misc.ProfileDigester: Generates MD5 digest hex string for a given item.
generateRecord(List<String>) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
generateRecord(Item) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
get(int) - Method in class com.nuix.superutilities.misc.NamedStringList
get(String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Get the value currently associated for a given placeholder
getAccessedDateTime() - Method in class com.nuix.superutilities.cases.CaseInfo: The case last accessed date time.
getAccessedDateTimeString() - Method in class com.nuix.superutilities.cases.CaseInfo: The case last accessed date time as a String.
getAdded() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getAdded() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getAdded() - Method in class com.nuix.superutilities.annotations.TagEvent
getAllowCaseMigration() - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Gets whether Nuix will be allowed to migrate cases as they are opened.
getAlwaysCreateTagOnImport() - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Gets whether a tag should always be created even when the source case had no items associated to that tag.
getApplyHighLights() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
getApplyRedactions() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
getAsposeSourcePageRectangle() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getAsposeWorkbook() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
getAsposeWorksheet() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Gets the underlying Aspose Cells Worksheet object.
getAssigned() - Method in class com.nuix.superutilities.annotations.CustodianEvent
getAssociatedItems(Case) - Method in class com.nuix.superutilities.annotations.AnnotationEvent
getBatchLoadMaxDate() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the maximum batch load date an item must have to be reported.
getBatchLoadMinDate() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the minimum batch load date an item must have to be reported.
getBatchName() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getBox() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getBugfix() - Method in class com.nuix.superutilities.misc.NuixVersion: Gets the determined bugfix portion of this version instance (0.0.x.0)
getBuild() - Method in class com.nuix.superutilities.misc.NuixVersion: Gets the determined build portion of this version instance (0.0.0.x)
getBulkAnnotater() - Static method in class com.nuix.superutilities.SuperUtilities: Convenience method to obtain Nuix BulkAnnotater
getCaptureContextualText() - Method in class com.nuix.superutilities.regex.RegexScanner
getCaseDirectory() - Method in class com.nuix.superutilities.cases.CaseInfo: Gets case directory associated with this instance.
getCaseDirectoryPath() - Method in class com.nuix.superutilities.cases.CaseInfo: Gets case directory associated with this instance.
getCaseInfo() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Gets information related to case which was locked
getCaseInfo() - Method in class com.nuix.superutilities.cases.CaseLockInfo
getCaseInfo() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Gets information related to case which was locked
getCaseInfo() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Gets information related to case which was locked
getCaseSensitive() - Method in class com.nuix.superutilities.regex.RegexScanner
getCaseUtility() - Method in class com.nuix.superutilities.SuperUtilities: Gets singleton of CaseUtility
getCell(int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Gets a particular Cell object from this work sheet.
getChildCaseCount() - Method in class com.nuix.superutilities.cases.CaseInfo: Count of child cases if this is a compound case.
getChildCases() - Method in class com.nuix.superutilities.cases.CaseInfo: A list of CaseInfo objects representing child cases if this is a compound case.
getChunkSize() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getColCategoryColorRing() - Method in class com.nuix.superutilities.reporting.IntersectionReport
getColCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the list of criteria used for each primary column category.
getColPrimaryCategoryLabel() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the overall primary column category label.
getColumnLabel() - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
getConcurrency() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getContentMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Get the matches associated specifically to the item's content text.
getContentTextUpdatedCount() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Gets a count of items which had a redacted custom metadata field recorded for the item's content text.
getContextSize() - Method in class com.nuix.superutilities.regex.RegexScanner
getContextualSubString(CharSequence, int, int, int) - Static method in class com.nuix.superutilities.regex.RegexScanner
getCreationDateTime() - Method in class com.nuix.superutilities.cases.CaseInfo: The case creation date time.
getCreationDateTimeString() - Method in class com.nuix.superutilities.cases.CaseInfo: The case creation date time as a String.
getCurrent() - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
getCurrent() - Static method in class com.nuix.superutilities.misc.NuixVersion: Attempts to determine current Nuix version by inspecting Nuix packages.
getCurrentRow() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
getCurrentVersion() - Static method in class com.nuix.superutilities.SuperUtilities: Gets NuixVersion object representing version of Nuix passed into init(Utilities, String)
getCustodian() - Method in class com.nuix.superutilities.annotations.CustodianEvent
getCustomMetadataFieldPrefix() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets the prefix applied to custom metadata fields names.
getCustomMetadataToScan() - Method in class com.nuix.superutilities.regex.RegexScanner
getDestinationFile() - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
getDigestCount(File) - Static method in class com.nuix.superutilities.misc.DigestList: Returns a count of digests present in the given Nuix binary digest list file.
getDigestCustomField() - Method in class com.nuix.superutilities.misc.ProfileDigester: Gets the name of the custom metadata field used to record custom digest when ProfileDigester.getRecordDigest() returns true.
getDotall() - Method in class com.nuix.superutilities.regex.RegexScanner
getEarliestEventStart(Case) - Static method in class com.nuix.superutilities.cases.CaseHistoryHelper: Convenience method for obtaining earliest case history event.
getEntityNames() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets the entity names currently associated with this instance
getError() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Gets the exception which was thrown
getError() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Gets the exception thrown
getError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getException() - Method in class com.nuix.superutilities.regex.RegexScanError: Gets the associated exception
getExcluded() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
getExclusionName() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
getExpectedItemCount() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
getExportDirectory() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getExportXlsx() - Method in class com.nuix.superutilities.export.CustomExporter: Gets whether DAT contents should additionally be exported as an XLSX spreadsheet.
getExpression() - Method in class com.nuix.superutilities.regex.PatternInfo: Gets the Java regular expression string associated with this instance
getExpression() - Method in class com.nuix.superutilities.regex.RegexMatch: Convenience method for obtaining the regular expression string from the associated PatternInfo object.
getExpressions() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Gets the regular expressions which will be used to locate text to markup.
getFbi2File() - Method in class com.nuix.superutilities.cases.CaseInfo: Gets file path of FBI2 file associated with this instance.
getFbi2FilePath() - Method in class com.nuix.superutilities.cases.CaseInfo: Gets file path of FBI2 file associated with this instance.
getFieldName() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getFilenamePrefix() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getFilenameTimestamp() - Method in class com.nuix.superutilities.misc.FormatUtility: Generates a time stamp string which is safe to use in a file or directory name.
getFirstPageRecords() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
getFolder() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getFormatUtility() - Method in class com.nuix.superutilities.SuperUtilities: Gets singleton of FormatUtility
getFreeBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getFreeGigaBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getFreezePanes() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets whether "freeze panes" will be applied to this sheet.
getFuzzyResolutionAlgorithm() - Method in class com.nuix.superutilities.misc.TermExpander: Gets which method this instance will use to resolve fuzzy terms.
getGuid() - Method in class com.nuix.superutilities.cases.CaseInfo: The case GUID of this case.
getGuidRefInsertBatchSize() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
getHeadersFromRecord(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
getHeadersOnFirstChunkOnly() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getHeight() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getHost() - Method in class com.nuix.superutilities.cases.CaseLockInfo
getHtmlText(String) - Static method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.
getId() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getIncludeChildGuids() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether child GUIDs should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
getIncludeCustomMetadata() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether item custom metadata will be included in generated JSON
getIncludeItemText() - Method in class com.nuix.superutilities.misc.ProfileDigester: Gets whether this instance should include the item's content text when calculating a digest.
getIncludeParentGuid() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether parent GUID should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
getIncludePathGuids() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether path GUIDs should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
getIncludeProperties() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether item metadata properties will be included in generated JSON
getIncludeTags() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether items' tags will be included in generated JSON
getIncludeText() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether item content text will be included in generated JSON
getInstance() - Static method in class com.nuix.superutilities.cases.CaseUtility
getInstance() - Static method in class com.nuix.superutilities.items.SuperItemUtility
getInstance() - Static method in class com.nuix.superutilities.misc.FormatUtility
getInstance() - Static method in class com.nuix.superutilities.SuperUtilities: Obtains singleton of this class.
getIntegerInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
getInvestigator() - Method in class com.nuix.superutilities.cases.CaseInfo: The investigator value.
getItem() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getItem(Case) - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Gets the associated item.
getItem(Case) - Method in class com.nuix.superutilities.regex.RegexScanError: Gets the associated item
getItemGuid() - Method in class com.nuix.superutilities.regex.RegexScanError
getItemId(Item) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Gets the sequentially assigned ID value from the Item table for a given item based on its GUID.
getItemMarkupCount() - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Gets the number of markups present in the ItemMarkup table.
getItemsAndNeighboringSiblings(List<Item>, int, int) - Method in class com.nuix.superutilities.items.SuperItemUtility: Gets items and sibling items within a certain ordinal distance.
getItemSetName() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getItemUtility() - Static method in class com.nuix.superutilities.SuperUtilities: Convenience method to obtain Nuix ItemUtility
getJarDirectory() - Method in class com.nuix.superutilities.SuperUtilities: Get file path of directory in which SuperUtilities.jar resides
getJarDirectoryPath() - Method in class com.nuix.superutilities.SuperUtilities: Get file path of directory in which SuperUtilities.jar resides
getJarFile() - Method in class com.nuix.superutilities.SuperUtilities: Get file path of SuperUtilities.jar
getJarFilePath() - Method in class com.nuix.superutilities.SuperUtilities: Get file path of SuperUtilities.jar
getKeepOriginalDat() - Method in class com.nuix.superutilities.export.CustomExporter: Gets whether original DAT will be kept by moving it to final export directory.
getLabel() - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator: Gets the label associated to this instance.
getLastUpdated() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getLatestEventStart(Case) - Static method in class com.nuix.superutilities.cases.CaseHistoryHelper: Convenience method for obtaining most recent case history event.
getLocation() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets the location of match such as content or metdata property name.
getLocation() - Method in class com.nuix.superutilities.regex.RegexScanError: Gets the associated location
getLockProperties() - Method in class com.nuix.superutilities.cases.CaseInfo: If case is determined to be locked, gets information about who is currently locking the case.
getMajor() - Method in class com.nuix.superutilities.misc.NuixVersion: Gets the determined major portion of this version instance (X.0.0.0)
getMarkupSet(Case) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Gets the Nuix MarkupSet object based on the markup set name as set by BulkRedactorSettings.setMarkupSetName(String).
getMarkupSetId(MarkupSet) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Gets the sequentially assigned ID value from the MarkupSet table for a given markup.
getMarkupSetName() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Gets the name of the markup set to which markups will be recorded against.
getMatchCount() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Gets the number of matches currently associated with this instance.
getMatchedTerm() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
getMatchEnd() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets the offset in source text where match ends
getMatches() - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
getMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Gets the matches associated.
getMatchNamedEntityValues() - Method in class com.nuix.superutilities.regex.RegexScanner
getMatchStart() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets the offset in source text where match starts
getMinor() - Method in class com.nuix.superutilities.misc.NuixVersion: Gets the determined minor portion of this version instance (0.X.0.0)
getMultiline() - Method in class com.nuix.superutilities.regex.RegexScanner
getName() - Method in class com.nuix.superutilities.cases.CaseInfo: The name of this case.
getName() - Method in class com.nuix.superutilities.misc.NamedStringList
getName() - Method in class com.nuix.superutilities.reporting.NamedQuery: Gets the associated name
getNamedEntityTypes() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Gets the list of named entity types to be redacted.
getNamedEntityTypes() - Method in class com.nuix.superutilities.regex.RegexScanner
getNuixUtilities() - Method in class com.nuix.superutilities.SuperUtilities: Gets the underlying regular API utilities object
getOcurrences() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
getOnlyRecordChanges() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets value determining whether only values that have a redaction performed should be recorded.
getOrCreateRelatedItemSet(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getOriginalTerm() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
getPageNumber() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getPages() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getPath() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getPathString() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo: Gets the path this instance is associated with.
getPattern() - Method in class com.nuix.superutilities.regex.PatternInfo: Gets the compiled Pattern object.
getPatternInfo() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets the associated PatternInfo object which made the match.
getPatternInfo() - Method in class com.nuix.superutilities.regex.RegexScanError: Gets the associated pattern info
getPatterns() - Method in class com.nuix.superutilities.regex.RegexScanner
getPdfPath(Item) - Method in class com.nuix.superutilities.export.PdfWorkCache: Gets the path to a PDF exported for an item if it is already exported.
getPhysicalAncestorPath(Item) - Method in class com.nuix.superutilities.items.SuperItemUtility: Returns the file system path of an item's physical file ancestor.
getPrettyPrint() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether JSON will be "pretty printed".
getProduct() - Method in class com.nuix.superutilities.cases.CaseLockInfo
getProfile() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
getProfile() - Method in class com.nuix.superutilities.misc.ProfileDigester: Gets the metadata profile used to obtain the values provided to the hash computation.
getPropertiesToScan() - Method in class com.nuix.superutilities.regex.RegexScanner
getPropertyMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection: Gets the matches associated specifically to the item's property text.
getQuery() - Method in class com.nuix.superutilities.reporting.NamedQuery: Gets the associated query
getReaction() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Gets the reaction that should be taken to this case being locked
getReaction() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Gets the reaction that should be taken
getReaction() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Gets the reaction that should be taken
getRecordDigest() - Method in class com.nuix.superutilities.misc.ProfileDigester: Gets whether this instance will record the digest used.
getRecords() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
getRecordTimeOfRedaction() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets whether a custom metadata field will be written to updated items with a time stamp of when the redaction was performed.
getRedactContentText() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets value determining whether item's content text should be processed
getRedactionReplacementTemplate() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets the template string used to generate the replacement text put in place of a redaction in the text.
getRedactProperties() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets value determining whether metadata properties should be processed.
getRegenerateStored() - Method in class com.nuix.superutilities.export.PdfWorkCache
getRelatedItemSet(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getRowCategoryLabel() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the overall row category label.
getRowCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the list of criteria used for each row.
getSavedByName() - Method in class com.nuix.superutilities.cases.CaseInfo: The saved by name.
getSavedByVersion() - Method in class com.nuix.superutilities.cases.CaseInfo: The saved by version.
getScanContent() - Method in class com.nuix.superutilities.regex.RegexScanner
getScanCustomMetadata() - Method in class com.nuix.superutilities.regex.RegexScanner
getScanProperties() - Method in class com.nuix.superutilities.regex.RegexScanner
getScopeQuery() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the current scope query which scopes the overall item set reported on.
getSerializeNulls() - Method in class com.nuix.superutilities.export.JsonExporter: Gets whether entries with a null value are included in the generated JSON
getSettings() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
getSheet(String) - Method in class com.nuix.superutilities.reporting.SimpleXlsx
getSimilarity() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
getSnapshotFirstSync() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Gets whether a more succinct snapshot should be created in a new database.
getSourceRepo() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
getSpecificProperties() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets list of specific metadata property names to be scanned.
getStoreCount() - Method in class com.nuix.superutilities.cases.CaseInfo: Store count of this case.
getStringCustomMetadata(Item, Set<String>) - Static method in class com.nuix.superutilities.regex.RegexScanner: Convenience method for converting the custom metadata fields of an item into a Map<String,String> so that regular expressions may be ran against them.
getStringProperties(Item, Set<String>) - Static method in class com.nuix.superutilities.regex.RegexScanner: Convenience method for converting the metadata properties of an item into a Map<String,String> so that regular expressions may be ran against them.
getStyle(int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Gets the style of a particular cell in this work sheet
getSuperItemUtility() - Method in class com.nuix.superutilities.SuperUtilities: Gets singleton of SuperItemUtility
getSyncCustodianEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getSyncCustomMetadataEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getSyncExclusionEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getSyncItemSetEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getSyncProductionSetEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getSyncTagEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
getTag() - Method in class com.nuix.superutilities.annotations.TagEvent
getTagId(String) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Gets the sequentially assigned ID value from the Tag table for a given tag name.
getTagsForGuid(String) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Queries the DB for the names of tags associated with the provided GUID.
getTagsForMd5(String) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Queries the DB for the names of tags associated with the provided MD5.
getTargetSimilarity() - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
getTempDirectory() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Gets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
getTerm() - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
getText() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getTextInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
getTimeOfRedactionFieldName() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Gets the name of the custom metadata field used to record redaction time stamp when NamedEntityRedactionSettings.getRecordTimeOfRedaction() returns true.
getTimeStamp() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
getTint(int, int, int, float) - Static method in class com.nuix.superutilities.reporting.AsposeCellsColorHelper: Tints a color by the given degree
getTint(Color, float) - Static method in class com.nuix.superutilities.reporting.AsposeCellsColorHelper: Provides a tinted variation of the provided base color
getTitle() - Method in class com.nuix.superutilities.regex.PatternInfo: Gets the title associated with this instance
getTotal() - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
getTotalBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getTotalEventCount() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Returns the total number of event entries in the database file
getTotalGigaBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
getUnitBase() - Static method in class com.nuix.superutilities.misc.FormatUtility: Gets the unit base which will be used in size calculations.
getUpdatedItemCount() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Gets the number of items which had at least one redaction recorded to a custom metadata field.
getUpdatedProperties() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Gets a map of properties by name and how many times each property had a redacted custom metadata field recorded for it.
getUpdatedPropertyNames() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Gets a listing of metadata properties that had a redacted custom metadat field recorded for them at least once.
getUseExistingValueWhenPresent() - Method in class com.nuix.superutilities.misc.ProfileDigester: Gets whether an existing value in the specified custom metadata field should be used if present.
getUser() - Method in class com.nuix.superutilities.cases.CaseLockInfo
getUseSIUnits() - Static method in class com.nuix.superutilities.misc.FormatUtility: Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
getValue() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValue() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets the matched value
getValue(int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Gets the value of a particular cell in this work sheet
getValueAsByteArray() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueAsDateTime() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueAsDouble() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueAsInteger() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueAsLong() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueAsString() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getValueContext() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets contextual string of match if one was provided
getValueGenerators() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Gets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
getValueType() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
getVolume() - Method in class com.nuix.superutilities.loadfiles.OptRecord
getVolumeNames() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
getWidth() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getX() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
getY() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
GUID - com.nuix.superutilities.annotations.AnnotationMatchingMethod

H

hadError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
hasBatchLoadDateCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
hashCode() - Method in class com.nuix.superutilities.cases.CaseInfo
hashCode() - Method in class com.nuix.superutilities.misc.NamedStringList
hasNext() - Method in class com.nuix.superutilities.cases.CaseHistoryHelper
hasNext() - Method in class com.nuix.superutilities.reporting.ColorRing
hasSameGuidAs(Case) - Method in class com.nuix.superutilities.cases.CaseInfo: Determines whether a Nuix case object shares the same GUID as this CaseInfo object.
hexToBytes(String) - Static method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for converting hex string to byte array.
htmlToPdf(String, File) - Static method in class com.nuix.superutilities.export.TemplateExporter
htmlToPdf(String, String) - Static method in class com.nuix.superutilities.export.TemplateExporter

I

importCaseLevelDigestList(Case, String) - Method in class com.nuix.superutilities.misc.DigestList: Imports digests from a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
importFile(File) - Method in class com.nuix.superutilities.misc.DigestList: Imports digests found in given input file to this instance (if not already present).
importFile(String) - Method in class com.nuix.superutilities.misc.DigestList: Imports digests found in given input file to this instance (if not already present).
importSystemLevelDigestList(String) - Method in class com.nuix.superutilities.misc.DigestList: Imports digests from a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location).
importUserLevelDigestList(String) - Method in class com.nuix.superutilities.misc.DigestList: Imports digests from a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location).
indexOf(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
init(Utilities, String) - Static method in class com.nuix.superutilities.SuperUtilities: Initializes this class.
initializeAspose() - Static method in class com.nuix.superutilities.reporting.SimpleXlsx
instance - Static variable in class com.nuix.superutilities.cases.CaseUtility
integerCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
IntersectionReport - Class in com.nuix.superutilities.reporting: This class generates an "intersection report".
IntersectionReport(String) - Constructor for class com.nuix.superutilities.reporting.IntersectionReport: Creates a new instance
IntersectionReportProgressCallback - Interface in com.nuix.superutilities.reporting
IntersectionReportSheetConfiguration - Class in com.nuix.superutilities.reporting
IntersectionReportSheetConfiguration() - Constructor for class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
isAtLeast(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is greater than or equal to this instance
isAtLeast(String) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is greater than or equal to this instance
isCompound() - Method in class com.nuix.superutilities.cases.CaseInfo: Whether this case has been determined to be a compound case
isContentMatch() - Method in class com.nuix.superutilities.regex.RegexMatch: Gets whether this match was made in the content text of an item.
isEmpty() - Method in class com.nuix.superutilities.misc.NamedStringList
isEqualTo(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is equal to this instance
isEqualTo(String) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is equal to this instance
isFirstPage() - Method in class com.nuix.superutilities.loadfiles.OptRecord
isFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo
isGreaterThan(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is greater than this instance
isGreaterThan(String) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is greater than this instance
isLessThan(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is less than this instance
isLessThan(String) - Method in class com.nuix.superutilities.misc.NuixVersion: Determines whether another instance's version is less than this instance
isLocked() - Method in class com.nuix.superutilities.cases.CaseInfo: Whether this case was determined to be locked, as determined by the presence of a case.lock file in the specified case directory.
ItemRegexMatchCollection - Class in com.nuix.superutilities.regex: Represents an item and the associated regular expression matches made against it.
ItemRegexMatchCollection(Item) - Constructor for class com.nuix.superutilities.regex.ItemRegexMatchCollection: Creates a new empty instance against the specified item.
items - Variable in class com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
itemsAreSiblings(Item, Item) - Method in class com.nuix.superutilities.items.SuperItemUtility: Tests whether 2 items have the same parent by comparing their tree position values
ItemSetEvent - Class in com.nuix.superutilities.annotations
ItemSetEvent() - Constructor for class com.nuix.superutilities.annotations.ItemSetEvent
itemTypeMapCache - Static variable in class com.nuix.superutilities.export.JsonExporter
iterator() - Method in class com.nuix.superutilities.misc.DigestList: Provides an iterator over the hexadecimal string versions of the MD5s present in this instance.
iterator() - Method in class com.nuix.superutilities.misc.NamedStringList

J

JaroWinkler - com.nuix.superutilities.misc.SimilarityCalculation
jodaTimeAutomaticParsing - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser
joinByAnd(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Joins a series of expressions by " AND ", so expressions "cat", "dog" would become "cat AND dog".
joinByOr(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Joins a series of expressions by " OR ", so expressions "cat", "dog" would become "cat OR dog".
JsonExporter - Class in com.nuix.superutilities.export
JsonExporter() - Constructor for class com.nuix.superutilities.export.JsonExporter

L

label - Variable in class com.nuix.superutilities.reporting.ColumnValueGenerator
lastIndexOf(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
LevenshteinDistance - Class in com.nuix.superutilities.misc
LevenshteinDistance() - Constructor for class com.nuix.superutilities.misc.LevenshteinDistance
listIterator() - Method in class com.nuix.superutilities.misc.NamedStringList
listIterator(int) - Method in class com.nuix.superutilities.misc.NamedStringList
longCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
LuceneLevenshstein - com.nuix.superutilities.misc.SimilarityCalculation

M

makeGuidPath(Item, File, String) - Static method in class com.nuix.superutilities.misc.FormatUtility
mapAddress(Address) - Static method in class com.nuix.superutilities.export.JsonExporter: Converts a Nuix Address object to a HashMap<String,Object> for JSON serialization.
mapAddresses(List<Address>) - Static method in class com.nuix.superutilities.export.JsonExporter: Converts a List of Nuix Address objects to a list of HashMap<String,Object> for JSON serialization.
mapCommunication(Communication) - Static method in class com.nuix.superutilities.export.JsonExporter: Converts a Nuix Communication object to a HashMap<String,Object> for JSON serialization.
mapItem(Item) - Method in class com.nuix.superutilities.export.JsonExporter: Converts a Nuix item into a series of nested Map objects, which later can be easily serialized into JSON.
mapItemType(ItemType) - Static method in class com.nuix.superutilities.export.JsonExporter: Converts a Nuix ItemType object to a HashMap<String,String> for JSON serialization.
mapProperties(Map<String, Object>) - Static method in class com.nuix.superutilities.export.JsonExporter: This method generates a Map of the properties for an item, organizing properties into sub-categories based on the data type of their values.
mapSourceItem(SourceItem) - Method in class com.nuix.superutilities.export.JsonExporter: This method takes a provided SourceItem and generates a series of nested Map instances representing the SourceItem and its data.
mapWorkerItem(WorkerItem) - Method in class com.nuix.superutilities.export.JsonExporter: This method take a provided WorkerItem and generates a series of nested Map instances representing the WorkerItem and its data.
markupSetQuery(MarkupSet) - Static method in class com.nuix.superutilities.query.QueryHelper
maximum - Variable in class com.nuix.superutilities.misc.BoundedProgressInfo: The maximum progress value
MD5 - com.nuix.superutilities.annotations.AnnotationMatchingMethod
mergeCols(int, int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Merges a series of cells horizontally
mergeOther(NamedEntityRedactionResults) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Combines counts from another instance into this instance.
mergePdfFiles(File, List<File>, boolean, List<String>) - Static method in class com.nuix.superutilities.misc.PdfUtility: Merges multiple PDF files into a single PDF file.
mergePdfFiles(String, List<String>, boolean, List<String>) - Static method in class com.nuix.superutilities.misc.PdfUtility: Merges multiple PDF files into a single PDF file.
monitorEventOccurred(FreeSpaceMonitor, DriveSpaceInfo) - Method in interface com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback

N

namedEntityQuery(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Generates a query to find items which have a match for any of the provided named entities.
NamedEntityRedactionProgressCallback - Interface in com.nuix.superutilities.namedentities: Provides progress status callback functionality for NamedEntityUtility.
NamedEntityRedactionResults - Class in com.nuix.superutilities.namedentities
NamedEntityRedactionResults() - Constructor for class com.nuix.superutilities.namedentities.NamedEntityRedactionResults
NamedEntityRedactionSettings - Class in com.nuix.superutilities.namedentities: Provides settings for performing named entity text redaction performed by NamedEntityUtility, specifically in the methods NamedEntityUtility.recordRedactedCopies(nuix.Item, NamedEntityRedactionSettings), NamedEntityUtility.recordRedactedCopies(Collection, NamedEntityRedactionSettings) and NamedEntityUtility.recordRedactedCopies(nuix.Case, NamedEntityRedactionSettings).
NamedEntityRedactionSettings() - Constructor for class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
NamedEntityUtility - Class in com.nuix.superutilities.namedentities: Provides functionality for working with Nuix named entities.
NamedEntityUtility() - Constructor for class com.nuix.superutilities.namedentities.NamedEntityUtility
NamedQuery - Class in com.nuix.superutilities.reporting: Encapsulates a Nuix query string and an associated name.
NamedQuery() - Constructor for class com.nuix.superutilities.reporting.NamedQuery
NamedQuery(String, String) - Constructor for class com.nuix.superutilities.reporting.NamedQuery
NamedStringList - Class in com.nuix.superutilities.misc
NamedStringList() - Constructor for class com.nuix.superutilities.misc.NamedStringList
next() - Method in class com.nuix.superutilities.cases.CaseHistoryHelper
next() - Method in class com.nuix.superutilities.reporting.ColorRing
NGram - com.nuix.superutilities.misc.SimilarityCalculation
notJoinByAnd(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Returns a query in the form: NOT (a AND b AND c) with a,b and c being expressions provided.
notJoinByOr(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Returns a query in the form: NOT (a OR b OR c) with a,b and c being expressions provided.
Nuix - com.nuix.superutilities.misc.SimilarityCalculation
NuixImageAnnotationRegion - Class in com.nuix.superutilities.annotations
NuixImageAnnotationRegion() - Constructor for class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
NuixVersion - Class in com.nuix.superutilities.misc: Assists in representing a Nuix version in object form to assist with comparing two versions.
NuixVersion() - Constructor for class com.nuix.superutilities.misc.NuixVersion: Creates a new instance defaulting to version 0.0.0
NuixVersion(int) - Constructor for class com.nuix.superutilities.misc.NuixVersion: Creates a new instance using the provided major version: major.0.0.0
NuixVersion(int, int) - Constructor for class com.nuix.superutilities.misc.NuixVersion: Creates a new instance using the provided major and minor versions: major.minor.0.0
NuixVersion(int, int, int) - Constructor for class com.nuix.superutilities.misc.NuixVersion: Creates a new instance using the provided major, minor and bugfix versions: major.minor.bugfix.0
NuixVersion(int, int, int, int) - Constructor for class com.nuix.superutilities.misc.NuixVersion: Creates a new instance using the provided major, minor, bugfix and build versions: major.minor.bugfix.build
numericParser - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser

O

onCaseIsLocked(Consumer<CaseLockedEventInfo>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Optional callback which is called when a case is found to be locked in another session of Nuix while being opened.
onErrorOpeningCase(Consumer<CaseOpenErrorEvent>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Optional callback which is called when opening a case has an error.
onUserFunctionError(Consumer<WorkFunctionErrorEvent>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Optional callback which is called when callback provided to BulkCaseProcessor.withEachCase(CaseConsumer) or BulkCaseProcessor.withEachCase(Case, CaseConsumer) throws an exception.
OptLoadFile - Class in com.nuix.superutilities.loadfiles
OptLoadFile() - Constructor for class com.nuix.superutilities.loadfiles.OptLoadFile
OptRecord - Class in com.nuix.superutilities.loadfiles
OptRecord() - Constructor for class com.nuix.superutilities.loadfiles.OptRecord
orTagQuery(String...) - Static method in class com.nuix.superutilities.query.QueryHelper
orTagQuery(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
otherCategory - Static variable in class com.nuix.superutilities.export.JsonExporter

P

parallelStream() - Method in class com.nuix.superutilities.misc.NamedStringList
parenThenJoinByAnd(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Joins a series of expressions by " AND " after wrapping each expression in parentheses.
parenThenJoinByOr(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper: Joins a series of expressions by " OR " after wrapping each expression in parentheses.
parse(String) - Static method in class com.nuix.superutilities.misc.NuixVersion: Parses a version string into a NuixVersion instance.
parse(String) - Method in class com.nuix.superutilities.misc.PrimitiveTypeParser
parseAndCopy(Map<String, ?>) - Method in class com.nuix.superutilities.misc.PrimitiveTypeParser
parseAndCopy(Map<String, ?>, Function<String, String>) - Method in class com.nuix.superutilities.misc.PrimitiveTypeParser
parseFbi2File() - Method in class com.nuix.superutilities.cases.CaseInfo: Parses information from FBI2 file
parseFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo: Parses a fuzzy term string into component term and similarity score.
parseWithFallback(String, Object) - Method in class com.nuix.superutilities.misc.PrimitiveTypeParser
PatternInfo - Class in com.nuix.superutilities.regex: Represents a regular expression including associated title.
PatternInfo(String, String) - Constructor for class com.nuix.superutilities.regex.PatternInfo: Create a new instance
PdfUtility - Class in com.nuix.superutilities.misc: A class containing some helper methods for PDFs.
PdfUtility() - Constructor for class com.nuix.superutilities.misc.PdfUtility
PdfWorkCache - Class in com.nuix.superutilities.export: This class provides access to PDFs as files when you need them on the file system to perform some operation.
PdfWorkCache(File) - Constructor for class com.nuix.superutilities.export.PdfWorkCache: Creates a new instance
percentageComplete() - Method in class com.nuix.superutilities.misc.BoundedProgressInfo: Provides a percentage completed value by dividing double value of current by double value of maximum.
PeriodicGatedConsumer<T> - Class in com.nuix.superutilities.misc: A wrapper for a Consumer instance which will only periodically forward call to accept method of wrapped instance.
PeriodicGatedConsumer(Consumer<T>) - Constructor for class com.nuix.superutilities.misc.PeriodicGatedConsumer
PeriodicGatedConsumer(Consumer<T>, long) - Constructor for class com.nuix.superutilities.misc.PeriodicGatedConsumer
phraseToExpression(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Converts a phrase (string with potentially multiple terms) into a regular expression for used searching for text to redact in a PDF.
PlaceholderResolver - Class in com.nuix.superutilities.misc: This class provides a way to allow user input to make use of place holder values which will be substituted at run time with appropriate values.
PlaceholderResolver() - Constructor for class com.nuix.superutilities.misc.PlaceholderResolver
PrimitiveTypeParser - Class in com.nuix.superutilities.misc
PrimitiveTypeParser() - Constructor for class com.nuix.superutilities.misc.PrimitiveTypeParser
ProductionSetEvent - Class in com.nuix.superutilities.annotations
ProductionSetEvent() - Constructor for class com.nuix.superutilities.annotations.ProductionSetEvent
ProfileDigester - Class in com.nuix.superutilities.misc: Provides functionality related to generating an MD5 digest for an item based on a concatenation of the values yielded by a MetadataProfile for a given item.
ProfileDigester() - Constructor for class com.nuix.superutilities.misc.ProfileDigester
ProfileDigester(MetadataProfile) - Constructor for class com.nuix.superutilities.misc.ProfileDigester
ProgressInfo - Class in com.nuix.superutilities.misc: Represents progress of an indeterminate operation where the maximum progress value is not known until completion.
ProgressInfo(String, long) - Constructor for class com.nuix.superutilities.misc.ProgressInfo
progressUpdated(int, int) - Method in interface com.nuix.superutilities.reporting.IntersectionReportProgressCallback
progressUpdated(int, int, NamedEntityRedactionResults) - Method in interface com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback

Q

QueryHelper - Class in com.nuix.superutilities.query
QueryHelper() - Constructor for class com.nuix.superutilities.query.QueryHelper

R

recordRedactedCopies(Collection<Item>, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Creates redacted copies of metadata properties and item content text by performing find and replace operations by finding named entity matches in the values and replacing them with redaction text.
recordRedactedCopies(Case, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Creates redacted copies of metadata properties and item content text by performing find and replace operations by finding named entity matches in the values and replacing them with redaction text.
recordRedactedCopies(Case, Collection<Item>, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Creates redacted copies of metadata properties and item content text by performing find and replace operations by finding named entity matches in the values and replacing them with redaction text.
recordRedactedCopies(Item, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Creates redacted copies of metadata properties and item content text by performing find and replace operations by finding named entity matches in the values and replacing them with redaction text.
refresh() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo: Causes this instance to refresh values for total bytes and free bytes returned by methods DriveSpaceInfo.getTotalBytes() and DriveSpaceInfo.getFreeBytes().
RegexMatch - Class in com.nuix.superutilities.regex: Represents information about a regular expression match.
RegexMatch(PatternInfo, String, boolean, String, String, int, int) - Constructor for class com.nuix.superutilities.regex.RegexMatch: Creates a new instance
RegexScanError - Class in com.nuix.superutilities.regex: Represents information about an error which occurred in RegexScanner while scanning.
RegexScanError(Item, PatternInfo, String, Exception) - Constructor for class com.nuix.superutilities.regex.RegexScanError: Creates a new instance
RegexScanner - Class in com.nuix.superutilities.regex: Class for scanning a series of items with a series of regular expressions.
RegexScanner() - Constructor for class com.nuix.superutilities.regex.RegexScanner
remove(int) - Method in class com.nuix.superutilities.misc.NamedStringList
remove(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
removeAll(Collection<?>) - Method in class com.nuix.superutilities.misc.NamedStringList
removeDynamicPlaceholder(String) - Method in class com.nuix.superutilities.export.CustomExporter: Removes a previously added dynamic placeholder.
removeIf(Predicate<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
removeItem(Item) - Method in class com.nuix.superutilities.misc.DigestList: Removes MD5 of provided item from this instance.
removeItems(Collection<Item>) - Method in class com.nuix.superutilities.misc.DigestList: Removes MD5s from this instance based on the MD5s of the given items.
removeItemsResponsiveToQuery(Case, Collection<Item>, String) - Method in class com.nuix.superutilities.items.SuperItemUtility: Convenience method for removing items responsive to a query from another collection of items.
removeMd5(byte[]) - Method in class com.nuix.superutilities.misc.DigestList: Removes the given MD5 from this instance.
removeMd5(String) - Method in class com.nuix.superutilities.misc.DigestList: Removes the given MD5 from this instance.
render(Item) - Method in class com.nuix.superutilities.export.TemplateExporter
render(Item, Map<String, Object>) - Method in class com.nuix.superutilities.export.TemplateExporter
renderToFile(Item, File, Map<String, Object>) - Method in class com.nuix.superutilities.export.TemplateExporter
renderToFile(Item, String, Map<String, Object>) - Method in class com.nuix.superutilities.export.TemplateExporter
renderToPdf(Item, File, Map<String, Object>) - Method in class com.nuix.superutilities.export.TemplateExporter
replaceAll(UnaryOperator<String>) - Method in class com.nuix.superutilities.misc.NamedStringList
replay(Case) - Method in class com.nuix.superutilities.annotations.AnnotationEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.CustodianEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.ExclusionEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.ProductionSetEvent
replay(Case) - Method in class com.nuix.superutilities.annotations.TagEvent
resolvePlaceholders(String, Map<String, Object>) - Method in class com.nuix.superutilities.misc.FormatUtility: Simple method to replace place holders with values in a template string.
resolveTemplate(String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Resolves place holders into a string based on the currently associated values
resolveTemplateMultiValues(String, List<NamedStringList>) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Resolves place holders into a string based on the currently associated values and the multi-value place holders provided.
resolveTemplatePath(String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Resolves placeholders into a path string based on the currently associated values.
resolveTemplatePathMultiValues(String, List<NamedStringList>) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Resolves placeholders into a string based on the currently associated values and the multi-value place holders provided.
restart() - Method in class com.nuix.superutilities.reporting.ColorRing: Moves position of this collection back to the start so that next call to ColorRing.next() will return the first color in the sequence.
retainAll(Collection<?>) - Method in class com.nuix.superutilities.misc.NamedStringList
retry() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Notifies BulkCaseProcessor that it should try to open this case again
retry() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Notifies BulkCaseProcessor that it should try to open this case again
Retry - com.nuix.superutilities.cases.CaseIssueReaction
round(double, int) - Static method in class com.nuix.superutilities.misc.FormatUtility: Helper method for rounding a decimal value to a particular number of decimal places.

S

save() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
saveAs(String) - Method in class com.nuix.superutilities.reporting.SimpleXlsx
saveCaseLevelDigestList(Case, String) - Method in class com.nuix.superutilities.misc.DigestList: Saves a new digest list to a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
saveDiagnostics(File) - Method in class com.nuix.superutilities.SuperUtilities: Saves a diagnostics zip file (similar to same operation in the workbench GUI)
saveDiagnostics(String) - Method in class com.nuix.superutilities.SuperUtilities: Saves a diagnostics zip file (similar to same operation in the GUI)
saveFile(File) - Method in class com.nuix.superutilities.misc.DigestList: Saves a new Nuix binary digest list based on the digests stored in memory of this instance.
saveRedactionProfile(File, NamedEntityRedactionResults, NamedEntityRedactionSettings) - Static method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Builds and saves to a file a Nuix metadata profile containing fields 'Name' and 'Position' as well as a series of derived fields that use "first-non-blank" to coalesce a redacted field and the based original field.
saveRedactionProfile(String, NamedEntityRedactionResults, NamedEntityRedactionSettings) - Static method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Builds and saves to a file a Nuix metadata profile containing fields 'Name' and 'Position' as well as a series of derived fields that use "first-non-blank" to coalesce a redacted field and the based original field.
saveSystemLevelDigestList(String) - Method in class com.nuix.superutilities.misc.DigestList: Saves a new digest list to a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location).
saveUserLevelDigestList(String) - Method in class com.nuix.superutilities.misc.DigestList: Saves a new digest list to a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location).
scanItem(Item) - Method in class com.nuix.superutilities.regex.RegexScanner: Scans a single item
scanItems(Collection<Item>) - Method in class com.nuix.superutilities.regex.RegexScanner: Scans a series of items serially (no concurrency)
scanItems(Collection<Item>, Consumer<ItemRegexMatchCollection>) - Method in class com.nuix.superutilities.regex.RegexScanner: Scans a series of items, providing each item's matches to callback as they are obtained.
scanItemsParallel(Collection<Item>, Consumer<ItemRegexMatchCollection>) - Method in class com.nuix.superutilities.regex.RegexScanner: Scans a series of items, providing each item's matches to callback as they are obtained.
scanItemsParallel(Collection<Item>, Consumer<ItemRegexMatchCollection>, int) - Method in class com.nuix.superutilities.regex.RegexScanner: Scans a series of items, providing each item's matches to callback as they are obtained.
ScriptedColumnValueGenerator - Class in com.nuix.superutilities.reporting: A ColumnValueGenerator which uses the provided BiFunction expression to calculate its value.
ScriptedColumnValueGenerator(String, String, BiFunction<Case, String, Object>) - Constructor for class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
ScriptedColumnValueGenerator(String, BiFunction<Case, String, Object>) - Constructor for class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator: Creates a new instance which will used the specified expression.
secondsToElapsedString(long) - Method in class com.nuix.superutilities.misc.FormatUtility: Converts a value representing some number of seconds to an "elapsed" string.
secondsToElapsedString(Double) - Method in class com.nuix.superutilities.misc.FormatUtility: Converts a value representing some number of seconds to an "elapsed" string.
set(int, String) - Method in class com.nuix.superutilities.misc.NamedStringList
set(String, String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Set they value for a given placeholder
setAllowCaseMigration(boolean) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Sets whether Nuix will be allowed to migrate cases as they are opened.
setAlwaysCreateTagOnImport(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Sets whether a tag should always be created even when the source case had no items associated to that tag.
setApplyHighLights(boolean) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
setApplyRedactions(boolean) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
setAsposeSourcePageRectangle(Rectangle) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setBatchLoadMaxDate(DateTime) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the maximum batch load date an item must have to be reported.
setBatchLoadMinDate(DateTime) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the minimum batch load date an item must have to be reported.
setBox(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setBugfix(int) - Method in class com.nuix.superutilities.misc.NuixVersion: Sets the determined bugfix portion of this version instance (0.0.x.0)
setBuild(int) - Method in class com.nuix.superutilities.misc.NuixVersion: Sets the build portion of this version instance (0.0.0.x)
setCaptureContextualText(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setCaseInfo(CaseInfo) - Method in class com.nuix.superutilities.cases.CaseLockInfo
setCaseSensitive(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setChunkSize(int) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setColCategoryColorRing(ColorRing) - Method in class com.nuix.superutilities.reporting.IntersectionReport
setColCriteria(List<NamedQuery>) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the list of criteria used for each primary column category.
setColPrimaryCategoryLabel(String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the overall primary column category label.
setColumnLabel(String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
setColumnRemovals(Collection<String>) - Method in class com.nuix.superutilities.export.CustomExporter: Allows you to provide a list of header names to specify columns to remove.
setConcurrency(int) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setContextSize(int) - Method in class com.nuix.superutilities.regex.RegexScanner
setCurrent(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
setCurrentRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
setCustomMetadataFieldPrefix(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets the prefix applied to custom metadata fields names.
setCustomMetadataToScan(List<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
setDigestCustomField(String) - Method in class com.nuix.superutilities.misc.ProfileDigester: Sets the name of the custom metadata field used to record custom digest when ProfileDigester.getRecordDigest() returns true.
setDotall(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setDynamicPlaceholder(String, BiFunction<Item, String, String>) - Method in class com.nuix.superutilities.export.CustomExporter: Assigns a dynamically calculated placeholder to this instance.
setExportDirectory(File) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setExportDirectory(String) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setExpressions(Collection<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Sets the regular expressions which will be used to locate text to markup.
setFilenamePrefix(String) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setFirstPage(boolean) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setFolder(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setFreezePanes(boolean) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets whether "freeze panes" will be applied to this sheet.
setFromCase(Case) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Convenience method for setting various values of a Nuix case:

{case_name} - The name assigned to the case, as obtained by calling Case.getName
{case_guid} - The GUID assigned to the case, as obtained by calling Case.getGuid
{investigator} - The investigator associated to the case, as obtained by calling Case.getInvestigator
setFromItem(Item) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Automatically sets various place holders based on the provided item.
setFuzzyResolutionAlgorithm(SimilarityCalculation) - Method in class com.nuix.superutilities.misc.TermExpander: Sets which method this instance will use to resolve fuzzy terms.
setGuidRefInsertBatchSize(int) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setHeadersOnFirstChunkOnly(boolean) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setHeight(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setHost(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
setId(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setImagingOptions(Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Sets the Map of settings which will be passed to BatchExporter.setImagingOptions(Map) when performing the temporary export before restructuring.
setIncludeChildGuids(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether child GUIDs should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
setIncludeCustomMetadata(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether item custom metadata will be included in generated JSON
setIncludeItemText(boolean) - Method in class com.nuix.superutilities.misc.ProfileDigester: Sets whether this instance should include the item's content text when calculating a digest.
setIncludeParentGuid(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether parent GUID should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
setIncludePathGuids(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether path GUIDs should be serialized when calling JsonExporter.mapItem(Item), {JsonExporter.exportItemAsJson(Item, File) or {JsonExporter.convertItemToJsonString(Item).
setIncludeProperties(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether item metadata properties will be included in generated JSON
setIncludeTags(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether items' tags will be included in generated JSON
setIncludeText(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether item content text will be included in generated JSON
setIntegerInfo(String, Long) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setIntervalMinutes(long) - Method in class com.nuix.superutilities.misc.PeriodicGatedConsumer: Convenience method for setting millis interval to a certain number of minutes
setIntervalSeconds(long) - Method in class com.nuix.superutilities.misc.PeriodicGatedConsumer: Convenience method for setting millis interval to a certain number of seconds
setItem(Item) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setLabel(String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator: Sets the label associated to this instance
setMajor(int) - Method in class com.nuix.superutilities.misc.NuixVersion: Sets the major portion of this version instance (X.0.0.0)
setMarkupSetName(String) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Sets the name of the markup set to which markup will be recorded against.
setMatchedTerm(String) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
setMatches(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
setMatchNamedEntityValues(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setMaxToStringLength(int) - Static method in class com.nuix.superutilities.regex.RegexScanner: Configures the character count threshold in which the CharSequence TextObject of an item, obtained from the API, is first converted to a String object before being scanned for regular expression matches.
setMinor(int) - Method in class com.nuix.superutilities.misc.NuixVersion: Sets the minor portion of this version instance (0.X.0.0)
setMultiline(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setName(String) - Method in class com.nuix.superutilities.misc.NamedStringList
setName(String) - Method in class com.nuix.superutilities.reporting.NamedQuery: Sets the associated name
setNamedEntityTypes(Collection<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Sets the list of named entity type to be redacted.
setNamedEntityTypes(Collection<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
setOcurrences(long) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
setOnlyRecordChanges(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets value determining whether only values that have a redaction performed should be recorded
setOriginalTerm(String) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
setPageNumber(int) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setPages(int) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setPath(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setPath(String, String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Similar to the PlaceholderResolver.set(java.lang.String, java.lang.String) method except this has logic to appropriately handle file paths.
setPatterns(List<PatternInfo>) - Method in class com.nuix.superutilities.regex.RegexScanner
setPrettyPrint(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether JSON will be "pretty printed".
setProduct(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
setProfile(MetadataProfile) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
setProfile(MetadataProfile) - Method in class com.nuix.superutilities.misc.ProfileDigester: Sets the metadata profile used to obtain the values provided to the hash computation.
setPropertiesToScan(List<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
setQuery(String) - Method in class com.nuix.superutilities.reporting.NamedQuery: Sets the associated query
setReaction(CaseIssueReaction) - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Sets the reaction that should be taken to this case being locked
setReaction(CaseIssueReaction) - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Sets the reaction that should be taken
setReaction(CaseIssueReaction) - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Sets the reaction that should be taken Note that a value of CaseIssueReaction.Retry makes not sense in this context and should be considered invalid.
setRecordDigest(boolean) - Method in class com.nuix.superutilities.misc.ProfileDigester: Sets whether this instance will record the digest used.
setRecords(List<OptRecord>) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
setRecordTimeOfRedaction(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets whether a custom metadata field will be written to updated items with a time stamp of when the redaction was performed.
setRedactContentText(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets value determining whether items' content text should be processed
setRedactionReplacementTemplate(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets the template string used to generate replacement text put in place of a redaction in the text.
setRedactProperties(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets value determining whether metadata properties should be processed
setRegenerateStored(boolean) - Method in class com.nuix.superutilities.export.PdfWorkCache
setRowCategoryLabel(String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the overall row category label.
setRowCriteria(List<NamedQuery>) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the list of criteria used for each row.
setScanContent(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setScanCustomMetadata(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setScanProperties(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
setScopeQuery(String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the current scope query which scopes the overall item set reported on.
setSerializeNulls(boolean) - Method in class com.nuix.superutilities.export.JsonExporter: Sets whether entries with null value are included in the generated JSON
setSimilarity(Double) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
setSnapshotFirstSync(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Sets whether a more succinct snapshot should be created in a new database.
setSpecificProperties(Collection<String>) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets list of specific metadata property names to be scanned.
setStampingOptions(Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter: Sets the Map of settings which will be passed to BatchExporter.setStampingOptions(Map) when performing the temporary export before restructuring.
setStandardValues(DateTime) - Method in class com.nuix.superutilities.misc.PlaceholderResolver: Convenience method for setting various standard values:

{date_short} - The datetime of invocation, formatted YYYYMMDD
{date_long} - The datetime of invocation, formatted YYYYMMdd-HHmmss
{date_year} - The datetime of invocation, as 4 digit year
{date_month} - The datetime of invocation, as 2 digit month
{date_day} - The datetime of invocation, as 2 digit day of the month
{nuix_version} - The Nuix version as defined in NUIX_VERSION
setStyle(int, int, Style) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Sets the style of of a particular cell in this work sheet
setSyncCustodianEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setSyncCustomMetadataEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setSyncExclusionEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setSyncItemSetEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setSyncPoint(DateTime) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setSyncPointFromDestinationCaseLastEvent(Case) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setSyncPointToNow() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setSyncProductionSetEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setSyncTagEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
setTargetSimilarity(float) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
setTempDirectory(File) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
setTempDirectory(String) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
setTerm(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
setText(String) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setTextInfo(String, String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
setTimeOfRedactionFieldName(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings: Sets the name of the custom metadata field used to record redaction time stamp when NamedEntityRedactionSettings.getRecordTimeOfRedaction() returns true.
setTotal(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
setUseExistingValueWhenPresent(boolean) - Method in class com.nuix.superutilities.misc.ProfileDigester: Sets whether an existing value in the specified custom metadata field should be used if present.
setUser(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
setUseSIUnits(boolean) - Static method in class com.nuix.superutilities.misc.FormatUtility: Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
setValue(int, int, Object) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet: Sets the value of a particular cell in this work sheet
setValueGenerators(List<ColumnValueGenerator>) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration: Sets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
setVolume(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
setWidth(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setX(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
setY(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
shutdownMonitoring() - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Signals to polling thread that it should wind down and stop polling the monitored locations.
signalAbort() - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Signals that no further processing should be performed after current case.
SimilarityCalculation - Enum in com.nuix.superutilities.misc: Used by TermExpander to determine how fuzzy similarity should be calculated to expand a given fuzzy term into matched terms.
SimpleTextFileReader - Class in com.nuix.superutilities.loadfiles
SimpleTextFileReader() - Constructor for class com.nuix.superutilities.loadfiles.SimpleTextFileReader
SimpleTextFileWriter - Class in com.nuix.superutilities.loadfiles
SimpleTextFileWriter(File) - Constructor for class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
SimpleWorksheet - Class in com.nuix.superutilities.reporting: Wrapper class around Aspose Cells Worksheet object which simplifies some of the more common operations.
SimpleXlsx - Class in com.nuix.superutilities.reporting
SimpleXlsx(File) - Constructor for class com.nuix.superutilities.reporting.SimpleXlsx
SimpleXlsx(String) - Constructor for class com.nuix.superutilities.reporting.SimpleXlsx
size() - Method in class com.nuix.superutilities.misc.DigestList: Gets the count of digests present in this instance.
size() - Method in class com.nuix.superutilities.misc.NamedStringList
skipCase() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo: Notifies BulkCaseProcessor that this case should be skipped in response
skipCase() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent: Notifies BulkCaseProcessor that this case should be skipped in response
skipCase() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Notifies BulkCaseProcessor that this case should be skipped in response
SkipCase - com.nuix.superutilities.cases.CaseIssueReaction
sort(Comparator<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
splitAndMaintainFamilies(Collection<Item>, int, Consumer<Collection<Item>>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Splits a collection of items into a target chunk size, while maintaining families.
spliterator() - Method in class com.nuix.superutilities.misc.NamedStringList
splitLine(String) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
splitPhrase(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Splits a string into tokens on whitespace using the regular expression: \s+
SQLiteBacked - Class in com.nuix.superutilities.misc: Provides a wrapper around a SQLite database.
SQLiteBacked(File) - Constructor for class com.nuix.superutilities.misc.SQLiteBacked
stage - Variable in class com.nuix.superutilities.misc.ProgressInfo: A title representing the current stage, may be null or blank if progress publisher does not populate it!
storeAllMarkupSets(Case) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Stores all markup sets found in the provided case to the SQLite DB file.
storeAllTags(Case) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Stores all tags present in the provided case as records in the DB file.
storeMarkupSet(Case, MarkupSet) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Stores a particular markup set present in the provided Nuix case.
storeTag(Case, String) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Stores a specific tag present in the provided case as records in the DB file.
stream() - Method in class com.nuix.superutilities.misc.NamedStringList
stringCategory - Static variable in class com.nuix.superutilities.export.JsonExporter
subList(int, int) - Method in class com.nuix.superutilities.misc.NamedStringList
SuperItemUtility - Class in com.nuix.superutilities.items: Offers methods for working with items and item collections in the same spirit of the ItemUtility offered in the Nuix API.
SuperItemUtility() - Constructor for class com.nuix.superutilities.items.SuperItemUtility
SuperUtilities - Class in com.nuix.superutilities: Serves as the entry point to most of the functionality.
SuperUtilities() - Constructor for class com.nuix.superutilities.SuperUtilities
syncHistory(Case, AnnotationSyncSettings) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository: Records annotation event data to the database file.

T

TagEvent - Class in com.nuix.superutilities.annotations
TagEvent() - Constructor for class com.nuix.superutilities.annotations.TagEvent
tallyContentTextUdpated() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Adds 1 to count of items which had their content text redacted, as obtained by calling NamedEntityRedactionResults.getContentTextUpdatedCount().
tallyUpdatedItem() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Adds 1 to updated item count, as obtained by calling NamedEntityRedactionResults.getUpdatedItemCount().
tallyUpdatedProperty(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Records that a particular property was recorded and adds 1 to count of times that property was updated.
TemplateExporter - Class in com.nuix.superutilities.export: Experimental class attempting to integrate Ruby ERB templates with Java by using JRuby to compile a Ruby method which is capable of rendering an ERB and injecting it with Java data.
TemplateExporter(File) - Constructor for class com.nuix.superutilities.export.TemplateExporter
TermExpander - Class in com.nuix.superutilities.misc
TermExpander() - Constructor for class com.nuix.superutilities.misc.TermExpander
termToRegex(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings: Converts a plain text term to a regular expression which is case insensitive.
tintChannel(int, float) - Static method in class com.nuix.superutilities.reporting.AsposeCellsColorHelper: Tints a particular color channel value by a certain degree.
toArray() - Method in class com.nuix.superutilities.misc.NamedStringList
toArray(T[]) - Method in class com.nuix.superutilities.misc.NamedStringList
toFile(File) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
toHeaderLine(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
toHeaderLine(List<String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
tokenizeText(String) - Static method in class com.nuix.superutilities.misc.FormatUtility: Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.
toLine() - Method in class com.nuix.superutilities.loadfiles.OptRecord
toLine(String[]) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
toLine(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
toString() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary
toString() - Method in class com.nuix.superutilities.annotations.CustodianEvent
toString() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
toString() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
toString() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
toString() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
toString() - Method in class com.nuix.superutilities.annotations.ProductionSetEvent
toString() - Method in class com.nuix.superutilities.annotations.TagEvent
toString() - Method in class com.nuix.superutilities.cases.CaseInfo: Creates a user friendly String "dump" of information contained in this CaseInfo instance.
toString() - Method in class com.nuix.superutilities.cases.CaseLockInfo
toString() - Method in class com.nuix.superutilities.misc.BoundedProgressInfo
toString() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
toString() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
toString() - Method in class com.nuix.superutilities.misc.NuixVersion: Converts this instance back to a version string from its components, such as: "7.8.0.10"
toString() - Method in class com.nuix.superutilities.misc.ProgressInfo
toString() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults: Generates a string with a handy summary of the results represented by this instance.
transpose(File, File, Consumer<OptRecord>) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
transpose(File, File, Consumer<LinkedHashMap<String, String>>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile

U

unionMany(List<Collection<Item>>) - Method in class com.nuix.superutilities.items.SuperItemUtility: Unions multiple collections of items into a single Set of items.

V

valueOf(String) - Static method in enum com.nuix.superutilities.annotations.AnnotationMatchingMethod: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.nuix.superutilities.cases.CaseIssueReaction: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.nuix.superutilities.misc.SimilarityCalculation: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.nuix.superutilities.annotations.AnnotationMatchingMethod: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.nuix.superutilities.cases.CaseIssueReaction: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.nuix.superutilities.misc.SimilarityCalculation: Returns an array containing the constants of this enum type, in the order they are declared.

W

waterMarkPrintedImages(File, Collection<Item>, String, int, float, float, BiConsumer<Integer, Integer>) - Static method in class com.nuix.superutilities.misc.PdfUtility: This method applies water marks to printed images of items.
waterMarkPrintedImages(String, Collection<Item>, String, int, float, float, BiConsumer<Integer, Integer>) - Static method in class com.nuix.superutilities.misc.PdfUtility: This method applies water marks to printed images of items.
whenErrorLogged(BiConsumer<String, Item>) - Method in class com.nuix.superutilities.misc.ProfileDigester: Invoked when an error occurs in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
whenErrorOccurs(FreeSpaceMonitorEventCallback) - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Allows you to register a call which will be invoked when a monitoring error occurs.
whenErrorOccurs(Consumer<RegexScanError>) - Method in class com.nuix.superutilities.regex.RegexScanner: Allows you to provide a callback which will be invoked when an error occurs during scanning.
whenFreeSpaceBelowThreshold(FreeSpaceMonitorEventCallback) - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Allows you to register a callback which will be invoked when a monitored location is found to dip below the free space threshold.
whenFreeSpaceIssueResolved(FreeSpaceMonitorEventCallback) - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor: Allows you to register a callback which will be invoked when a monitored location which previously was below a free space threshold is no longer below that threshold.
whenMessageGenerated(Consumer<String>) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Registers callback for when this instance logs a message.
whenMessageGenerated(Consumer<String>) - Method in class com.nuix.superutilities.reporting.IntersectionReport
whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Allows you to provide a callback which will be invoked when this instance emits a log message.
whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactor: Allows you to provide a callback which will be invoked when this instance emits a log message.
whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.export.CustomExporter
whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.misc.ProfileDigester: Invoked when a message is logged by ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
whenProgressEventOccurs(Consumer<BoundedProgressInfo>) - Method in class com.nuix.superutilities.export.CustomExporter: Provides a callback to be invoked when progress is made during initial batch export or during restructuring phase.
whenProgressUpdated(NamedEntityRedactionProgressCallback) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility: Registers callback for when this instance signals it has made progress.
whenProgressUpdated(IntersectionReportProgressCallback) - Method in class com.nuix.superutilities.reporting.IntersectionReport
whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.annotations.AnnotationRepository: Allows you to provide a callback which will be invoked when this instance emits a progress update.
whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.misc.ProfileDigester: Invoked when progress is updated in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.misc.TermExpander: Allows you to provide a callback which will be invoked when TermExpander.expandTerm(Case, boolean, boolean, String, String) (or similar overloads) make progress resolving a given term to matched terms.
whenProgressUpdated(Consumer<BulkRedactorProgressInfo>) - Method in class com.nuix.superutilities.annotations.BulkRedactor: Allows you to provide a callback which will be invoked when this instance emits a progress update.
whenProgressUpdated(Consumer<Integer>) - Method in class com.nuix.superutilities.regex.RegexScanner: Allows you to provide a callback which will be invoked when progress updates occur.
withCase(boolean, Consumer<Case>) - Method in class com.nuix.superutilities.cases.CaseInfo: Opens case and passes it to specified callback.
withCase(Consumer<Case>) - Method in class com.nuix.superutilities.cases.CaseInfo: Opens case and passes it to specified callback.
withEachCase(CaseConsumer) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Begins iterating provided list of cases, passing the following information for each case to the provided callback:
- The case object
- Information about the case
- Current index of the case provided
- Total number of cases to be iterated
withEachCase(Case, CaseConsumer) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor: Begins iterating provided list of cases, passing the following information for each case to the provided callback:
- The case object
- Information about the case
- Current index of the case provided
- Total number of cases to be iterated
This method differs from BulkCaseProcessor.withEachCase(CaseConsumer) in that you provide the currently open case in the GUI (in Ruby this would usually be $current_case).
withEachLine(File, Consumer<String>) - Static method in class com.nuix.superutilities.loadfiles.SimpleTextFileReader
withEachRecord(File, Consumer<LinkedHashMap<String, String>>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFileReader
WorkFunctionErrorEvent - Class in com.nuix.superutilities.cases: This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while executing code provided in user code.
WorkFunctionErrorEvent(CaseInfo, Exception) - Constructor for class com.nuix.superutilities.cases.WorkFunctionErrorEvent: Creates a new instance
writeDatLine(String[]) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
writeLine(String) - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
writeRecordKeys(LinkedHashMap<String, String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
writeRecordValues(LinkedHashMap<String, String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
writeValues(List<String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter

Y

yearMonthRangeQuery(int, int) - Static method in class com.nuix.superutilities.query.QueryHelper: Builds an item-date range query for items with a date occurring within the specified year and month.
yearRangeQuery(int) - Static method in class com.nuix.superutilities.query.QueryHelper: Builds an item-date Nuix range query for items with a date occurring within the specified year.
yesNoBooleanParser - Static variable in class com.nuix.superutilities.misc.PrimitiveTypeParser

Z

ZipHelper - Class in com.nuix.superutilities.misc
ZipHelper() - Constructor for class com.nuix.superutilities.misc.ZipHelper

A B C D E F G H I J L M N O P Q R S T U V W Y Z
All Classes All Packages