Package com.nuix.superutilities

Class SuperUtilities

java.lang.Object

com.nuix.superutilities.SuperUtilities

public class SuperUtilities
extends java.lang.Object

Serves as the entry point to most of the functionality. Follows API Utilities class to some degree, single object with methods to obtain the various other objects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SuperUtilities()

Method Summary

Modifier and Type	Method	Description
BulkCaseProcessor	createBulkCaseProcessor()	Creates a new instance of BulkCaseProcessor.
CaseHistoryHelper	createCaseHistoryHelper(nuix.Case nuixCase, java.util.List<java.lang.String> eventTypes, org.joda.time.DateTime minStart, org.joda.time.DateTime maxStart)	Creates a new instance of CaseHistoryHelper.
FreeSpaceMonitor	createFreeSpaceMonitor()	Creates a new instance of FreeSpaceMonitor.
JsonExporter	createJsonExporter()	Creates a new instance of JsonExporter
RegexScanner	createRegexScanner()	Creates a new instance of RegexScanner
TemplateExporter	createTemplateExporter(java.io.File erbTemplateFile)	Creates a new instance of TemplateExporter with a template based on the specified file.
TemplateExporter	createTemplateExporter(java.lang.String erbTemplateFile)	Creates a new instance of TemplateExporter with a template based on the specified file.
static nuix.BulkAnnotater	getBulkAnnotater()	Convenience method to obtain Nuix BulkAnnotater
CaseUtility	getCaseUtility()	Gets singleton of CaseUtility
static NuixVersion	getCurrentVersion()	Gets NuixVersion object representing version of Nuix passed into init(Utilities, String)
FormatUtility	getFormatUtility()	Gets singleton of FormatUtility
static SuperUtilities	getInstance()	Obtains singleton of this class.
static nuix.ItemUtility	getItemUtility()	Convenience method to obtain Nuix ItemUtility
java.io.File	getJarDirectory()	Get file path of directory in which SuperUtilities.jar resides
java.lang.String	getJarDirectoryPath()	Get file path of directory in which SuperUtilities.jar resides
java.io.File	getJarFile()	Get file path of SuperUtilities.jar
java.lang.String	getJarFilePath()	Get file path of SuperUtilities.jar
nuix.Utilities	getNuixUtilities()	Gets the underlying regular API utilities object
SuperItemUtility	getSuperItemUtility()	Gets singleton of SuperItemUtility
static SuperUtilities	init(nuix.Utilities util, java.lang.String nuixVersionString)	Initializes this class.
void	saveDiagnostics(java.io.File zipFile)	Saves a diagnostics zip file (similar to same operation in the workbench GUI)
void	saveDiagnostics(java.lang.String zipFile)	Saves a diagnostics zip file (similar to same operation in the GUI)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperUtilities

protected SuperUtilities()

Method Detail

getInstance

public static SuperUtilities getInstance()

Obtains singleton of this class.

Returns:

Singleton of this class

init

public static SuperUtilities init(nuix.Utilities util,
                                  java.lang.String nuixVersionString)

Initializes this class.

Parameters:

util - Instance of regular API utilities class, in Ruby this would be $utilities

nuixVersionString - Nuix version string, in Ruby this would be NUIX_VERSION

Returns:

Initialized singleton of this class

getNuixUtilities

public nuix.Utilities getNuixUtilities()

Gets the underlying regular API utilities object

Returns:

The result Nuix API Utilities object

getCaseUtility

public CaseUtility getCaseUtility()

Gets singleton of CaseUtility

Returns:

singleton of CaseUtility

getSuperItemUtility

public SuperItemUtility getSuperItemUtility()

Gets singleton of SuperItemUtility

Returns:

singleton of SuperItemUtility

getFormatUtility

public FormatUtility getFormatUtility()

Gets singleton of FormatUtility

Returns:

singleton of FormatUtility

createRegexScanner

public RegexScanner createRegexScanner()

Creates a new instance of RegexScanner

Returns:

a new instance of RegexScanner

createJsonExporter

public JsonExporter createJsonExporter()

Creates a new instance of JsonExporter

Returns:

a new instance of JsonExporter

createTemplateExporter

public TemplateExporter createTemplateExporter(java.io.File erbTemplateFile)
                                        throws java.lang.Exception

Creates a new instance of TemplateExporter with a template based on the specified file.

Parameters:

erbTemplateFile - File containing Ruby ERB template

Returns:

a new instance of TemplateExporter

Throws:

java.lang.Exception - if there is an error

createTemplateExporter

public TemplateExporter createTemplateExporter(java.lang.String erbTemplateFile)
                                        throws java.lang.Exception

Creates a new instance of TemplateExporter with a template based on the specified file.

Parameters:

erbTemplateFile - File containing Ruby ERB template

Returns:

a new instance of TemplateExporter

Throws:

java.lang.Exception - if there is an error

getCurrentVersion

public static NuixVersion getCurrentVersion()

Gets NuixVersion object representing version of Nuix passed into init(Utilities, String)

Returns:

object representing current version of Nuix

getJarFilePath

public java.lang.String getJarFilePath()

Get file path of SuperUtilities.jar

Returns:

String representing path to JAR file

getJarFile

public java.io.File getJarFile()

Get file path of SuperUtilities.jar

Returns:

File object representing path to JAR file

getJarDirectory

public java.io.File getJarDirectory()

Get file path of directory in which SuperUtilities.jar resides

Returns:

File object representing path to directory in which JAR resides

getJarDirectoryPath

public java.lang.String getJarDirectoryPath()

Get file path of directory in which SuperUtilities.jar resides

Returns:

String representing path to directory in which JAR resides

createBulkCaseProcessor

public BulkCaseProcessor createBulkCaseProcessor()

Creates a new instance of BulkCaseProcessor.

Returns:

a new instance of BulkCaseProcessor

saveDiagnostics

public void saveDiagnostics(java.io.File zipFile)

Saves a diagnostics zip file (similar to same operation in the workbench GUI)

Parameters:

zipFile - File object specifying where the zip file should be saved to.

createFreeSpaceMonitor

public FreeSpaceMonitor createFreeSpaceMonitor()

Creates a new instance of FreeSpaceMonitor.

Returns:

a new instance of FreeSpaceMonitor

saveDiagnostics

public void saveDiagnostics(java.lang.String zipFile)

Saves a diagnostics zip file (similar to same operation in the GUI)

Parameters:

zipFile - String specifying where the zip file should be saved to.

createCaseHistoryHelper

public CaseHistoryHelper createCaseHistoryHelper(nuix.Case nuixCase,
                                                 java.util.List<java.lang.String> eventTypes,
                                                 org.joda.time.DateTime minStart,
                                                 org.joda.time.DateTime maxStart)
                                          throws java.lang.Exception

Creates a new instance of CaseHistoryHelper.

Parameters:

nuixCase - Nuix case to get history from

eventTypes - List of Nuix event type names

minStart - Earliest event start date time to return

maxStart - Latest event start date time to return

Returns:

a new instance of CaseHistoryHelper

Throws:

java.lang.Exception - when there is an error

See Also:

HistoryEvent.getTypeString

getBulkAnnotater

public static nuix.BulkAnnotater getBulkAnnotater()

Convenience method to obtain Nuix BulkAnnotater

Returns:

Nuix BulkAnnotater obtained from Utilities object

getItemUtility

public static nuix.ItemUtility getItemUtility()

Convenience method to obtain Nuix ItemUtility

Returns:

Nuix ItemUtility obtained from Utilities object