diff --git a/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationRepository.java b/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationRepository.java index 0886f25..f16244a 100644 --- a/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationRepository.java +++ b/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationRepository.java @@ -346,7 +346,6 @@ public void storeAllTags(Case nuixCase) throws IOException, SQLException { * @param nuixCase The case in which items will be tagged. * @param matchingMethod Determines how a record in the DB file is associated to an item in the case to apply tags to it. * @throws SQLException Thrown if there are errors while interacting with the SQLite DB file. - * @throws Thrown by Nuix if there is something */ public void applyTagsFromDatabaseToCase(Case nuixCase, AnnotationMatchingMethod matchingMethod) throws SQLException { // Will reuse this multiple times to provide values to be bound to prepared SQL statements later diff --git a/Java/src/main/java/com/nuix/superutilities/annotations/BulkRedactorSettings.java b/Java/src/main/java/com/nuix/superutilities/annotations/BulkRedactorSettings.java index 1282976..da91ddf 100644 --- a/Java/src/main/java/com/nuix/superutilities/annotations/BulkRedactorSettings.java +++ b/Java/src/main/java/com/nuix/superutilities/annotations/BulkRedactorSettings.java @@ -14,7 +14,7 @@ import nuix.MarkupSet; /*** - * Provides settings regarding bulk redaction performed by {@link BulkRedactor#findAndMarkup(Case, BulkRedactorSettings, Collection)}. + * Provides settings regarding bulk redaction performed by {@link BulkRedactor#findAndMarkup(Case, BulkRedactorSettings, Collection, int)}. * @author Jason Wells * */ diff --git a/Java/src/main/java/com/nuix/superutilities/export/TemplateExporter.java b/Java/src/main/java/com/nuix/superutilities/export/TemplateExporter.java index 9adafe8..a85d513 100644 --- a/Java/src/main/java/com/nuix/superutilities/export/TemplateExporter.java +++ b/Java/src/main/java/com/nuix/superutilities/export/TemplateExporter.java @@ -63,7 +63,7 @@ public String render(Item item, Map data){ return (String) container.callMethod("", "render", new Object[]{item,toSend}); } - public void renderToFile(Item item, File outputFile, Map data) throws Exception{ + public void renderToFile(Item item, File outputFile, Map data) throws Exception { FileOutputStream fos = null; BufferedWriter bw = null; diff --git a/Java/src/main/java/com/nuix/superutilities/items/SuperItemUtility.java b/Java/src/main/java/com/nuix/superutilities/items/SuperItemUtility.java index 0ab8c10..3bf05a9 100644 --- a/Java/src/main/java/com/nuix/superutilities/items/SuperItemUtility.java +++ b/Java/src/main/java/com/nuix/superutilities/items/SuperItemUtility.java @@ -5,6 +5,7 @@ import java.net.URLDecoder; import java.util.ArrayList; import java.util.Collection; +import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.List; @@ -267,4 +268,36 @@ public boolean itemsAreSiblings(Item a, Item b){ return true; } + + /*** + * Gets items and sibling items within a certain ordinal distance. + * @param items The items to obtain the neighboring siblings of + * @param itemsBefore How many siblings before each item to include + * @param itemsAfter How many siblings after each item to include + * @return A new list of items which includes both input items and neighboring siblings, sorted by position + */ + public List getItemsAndNeighboringSiblings(List items, int itemsBefore, int itemsAfter){ + if(itemsBefore < 0) { itemsBefore = 0; } + if(itemsAfter < 0) { itemsAfter = 0; } + + if(items.size() < 1) { return Collections.emptyList(); } + else { + Set tempSet = new HashSet(); + for(Item item : items) { + Item parent = item.getParent(); + List siblings = parent.getChildren(); + int itemIndex = siblings.indexOf(item); + int first = itemIndex - itemsBefore; + int last = itemIndex + itemsAfter; + if(first < 0) { first = 0; } + if(last > items.size() - 1) { last = items.size() - 1; } + for (int i = first; i <= last; i++) { + tempSet.add(items.get(i)); + } + } + List result = new ArrayList(); + result.addAll(tempSet); + return SuperUtilities.getItemUtility().sortItemsByPosition(result); + } + } } diff --git a/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java b/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java index db6fd63..ddc2576 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java +++ b/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java @@ -329,7 +329,7 @@ public void setDigestCustomField(String digestCustomField) { /*** * Gets whether an existing value in the specified custom metadata field should be used if present. When true, - * if an item has the custom field specified by callin {@link #setDigestCustomField(String)) and it has a value, that value will + * if an item has the custom field specified by calling {@link #setDigestCustomField(String)} and it has a value, that value will * be used rather than calculating a value. If false the value will always be calculated fresh. * @return Whether an existing value in the specified custom metadata field should be used when present */ @@ -339,9 +339,9 @@ public boolean getUseExistingValueWhenPresent() { /*** * Sets whether an existing value in the specified custom metadata field should be used if present. When true, - * if an item has the custom field specified by calling {@link #setDigestCustomField(String)) and it has a value, that value will + * if an item has the custom field specified by calling {@link #setDigestCustomField(String)} and it has a value, that value will * be used rather than calculating a value. If false the value will always be calculated fresh. - * @param useExistingValueWhenPresent + * @param useExistingValueWhenPresent whether an existing value in the specified custom metadata field should be used if present */ public void setUseExistingValueWhenPresent(boolean useExistingValueWhenPresent) { this.useExistingValueWhenPresent = useExistingValueWhenPresent; diff --git a/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java b/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java index bed6fd9..abf89c6 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java +++ b/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java @@ -1,5 +1,7 @@ package com.nuix.superutilities.misc; +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; @@ -8,10 +10,45 @@ import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; +import org.apache.commons.compress.archivers.sevenz.SevenZArchiveEntry; +import org.apache.commons.compress.archivers.sevenz.SevenZMethod; +import org.apache.commons.compress.archivers.sevenz.SevenZOutputFile; import org.apache.commons.io.IOUtils; import org.apache.jena.ext.com.google.common.primitives.Ints; public class ZipHelper { + + public static void compressDirectoryToSevenZipFile(String directory, String sevenZipFile) throws IOException { + SevenZOutputFile sevenZipOutput = new SevenZOutputFile(new File(sevenZipFile)); + sevenZipOutput.setContentCompression(SevenZMethod.DEFLATE); + compressDirectoryToSevenZipFile(directory, directory, sevenZipOutput); + sevenZipOutput.finish(); + sevenZipOutput.close(); + } + + private static void compressDirectoryToSevenZipFile(String rootDir, String sourceDir, SevenZOutputFile sevenZipOutput) throws IOException { + for (File file : new File(sourceDir).listFiles()) { + if (file.isDirectory()) { + compressDirectoryToSevenZipFile(rootDir, sourceDir + File.separator + file.getName(), sevenZipOutput); + } else { + String dir = sourceDir.replace(rootDir, ""); + SevenZArchiveEntry entry = null; + if (!dir.trim().isEmpty()) { + entry = sevenZipOutput.createArchiveEntry(file,dir + File.separator + file.getName()); + } else { + entry = sevenZipOutput.createArchiveEntry(file,file.getName()); + } + sevenZipOutput.putArchiveEntry(entry); + FileInputStream in = new FileInputStream(sourceDir + File.separator + file.getName()); + BufferedInputStream bufferedIn = new BufferedInputStream(in); + sevenZipOutput.write(bufferedIn); + bufferedIn.close(); + in.close(); + sevenZipOutput.closeArchiveEntry(); + } + } + } + /*** * Compresses the contents of the given directory (files and sub-directories) in to a Zip file. * @param directory The directory to archive into the Zip file. @@ -23,8 +60,12 @@ public class ZipHelper { @SuppressWarnings("deprecation") public static void compressDirectoryToZipFile(String directory, String zipFile, int compressionLevel) throws IOException, FileNotFoundException { ZipOutputStream zipStream = null; + FileOutputStream fileOutStream = null; + BufferedOutputStream bufferedOutStream = null; try{ - zipStream = new ZipOutputStream(new FileOutputStream(zipFile)); + fileOutStream = new FileOutputStream(zipFile); + bufferedOutStream = new BufferedOutputStream(fileOutStream); + zipStream = new ZipOutputStream(bufferedOutStream); zipStream.setLevel(Ints.constrainToRange(compressionLevel, 0, 9)); compressDirectoryToZipfile(directory,directory,zipStream); } finally { @@ -57,7 +98,8 @@ private static void compressDirectoryToZipfile(String rootDir, String sourceDir, out.putNextEntry(entry); FileInputStream in = new FileInputStream(sourceDir + File.separator + file.getName()); - IOUtils.copy(in, out); + BufferedInputStream bufferedIn = new BufferedInputStream(in); + IOUtils.copy(bufferedIn, out); IOUtils.closeQuietly(in); } } diff --git a/Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java b/Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java index aff4cb0..550dfc0 100644 --- a/Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java +++ b/Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java @@ -25,6 +25,8 @@ public PatternInfo(String title, String expression){ /*** * Compiles the regular expression String provided into a Java Pattern object * @param caseSensitive Whether it should be case sensitive + * @param multiline Whether the multi-line matching flag should be set + * @param dotAll Whether the dot matches all flag should be set */ public void compile(boolean caseSensitive, boolean multiline, boolean dotAll){ if(pattern == null){ @@ -53,8 +55,8 @@ public String getExpression() { } /*** - * Gets the compiled Pattern object. Note this will return null until {@link #compile(boolean)} is called. - * @return The compiled Pattern object or null if {@link #compile(boolean)} has not yet been called. + * Gets the compiled Pattern object. Note this will return null until {@link #compile(boolean, boolean, boolean)} is called. + * @return The compiled Pattern object or null if {@link #compile(boolean, boolean, boolean)} has not yet been called. */ public Pattern getPattern() { return pattern; diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java b/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java index 81868ae..9359208 100644 --- a/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java +++ b/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java @@ -7,6 +7,7 @@ import java.util.stream.Collectors; import org.apache.log4j.Logger; +import org.joda.time.DateTime; import com.aspose.cells.BackgroundType; import com.aspose.cells.Color; @@ -32,6 +33,40 @@ public class IntersectionReport { private static Logger logger = Logger.getLogger(IntersectionReport.class); + /*** + * 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. + * @param nuixCase The case to analyze + * @param min The minimum date time, can be null + * @param max The maximum date time, can be null + * @return Returns a list of zero or more GUIDs for the batch loads loaded within the given date range + */ + public static List findBatchLoadsInDateRange(Case nuixCase, DateTime min, DateTime max) { + List inRangeBatchLoadGuids = new ArrayList(); + List allBatchLoads = nuixCase.getBatchLoads(); + + // Filter all batch loads by whether their loaded date falls within + // the range specifies by the min/max values + for(BatchLoadDetails bld : allBatchLoads) { + boolean satisfiesMin = true; + boolean satisfiesMax = true; + + if(min != null) { + satisfiesMin = bld.getLoaded().isAfter(min); + } + + if(max != null) { + satisfiesMax = bld.getLoaded().isBefore(max); + } + + if(satisfiesMin && satisfiesMax) { + inRangeBatchLoadGuids.add(bld.getBatchId()); + } + } + + return inRangeBatchLoadGuids; + } + private SimpleXlsx xlsx = null; private Style rowCategoryLabelStyle = null; @@ -163,27 +198,8 @@ public void generate(Case nuixCase, String sheetName, IntersectionReportSheetCon // in the case and filter to those within our date range. Using that filtered set we then get their batch // load GUIDs and use that to attach additional scope query for those batch loads. if(sheetConfig.hasBatchLoadDateCriteria()) { - List inRangeBatchLoadGuids = new ArrayList(); - List allBatchLoads = nuixCase.getBatchLoads(); - - // Filter all batch loads by whether their loaded date falls within - // the range specifies by the min/max values - for(BatchLoadDetails bld : allBatchLoads) { - boolean satisfiesMin = true; - boolean satisfiesMax = true; - - if(sheetConfig.getBatchLoadMinDate() != null) { - satisfiesMin = bld.getLoaded().isAfter(sheetConfig.getBatchLoadMinDate()); - } - - if(sheetConfig.getBatchLoadMaxDate() != null) { - satisfiesMax = bld.getLoaded().isBefore(sheetConfig.getBatchLoadMaxDate()); - } - - if(satisfiesMin && satisfiesMax) { - inRangeBatchLoadGuids.add(bld.getBatchId()); - } - } + List inRangeBatchLoadGuids = findBatchLoadsInDateRange(nuixCase, + sheetConfig.getBatchLoadMinDate(),sheetConfig.getBatchLoadMaxDate()); String batchLoadGuidQuery = ""; if(inRangeBatchLoadGuids.size() > 0) { diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html new file mode 100644 index 0000000..73ff2d8 --- /dev/null +++ b/docs/allclasses-index.html @@ -0,0 +1,545 @@ + + + + + +All Classes + + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassDescription
AnnotationEvent 
AnnotationHistoryRepository +
Class for recording annotation in a source case and replaying on a destination case.
+
AnnotationHistoryRepositorySummary 
AnnotationMatchingMethod 
AnnotationRepository +
This class leverages a SQLite database file to export and import annotations between Nuix cases.
+
AnnotationSyncSettings 
AsposeCellsColorHelper +
A class containing helper methods for working with Aspose Cells colors.
+
AsposeCellsStyleHelper +
A class containing helper methods for working with Aspose Cells Styles.
+
BulkCaseProcessor +
This class assists with iteratively doing some form of work in multiple cases.
+
BulkRedactor +
Provides bulk redaction functionality, as found in the GUI, but (as of Nuix 7.8.0.10) is not present in the Nuix API.
+
BulkRedactorProgressInfo 
BulkRedactorSettings +
Provides settings regarding bulk redaction performed by BulkRedactor.findAndMarkup(Case, BulkRedactorSettings, Collection, int).
+
CaseConsumer +
Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
+
CaseHistoryHelper +
Helper class for iterating a case's history.
+
CaseInfo +
Represents some information which can be determined about a Nuix case directory without having + yet opened the case through the API.
+
CaseIssueReaction +
Used to respond to issues opening a case by BulkCaseProcessor.
+
CaseLockedEventInfo +
This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was + locked.
+
CaseLockInfo +
Represents information parsed from a case lock file.
+
CaseOpenErrorEvent +
This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had + and error when opened.
+
CaseUtility +
Class which provides some additional functionality regarding Nuix cases, mainly finding cases + present in directories and their sub directories.
+
ChunkedDATExporter +
Generates a series of DAT loadfiles, based on a metadata profile.
+
ColorRing +
Iterator over a collection of Aspose Cells Color objects.
+
ColumnValueGenerator +
Base class for reporting.
+
CustodianEvent 
CustomExporter +
Provides customized exports while still leveraging the performance of BatchExporter.
+
CustomMetadataEvent 
DatLoadFile 
DatLoadFileReader 
DatLoadFileWriter 
DigestList +
This class provides an in-memory representation of a Nuix binary digest list.
+
DriveSpaceInfo +
Encapsulates drive space information to callback responding to events fired + by FreeSpaceMonitor.
+
ExclusionEvent 
ExpandedTermInfo +
Encapsulates information about a term designated as a match result generated by TermExpander.
+
FormatUtility +
Class which offers methods for formatting values.
+
FreeSpaceMonitor +
Provides a way to monitor file system locations and act when available disk space drops + below a specified threshold.
+
FreeSpaceMonitorEventCallback +
Interface for callback for free space monitoring offered by FreeSpaceMonitor.
+
FuzzyTermInfo +
Encapsulates information about a fuzzy term expression.
+
IntersectionReport +
This class generates an "intersection report".
+
IntersectionReportProgressCallback 
IntersectionReportSheetConfiguration 
ItemRegexMatchCollection +
Represents an item and the associated regular expression matches made against it.
+
ItemSetEvent 
JsonExporter 
LevenshteinDistance 
NamedEntityRedactionProgressCallback +
Provides progress status callback functionality for NamedEntityUtility.
+
NamedEntityRedactionResults 
NamedEntityRedactionSettings +
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).
+
NamedEntityUtility +
Provides functionality for working with Nuix named entities.
+
NamedQuery +
Encapsulates a Nuix query string and an associated name.
+
NamedStringList 
NuixImageAnnotationRegion 
NuixVersion +
Assists in representing a Nuix version in object form to assist with comparing two versions.
+
OptLoadFile 
OptRecord 
PatternInfo +
Represents a regular expression including associated title.
+
PdfUtility +
A class containing some helper methods for PDFs.
+
PdfWorkCache +
This class provides access to PDFs as files when you need them on the file system to perform some operation.
+
PlaceholderResolver +
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.
+
ProductionSetEvent 
ProfileDigester +
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.
+
QueryHelper 
RegexMatch +
Represents information about a regular expression match.
+
RegexScanError +
Represents information about an error which occurred in RegexScanner while scanning.
+
RegexScanner +
Class for scanning a series of items with a series of regular expressions.
+
ScriptedColumnValueGenerator +
A ColumnValueGenerator which uses the provided BiFunction expression to calculate its value.
+
SimilarityCalculation +
Used by TermExpander to determine how fuzzy similarity should be + calculated to expand a given fuzzy term into matched terms.
+
SimpleTextFileReader 
SimpleTextFileWriter 
SimpleWorksheet +
Wrapper class around Aspose Cells Worksheet object which simplifies some of the + more common operations.
+
SimpleXlsx 
SQLiteBacked +
Provides a wrapper around a SQLite database.
+
SuperItemUtility +
Offers methods for working with items and item collections in the same spirit of the + ItemUtility offered in the Nuix API.
+
SuperUtilities +
Serves as the entry point to most of the functionality.
+
TagEvent 
TemplateExporter +
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.
+
TermExpander 
WorkFunctionErrorEvent +
This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while + executing code provided in user code.
+
ZipHelper 
+
+
+
+
+ +
+
+ + diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html new file mode 100644 index 0000000..42ef7c1 --- /dev/null +++ b/docs/allpackages-index.html @@ -0,0 +1,156 @@ + + + + + +All Packages + + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Package Summary 
PackageDescription
com.nuix.superutilities 
com.nuix.superutilities.annotations 
com.nuix.superutilities.cases 
com.nuix.superutilities.export 
com.nuix.superutilities.items 
com.nuix.superutilities.loadfiles 
com.nuix.superutilities.misc 
com.nuix.superutilities.namedentities 
com.nuix.superutilities.query 
com.nuix.superutilities.regex 
com.nuix.superutilities.reporting 
+
+
+
+ +
+
+ + diff --git a/docs/com/nuix/superutilities/SuperUtilities.html b/docs/com/nuix/superutilities/SuperUtilities.html index 19972df..daa98ad 100644 --- a/docs/com/nuix/superutilities/SuperUtilities.html +++ b/docs/com/nuix/superutilities/SuperUtilities.html @@ -1,42 +1,48 @@ - + SuperUtilities + + + + + + + + + - - +var pathtoroot = "../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities
-

Class SuperUtilities

+
Package com.nuix.superutilities
+

Class SuperUtilities

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.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 @@ -116,198 +100,223 @@

    Class SuperUtilities

    Author:
    Jason Wells
    -
    • -
-
-
+ +
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      - - - -
      • -

        init

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

        init

        +
        public static SuperUtilities init​(nuix.Utilities util, +java.lang.String nuixVersionString)
        Initializes this class.
        Parameters:
        @@ -316,268 +325,214 @@

        init

        Returns:
        Initialized singleton of this class
        +
        • -
      - - - -
      • -

        getNuixUtilities

        -
        public nuix.Utilities getNuixUtilities()
        +
        +

        getNuixUtilities

        +
        public nuix.Utilities getNuixUtilities()
        Gets the underlying regular API utilities object
        Returns:
        The result Nuix API Utilities object
        +
        • -
      - - - - - - - - - - - - - - - - - - - - - - - -
      • -

        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.
        +
        +

        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
        +
        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.
        +
        +

        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
        +
        a new instance of TemplateExporter
        Throws:
        java.lang.Exception - if there is an error
        +
        • -
      - - - - - - - -
      • -

        getJarFilePath

        -
        public java.lang.String getJarFilePath()
        +
        +

        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()
        +
        +

        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()
        +
        +

        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()
        +
        +

        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
        +
        • -
      - - - - - - - -
      • -

        saveDiagnostics

        -
        public void saveDiagnostics(java.io.File zipFile)
        +
        +

        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.
        +
        • -
      - - - - - - - -
      • -

        saveDiagnostics

        -
        public void saveDiagnostics(java.lang.String zipFile)
        +
        +

        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.
        +
        +

        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
        @@ -585,45 +540,56 @@

        createCaseHistoryHelper

        minStart - Earliest event start date time to return
        maxStart - Latest event start date time to return
        Returns:
        -
        a new instance of CaseHistoryHelper
        +
        a new instance of CaseHistoryHelper
        Throws:
        java.lang.Exception - when there is an error
        See Also:
        HistoryEvent.getTypeString
        +
        • -
      - - - -
      • -

        getBulkAnnotater

        -
        public static nuix.BulkAnnotater getBulkAnnotater()
        +
        +

        getBulkAnnotater

        +
        public static nuix.BulkAnnotater getBulkAnnotater()
        Convenience method to obtain Nuix BulkAnnotater
        Returns:
        -
        Nuix bulk annotater obtained from Utilities object
        +
        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
      +
      +
    +
-
+
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationEvent.html b/docs/com/nuix/superutilities/annotations/AnnotationEvent.html index 10556da..3cb18e3 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationEvent.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationEvent.html @@ -1,42 +1,48 @@ - + AnnotationEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class AnnotationEvent

+
Package com.nuix.superutilities.annotations
+

Class AnnotationEvent

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.AnnotationEvent
      • -
    -
    • -
-
- -
-
+ +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      AnnotationEvent() AnnotationEvent() 
      +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          AnnotationEvent

          -
          public AnnotationEvent()
          +
          +

          AnnotationEvent

          +
          public AnnotationEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public abstract void replay(nuix.Case nuixCase)
-                     throws java.lang.Exception
        +
        +

        replay

        +
        public abstract void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getAssociatedItems

        -
        public java.util.Collection<nuix.Item> getAssociatedItems(nuix.Case nuixCase)
-                                                   throws java.lang.Exception
        +
        +

        getAssociatedItems

        +
        public java.util.Collection<nuix.Item> getAssociatedItems​(nuix.Case nuixCase) + throws java.lang.Exception
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getTimeStamp

        -
        public org.joda.time.DateTime getTimeStamp()
        +
        +

        getTimeStamp

        +
        public org.joda.time.DateTime getTimeStamp()
        +
        • -
      - - - - - - - -
      • -

        getExpectedItemCount

        -
        public java.lang.Integer getExpectedItemCount()
        -
        • -
      +
      +

      getExpectedItemCount

      +
      public java.lang.Integer getExpectedItemCount()
      +
    +
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html index 344bd6c..77725d7 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html @@ -1,42 +1,48 @@ - + AnnotationHistoryRepository + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class AnnotationHistoryRepository

+
Package com.nuix.superutilities.annotations
+

Class AnnotationHistoryRepository

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.AnnotationHistoryRepository
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    +
    All Implemented Interfaces:
    -
    java.io.Closeable, java.lang.AutoCloseable
    +
    java.io.Closeable, java.lang.AutoCloseable
    -
    public class AnnotationHistoryRepository
 extends java.lang.Object
 implements java.io.Closeable
    @@ -121,282 +105,332 @@

    Class AnnotationHist
    Author:
    Jason Wells
    -

    • -
-
-
+ +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      +

      Constructor Details

      • -

        AnnotationHistoryRepository

        -
        public AnnotationHistoryRepository(java.io.File databaseFile)
-                            throws java.sql.SQLException
        +
        +

        AnnotationHistoryRepository

        +
        public AnnotationHistoryRepository​(java.io.File databaseFile) + throws java.sql.SQLException
        Creates a new instance against the given and database file. If the database file does not already exist it will be created and initialized.
        @@ -405,16 +439,13 @@

        AnnotationHistoryRepository

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        AnnotationHistoryRepository

        -
        public AnnotationHistoryRepository(java.lang.String databaseFile)
-                            throws java.sql.SQLException
        +
        +

        AnnotationHistoryRepository

        +
        public AnnotationHistoryRepository​(java.lang.String databaseFile) + throws java.sql.SQLException
        Creates a new instance against the given and database file. If the database file does not already exist it will be created and initialized.
        @@ -423,125 +454,103 @@

        AnnotationHistoryRepository

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
      +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        getIntegerInfo

        -
        public java.lang.Long getIntegerInfo(java.lang.String name)
-                              throws java.sql.SQLException
        +
        +

        getIntegerInfo

        +
        public java.lang.Long getIntegerInfo​(java.lang.String name) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        setIntegerInfo

        -
        public void setIntegerInfo(java.lang.String name,
-                           java.lang.Long value)
-                    throws java.sql.SQLException
        +
        +

        setIntegerInfo

        +
        public void setIntegerInfo​(java.lang.String name, +java.lang.Long value) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        getTextInfo

        -
        public java.lang.String getTextInfo(java.lang.String name)
-                             throws java.sql.SQLException
        +
        +

        getTextInfo

        +
        public java.lang.String getTextInfo​(java.lang.String name) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        setTextInfo

        -
        public void setTextInfo(java.lang.String name,
-                        java.lang.String value)
-                 throws java.sql.SQLException
        +
        +

        setTextInfo

        +
        public void setTextInfo​(java.lang.String name, +java.lang.String value) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        setSyncPointToNow

        -
        public void setSyncPointToNow()
-                       throws java.sql.SQLException
        +
        +

        setSyncPointToNow

        +
        public void setSyncPointToNow() + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        setSyncPointFromDestinationCaseLastEvent

        -
        public void setSyncPointFromDestinationCaseLastEvent(nuix.Case nuixCase)
-                                              throws java.lang.Exception
        +
        +

        setSyncPointFromDestinationCaseLastEvent

        +
        public void setSyncPointFromDestinationCaseLastEvent​(nuix.Case nuixCase) + throws java.lang.Exception
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        setSyncPoint

        -
        public void setSyncPoint(org.joda.time.DateTime dateTime)
-                  throws java.lang.Exception
        +
        +

        setSyncPoint

        +
        public void setSyncPoint​(org.joda.time.DateTime dateTime) + throws java.lang.Exception
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        executeUpdate

        -
        public int executeUpdate(java.lang.String sql,
-                         java.util.List<java.lang.Object> data)
-                  throws java.sql.SQLException
        +
        +

        executeUpdate

        +
        public int executeUpdate​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
        Executes an update query against the SQLite database file
        Parameters:
        @@ -552,46 +561,37 @@

        executeUpdate

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        executeUpdate

        -
        public int executeUpdate(java.lang.String sql,
-                         java.lang.Object... data)
-                  throws java.sql.SQLException
        +
        +

        executeUpdate

        +
        public int executeUpdate​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeUpdate

        -
        public int executeUpdate(java.lang.String sql)
-                  throws java.sql.SQLException
        +
        +

        executeUpdate

        +
        public int executeUpdate​(java.lang.String sql) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeInsert

        -
        public void executeInsert(java.lang.String sql,
-                          java.util.List<java.lang.Object> data)
-                   throws java.sql.SQLException
        +
        +

        executeInsert

        +
        public void executeInsert​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
        Executes an insert query against the SQLite database file
        Parameters:
        @@ -600,136 +600,109 @@

        executeInsert

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        executeInsert

        -
        public void executeInsert(java.lang.String sql,
-                          java.lang.Object... data)
-                   throws java.sql.SQLException
        +
        +

        executeInsert

        +
        public void executeInsert​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeLongScalar

        -
        public java.lang.Long executeLongScalar(java.lang.String sql,
-                                        java.lang.Object... data)
-                                 throws java.sql.SQLException
        +
        +

        executeLongScalar

        +
        public java.lang.Long executeLongScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeLongScalar

        -
        public java.lang.Long executeLongScalar(java.lang.String sql,
-                                        java.util.List<java.lang.Object> data)
-                                 throws java.sql.SQLException
        +
        +

        executeLongScalar

        +
        public java.lang.Long executeLongScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeLongScalar

        -
        public java.lang.Long executeLongScalar(java.lang.String sql)
-                                 throws java.sql.SQLException
        +
        +

        executeLongScalar

        +
        public java.lang.Long executeLongScalar​(java.lang.String sql) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeStringScalar

        -
        public java.lang.String executeStringScalar(java.lang.String sql,
-                                            java.lang.Object... data)
-                                     throws java.sql.SQLException
        +
        +

        executeStringScalar

        +
        public java.lang.String executeStringScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeStringScalar

        -
        public java.lang.String executeStringScalar(java.lang.String sql,
-                                            java.util.List<java.lang.Object> data)
-                                     throws java.sql.SQLException
        +
        +

        executeStringScalar

        +
        public java.lang.String executeStringScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeStringScalar

        -
        public java.lang.String executeStringScalar(java.lang.String sql)
-                                     throws java.sql.SQLException
        +
        +

        executeStringScalar

        +
        public java.lang.String executeStringScalar​(java.lang.String sql) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeScalar

        -
        public <T> T executeScalar(java.lang.String sql,
-                           java.lang.Object... data)
-                    throws java.sql.SQLException
        +
        +

        executeScalar

        +
        public <T> T executeScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        executeQuery

        -
        public void executeQuery(java.lang.String sql,
-                         java.util.List<java.lang.Object> data,
-                         java.util.function.Consumer<java.sql.ResultSet> resultConsumer)
-                  throws java.sql.SQLException
        +
        +

        executeQuery

        +
        public void executeQuery​(java.lang.String sql, +java.util.List<java.lang.Object> data, +java.util.function.Consumer<java.sql.ResultSet> resultConsumer) + throws java.sql.SQLException
        Executes a query which is expected to return row data, providing the result set to the provided callback.
        Parameters:
        @@ -739,16 +712,13 @@

        executeQuery

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        getTotalEventCount

        -
        public long getTotalEventCount()
-                        throws java.sql.SQLException
        +
        +

        getTotalEventCount

        +
        public long getTotalEventCount() + throws java.sql.SQLException
        Returns the total number of event entries in the database file
        Returns:
        @@ -756,36 +726,30 @@

        getTotalEventCount

        Throws:
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        calculateLastDbEventStart

        -
        public org.joda.time.DateTime calculateLastDbEventStart()
-                                                 throws java.sql.SQLException
        +
        +

        calculateLastDbEventStart

        +
        public org.joda.time.DateTime calculateLastDbEventStart() + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        syncHistory

        -
        public void syncHistory(nuix.Case nuixCase,
-                        AnnotationSyncSettings settings)
-                 throws java.io.IOException,
-                        java.sql.SQLException
        +
        +

        syncHistory

        +
        public void syncHistory​(nuix.Case nuixCase, +AnnotationSyncSettings settings) + throws java.io.IOException, +java.sql.SQLException
        Records annotation event data to the database file. If there are 0 events currently recorded and snap shot on first sync - is enabled (see setSnapshotFirstSync(boolean), true is the default) then this will attempt to make a compacted + is enabled (see setSnapshotFirstSync(boolean), true is the default) then this will attempt to make a compacted representation of the state of the annotations in the case. Otherwise this method will iterate every single history event in the case and record it in the database. @@ -800,285 +764,234 @@

        syncHistory

        java.io.IOException - If there is an error: creating snapshot, getting case history or converting items into bitamp byte array for DB
        java.sql.SQLException - If the SQL bits throw an error
        +
        • -
      - - - -
      • -

        eachRecordedTagEvent

        -
        public void eachRecordedTagEvent(long startedAfter,
-                                 java.util.function.Consumer<TagEvent> callback)
-                          throws java.sql.SQLException
        +
        +

        eachRecordedTagEvent

        +
        public void eachRecordedTagEvent​(long startedAfter, +java.util.function.Consumer<TagEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedTagEvent

        -
        public void eachRecordedTagEvent(org.joda.time.DateTime startedAfter,
-                                 java.util.function.Consumer<TagEvent> callback)
-                          throws java.sql.SQLException
        +
        +

        eachRecordedTagEvent

        +
        public void eachRecordedTagEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<TagEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedExclusionEvent

        -
        public void eachRecordedExclusionEvent(long startedAfter,
-                                       java.util.function.Consumer<ExclusionEvent> callback)
-                                throws java.sql.SQLException
        +
        +

        eachRecordedExclusionEvent

        +
        public void eachRecordedExclusionEvent​(long startedAfter, +java.util.function.Consumer<ExclusionEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedExclusionEvent

        -
        public void eachRecordedExclusionEvent(org.joda.time.DateTime startedAfter,
-                                       java.util.function.Consumer<ExclusionEvent> callback)
-                                throws java.sql.SQLException
        +
        +

        eachRecordedExclusionEvent

        +
        public void eachRecordedExclusionEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<ExclusionEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedCustomMetadataEvent

        -
        public void eachRecordedCustomMetadataEvent(long startedAfter,
-                                            java.util.function.Consumer<CustomMetadataEvent> callback)
-                                     throws java.sql.SQLException
        +
        +

        eachRecordedCustomMetadataEvent

        +
        public void eachRecordedCustomMetadataEvent​(long startedAfter, +java.util.function.Consumer<CustomMetadataEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedCustomMetadataEvent

        -
        public void eachRecordedCustomMetadataEvent(org.joda.time.DateTime startedAfter,
-                                            java.util.function.Consumer<CustomMetadataEvent> callback)
-                                     throws java.sql.SQLException
        +
        +

        eachRecordedCustomMetadataEvent

        +
        public void eachRecordedCustomMetadataEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<CustomMetadataEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedItemSetEvent

        -
        public void eachRecordedItemSetEvent(long startedAfter,
-                                     java.util.function.Consumer<ItemSetEvent> callback)
-                              throws java.sql.SQLException
        +
        +

        eachRecordedItemSetEvent

        +
        public void eachRecordedItemSetEvent​(long startedAfter, +java.util.function.Consumer<ItemSetEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedItemSetEvent

        -
        public void eachRecordedItemSetEvent(org.joda.time.DateTime startedAfter,
-                                     java.util.function.Consumer<ItemSetEvent> callback)
-                              throws java.sql.SQLException
        +
        +

        eachRecordedItemSetEvent

        +
        public void eachRecordedItemSetEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<ItemSetEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedCustodianEvent

        -
        public void eachRecordedCustodianEvent(long startedAfter,
-                                       java.util.function.Consumer<CustodianEvent> callback)
-                                throws java.sql.SQLException
        +
        +

        eachRecordedCustodianEvent

        +
        public void eachRecordedCustodianEvent​(long startedAfter, +java.util.function.Consumer<CustodianEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedCustodianEvent

        -
        public void eachRecordedCustodianEvent(org.joda.time.DateTime startedAfter,
-                                       java.util.function.Consumer<CustodianEvent> callback)
-                                throws java.sql.SQLException
        +
        +

        eachRecordedCustodianEvent

        +
        public void eachRecordedCustodianEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<CustodianEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedProductionSetEvent

        -
        public void eachRecordedProductionSetEvent(long startedAfter,
-                                           java.util.function.Consumer<ProductionSetEvent> callback)
-                                    throws java.sql.SQLException
        +
        +

        eachRecordedProductionSetEvent

        +
        public void eachRecordedProductionSetEvent​(long startedAfter, +java.util.function.Consumer<ProductionSetEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        eachRecordedProductionSetEvent

        -
        public void eachRecordedProductionSetEvent(org.joda.time.DateTime startedAfter,
-                                           java.util.function.Consumer<ProductionSetEvent> callback)
-                                    throws java.sql.SQLException
        +
        +

        eachRecordedProductionSetEvent

        +
        public void eachRecordedProductionSetEvent​(org.joda.time.DateTime startedAfter, +java.util.function.Consumer<ProductionSetEvent> callback) + throws java.sql.SQLException
        Throws:
        java.sql.SQLException
        +
        • -
      - - - -
      • -

        getSnapshotFirstSync

        -
        public boolean getSnapshotFirstSync()
        +
        +

        getSnapshotFirstSync

        +
        public boolean getSnapshotFirstSync()
        Gets whether a more succinct snapshot should be created in a new database.
        Returns:
        True means the code will attempt to make a snapshot while false means the code will just record all annotation history events.
        +
        • -
      - - - -
      • -

        setSnapshotFirstSync

        -
        public void setSnapshotFirstSync(boolean snapshotFirstSync)
        +
        +

        setSnapshotFirstSync

        +
        public void setSnapshotFirstSync​(boolean snapshotFirstSync)
        Sets whether a more succinct snapshot should be created in a new database.
        Parameters:
        snapshotFirstSync - True means the code will attempt to make a snapshot while false means the code will just record all annotation history events.
        +
        • -
      - - - -
      • -

        getGuidRefInsertBatchSize

        -
        public int getGuidRefInsertBatchSize()
        +
        +

        getGuidRefInsertBatchSize

        +
        public int getGuidRefInsertBatchSize()
        +
        • -
      - - - -
      • -

        setGuidRefInsertBatchSize

        -
        public void setGuidRefInsertBatchSize(int guidRefInsertBatchSize)
        +
        +

        setGuidRefInsertBatchSize

        +
        public void setGuidRefInsertBatchSize​(int guidRefInsertBatchSize)
        +
        • -
      - - - - - - - -
      • -

        close

        -
        public void close()
-           throws java.io.IOException
        +
        +

        close

        +
        public void close() + throws java.io.IOException
        Specified by:
        -
        close in interface java.io.Closeable
        -
        Specified by:
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html index bb4764f..ddbb8e9 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html @@ -1,42 +1,48 @@ - + AnnotationHistoryRepositorySummary + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class AnnotationHistoryRepositorySummary

+
Package com.nuix.superutilities.annotations
+

Class AnnotationHistoryRepositorySummary

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary
    +
    +
    -
    public class AnnotationHistoryRepositorySummary
 extends java.lang.Object
    -
    • -
-
-
+ +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        + +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      -
        +

        Method Details

        +
        • -

          toString

          -
          public java.lang.String toString()
          +
          +

          toString

          +
          public java.lang.String toString()
          Overrides:
          toString in class java.lang.Object
          +
        +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html b/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html index 67325bb..7c661a8 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html @@ -1,42 +1,48 @@ - + AnnotationMatchingMethod + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Enum AnnotationMatchingMethod

+
Package com.nuix.superutilities.annotations
+

Enum AnnotationMatchingMethod

-
    -
  • java.lang.Object
    • -
  • - -
    • -
-
- -
-
+extends java.lang.Enum<AnnotationMatchingMethod> + +
    +
  • +
    + + +

    Nested Class Summary

    +
    +

    Nested classes/interfaces inherited from class java.lang.Enum

    + + +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
    +
    +
    • -
      -
    • +
    • +
      -

      Enum Constant Summary

      - +

      Enum Constant Summary

      +
      +
      + - + + + + - + + - + + +
      Enum Constants 
      Enum Constant and DescriptionEnum ConstantDescription
      GUID GUID 
      MD5 MD5 
      +
+ - -
+
+

Methods inherited from class java.lang.Enum

-compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf - -
    -
  • + - +compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+

Methods inherited from class java.lang.Object

-getClass, notify, notifyAll, wait, wait, wait - - - + + +getClass, notify, notifyAll, wait, wait, wait
+ -
-
+ +
Returns:
an array containing the constants of this enum type, in the order they are declared
+ - - - - -
  • -

    valueOf

    -
    public static AnnotationMatchingMethod valueOf(java.lang.String name)
    +
    +

    valueOf

    +
    public static AnnotationMatchingMethod valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are @@ -265,25 +256,28 @@

    valueOf

    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    java.lang.NullPointerException - if the argument is null
    +
+ - - - + + + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationRepository.html b/docs/com/nuix/superutilities/annotations/AnnotationRepository.html index ee3f864..ee2917b 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationRepository.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationRepository.html @@ -1,42 +1,48 @@ - + AnnotationRepository + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class AnnotationRepository

+
Package com.nuix.superutilities.annotations
+

Class AnnotationRepository

- -
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.misc.SQLiteBacked +
    com.nuix.superutilities.annotations.AnnotationRepository
    +
    +
    +
    All Implemented Interfaces:
    -
    java.io.Closeable, java.lang.AutoCloseable
    +
    java.io.Closeable, java.lang.AutoCloseable
    -
    public class AnnotationRepository
-extends SQLiteBacked
    +extends SQLiteBacked
    This class leverages a SQLite database file to export and import annotations between Nuix cases.
    Author:
    Jason Wells
    -
    • -
-
-
+ +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + - + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      AnnotationRepository(java.io.File databaseFile) +AnnotationRepository​(java.io.File databaseFile)
      Creates a new instance associated to the specified SQLite DB file.
      AnnotationRepository(java.lang.String databaseFile) +AnnotationRepository​(java.lang.String databaseFile)
      Creates a new instance associated to the specified SQLite DB file.
      +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.misc.SQLiteBacked

+ - +close, executeInsert, executeInsert, executeLongScalar, executeLongScalar, executeLongScalar, executeQuery, executeScalar, executeStringScalar, executeStringScalar, executeStringScalar, executeUpdate, executeUpdate, executeUpdate
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      +

      Constructor Details

      • -

        AnnotationRepository

        -
        public AnnotationRepository(java.lang.String databaseFile)
-                     throws java.sql.SQLException
        +
        +

        AnnotationRepository

        +
        public AnnotationRepository​(java.lang.String databaseFile) + throws java.sql.SQLException
        Creates a new instance associated to the specified SQLite DB file. File will be created if it does not already exist.
        Parameters:
        @@ -305,16 +322,13 @@

        AnnotationRepository

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        AnnotationRepository

        -
        public AnnotationRepository(java.io.File databaseFile)
-                     throws java.sql.SQLException
        +
        +

        AnnotationRepository

        +
        public AnnotationRepository​(java.io.File databaseFile) + throws java.sql.SQLException
        Creates a new instance associated to the specified SQLite DB file. File will be created if it does not already exist.
        Parameters:
        @@ -322,53 +336,46 @@

        AnnotationRepository

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
      +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        whenMessageLogged

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

        whenMessageLogged

        +
        public void whenMessageLogged​(java.util.function.Consumer<java.lang.String> callback)
        Allows you to provide a callback which will be invoked when this instance emits a log message.
        Parameters:
        callback - The callback to receive logged messages
        +
        • -
      - - - -
      • -

        whenProgressUpdated

        -
        public void whenProgressUpdated(java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> callback)
        +
        +

        whenProgressUpdated

        +
        public void whenProgressUpdated​(java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> callback)
        Allows you to provide a callback which will be invoked when this instance emits a progress update.
        Parameters:
        callback - The callback to invoke when progress is updated
        +
        • -
      - - - -
      • -

        storeAllMarkupSets

        -
        public void storeAllMarkupSets(nuix.Case nuixCase)
-                        throws java.io.IOException,
-                               java.sql.SQLException
        +
        +

        storeAllMarkupSets

        +
        public void storeAllMarkupSets​(nuix.Case nuixCase) + throws java.io.IOException, +java.sql.SQLException
        Stores all markup sets found in the provided case to the SQLite DB file.
        Parameters:
        @@ -377,16 +384,13 @@

        storeAllMarkupSets

        java.io.IOException - Thrown most likely if there was an issue searching or retrieving printed pages of and item.
        java.sql.SQLException - Thrown if anything goes wrong interacting with the SQLite database file.
        +
        • -
      - - - -
      • -

        getItemId

        -
        public long getItemId(nuix.Item item)
-               throws java.sql.SQLException
        +
        +

        getItemId

        +
        public long getItemId​(nuix.Item item) + throws java.sql.SQLException
        Gets the sequentially assigned ID value from the Item table for a given item based on its GUID. Will attempt to get this from a cache first.
        Parameters:
        @@ -396,16 +400,13 @@

        getItemId

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        getMarkupSetId

        -
        public long getMarkupSetId(nuix.MarkupSet markupSet)
-                    throws java.sql.SQLException
        +
        +

        getMarkupSetId

        +
        public long getMarkupSetId​(nuix.MarkupSet markupSet) + throws java.sql.SQLException
        Gets the sequentially assigned ID value from the MarkupSet table for a given markup. Will attempt to get this from a cache first.
        Parameters:
        @@ -415,16 +416,13 @@

        getMarkupSetId

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        getTagId

        -
        public long getTagId(java.lang.String tagName)
-              throws java.sql.SQLException
        +
        +

        getTagId

        +
        public long getTagId​(java.lang.String tagName) + throws java.sql.SQLException
        Gets the sequentially assigned ID value from the Tag table for a given tag name. Will attempt to get this from a cache first.
        Parameters:
        @@ -434,18 +432,15 @@

        getTagId

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        storeTag

        -
        public void storeTag(nuix.Case nuixCase,
-                     java.lang.String tagName)
-              throws java.io.IOException,
-                     java.sql.SQLException
        +
        +

        storeTag

        +
        public void storeTag​(nuix.Case nuixCase, +java.lang.String tagName) + throws java.io.IOException, +java.sql.SQLException
        Stores a specific tag present in the provided case as records in the DB file.
        Parameters:
        @@ -455,17 +450,14 @@

        storeTag

        java.io.IOException - Thrown if a search error occurs.
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        storeAllTags

        -
        public void storeAllTags(nuix.Case nuixCase)
-                  throws java.io.IOException,
-                         java.sql.SQLException
        +
        +

        storeAllTags

        +
        public void storeAllTags​(nuix.Case nuixCase) + throws java.io.IOException, +java.sql.SQLException
        Stores all tags present in the provided case as records in the DB file.
        Parameters:
        @@ -474,17 +466,14 @@

        storeAllTags

        java.io.IOException - Thrown if a search error occurs.
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        applyTagsFromDatabaseToCase

        -
        public void applyTagsFromDatabaseToCase(nuix.Case nuixCase,
-                                        AnnotationMatchingMethod matchingMethod)
-                                 throws java.sql.SQLException
        +
        +

        applyTagsFromDatabaseToCase

        +
        public void applyTagsFromDatabaseToCase​(nuix.Case nuixCase, +AnnotationMatchingMethod matchingMethod) + throws java.sql.SQLException
        Applies tags to items in the provided case based on tag records in the DB file associated to this instance.
        Parameters:
        @@ -493,18 +482,15 @@

        applyTagsFromDatabaseToCase

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        storeMarkupSet

        -
        public void storeMarkupSet(nuix.Case nuixCase,
-                           nuix.MarkupSet markupSet)
-                    throws java.io.IOException,
-                           java.sql.SQLException
        +
        +

        storeMarkupSet

        +
        public void storeMarkupSet​(nuix.Case nuixCase, +nuix.MarkupSet markupSet) + throws java.io.IOException, +java.sql.SQLException
        Stores a particular markup set present in the provided Nuix case.
        Parameters:
        @@ -514,18 +500,15 @@

        storeMarkupSet

        java.io.IOException - Thrown most likely if there was an issue searching or retrieving printed pages of and item.
        java.sql.SQLException - Thrown if anything goes wrong interacting with the SQLite database file.
        +
        • -
      - - - -
      • -

        applyMarkupsFromDatabaseToCase

        -
        public void applyMarkupsFromDatabaseToCase(nuix.Case nuixCase,
-                                           boolean addToExistingMarkupSet,
-                                           AnnotationMatchingMethod matchingMethod)
-                                    throws java.sql.SQLException
        +
        +

        applyMarkupsFromDatabaseToCase

        +
        public void applyMarkupsFromDatabaseToCase​(nuix.Case nuixCase, +boolean addToExistingMarkupSet, +AnnotationMatchingMethod matchingMethod) + throws java.sql.SQLException
        Applies markups present in the SQLite DB file associated to this instance to the provided Nuix case.
        Parameters:
        @@ -535,16 +518,13 @@

        applyMarkupsFromDatabaseToCase

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        getTagsForMd5

        -
        public java.util.List<java.lang.String> getTagsForMd5(java.lang.String md5)
-                                               throws java.sql.SQLException
        +
        +

        getTagsForMd5

        +
        public java.util.List<java.lang.String> getTagsForMd5​(java.lang.String md5) + throws java.sql.SQLException
        Queries the DB for the names of tags associated with the provided MD5.
        Parameters:
        @@ -554,16 +534,13 @@

        getTagsForMd5

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        getTagsForGuid

        -
        public java.util.List<java.lang.String> getTagsForGuid(java.lang.String guid)
-                                                throws java.sql.SQLException
        +
        +

        getTagsForGuid

        +
        public java.util.List<java.lang.String> getTagsForGuid​(java.lang.String guid) + throws java.sql.SQLException
        Queries the DB for the names of tags associated with the provided GUID.
        Parameters:
        @@ -573,16 +550,13 @@

        getTagsForGuid

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        getItemMarkupCount

        -
        public long getItemMarkupCount()
-                        throws java.sql.SQLException
        +
        +

        getItemMarkupCount

        +
        public long getItemMarkupCount() + throws java.sql.SQLException
        Gets the number of markups present in the ItemMarkup table.
        Returns:
        @@ -590,36 +564,58 @@

        getItemMarkupCount

        Throws:
        java.sql.SQLException - Thrown if there are errors while interacting with the SQLite DB file.
        +
        • -
      - - - -
      • -

        abort

        -
        public void abort()
        +
        +

        abort

        +
        public void abort()
        Signals that you wish to abort. Export and import logic test for the abort signal in various loops and will cut short their iteration when the abort signal has been set.
        +
        • -
      +
    • +
      +

      getAlwaysCreateTagOnImport

      +
      public boolean getAlwaysCreateTagOnImport()
      +
      Gets whether a tag should always be created even when the source case had no items associated to that tag.
      +
      +
      Returns:
      +
      True if tag should be created during import, even if no items are associated.
      +
      +
      +
      • +
    • +
      +

      setAlwaysCreateTagOnImport

      +
      public void setAlwaysCreateTagOnImport​(boolean alwaysCreateTagOnImport)
      +
      Sets whether a tag should always be created even when the source case had no items associated to that tag.
      +
      +
      Parameters:
      +
      alwaysCreateTagOnImport - True if tag should be created during import, even if no items are associated.
      +
      +
    +
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html b/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html index ee5464f..3f03e25 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html @@ -1,42 +1,48 @@ - + AnnotationSyncSettings + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class AnnotationSyncSettings

+
Package com.nuix.superutilities.annotations
+

Class AnnotationSyncSettings

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.AnnotationSyncSettings
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.AnnotationSyncSettings
    +
    +
    -
    public class AnnotationSyncSettings
 extends java.lang.Object
    -
    • -
-
-
+ +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          AnnotationSyncSettings

          -
          public AnnotationSyncSettings()
          +
          +

          AnnotationSyncSettings

          +
          public AnnotationSyncSettings()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - - - -
      • -

        getSyncCustomMetadataEvents

        -
        public boolean getSyncCustomMetadataEvents()
        -
        • -
      - +
      +

      Method Details

      • -

        setSyncCustomMetadataEvents

        -
        public void setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents)
        +
        +

        getSyncCustomMetadataEvents

        +
        public boolean getSyncCustomMetadataEvents()
        +
        • -
      - - - -
      • -

        getSyncTagEvents

        -
        public boolean getSyncTagEvents()
        +
        +

        setSyncCustomMetadataEvents

        +
        public void setSyncCustomMetadataEvents​(boolean syncCustomMetadataEvents)
        +
        • -
      - - - -
      • -

        setSyncTagEvents

        -
        public void setSyncTagEvents(boolean syncTagEvents)
        +
        +

        getSyncTagEvents

        +
        public boolean getSyncTagEvents()
        +
        • -
      - - - -
      • -

        getSyncItemSetEvents

        -
        public boolean getSyncItemSetEvents()
        +
        +

        setSyncTagEvents

        +
        public void setSyncTagEvents​(boolean syncTagEvents)
        +
        • -
      - - - -
      • -

        setSyncItemSetEvents

        -
        public void setSyncItemSetEvents(boolean syncItemSetEvents)
        +
        +

        getSyncItemSetEvents

        +
        public boolean getSyncItemSetEvents()
        +
        • -
      - - - -
      • -

        getSyncExclusionEvents

        -
        public boolean getSyncExclusionEvents()
        +
        +

        setSyncItemSetEvents

        +
        public void setSyncItemSetEvents​(boolean syncItemSetEvents)
        +
        • -
      - - - -
      • -

        setSyncExclusionEvents

        -
        public void setSyncExclusionEvents(boolean syncExclusionEvents)
        +
        +

        getSyncExclusionEvents

        +
        public boolean getSyncExclusionEvents()
        +
        • -
      - - - -
      • -

        getSyncCustodianEvents

        -
        public boolean getSyncCustodianEvents()
        +
        +

        setSyncExclusionEvents

        +
        public void setSyncExclusionEvents​(boolean syncExclusionEvents)
        +
        • -
      - - - -
      • -

        setSyncCustodianEvents

        -
        public void setSyncCustodianEvents(boolean syncCustodianEvents)
        +
        +

        getSyncCustodianEvents

        +
        public boolean getSyncCustodianEvents()
        +
        • -
      - - - -
      • -

        getSyncProductionSetEvents

        -
        public boolean getSyncProductionSetEvents()
        +
        +

        setSyncCustodianEvents

        +
        public void setSyncCustodianEvents​(boolean syncCustodianEvents)
        +
        • -
      - - - -
      • -

        setSyncProductionSetEvents

        -
        public void setSyncProductionSetEvents(boolean syncProductionSetEvents)
        +
        +

        getSyncProductionSetEvents

        +
        public boolean getSyncProductionSetEvents()
        +
        • -
      - - - -
      • -

        buildSettingsSummary

        -
        public java.lang.String buildSettingsSummary()
        +
        +

        setSyncProductionSetEvents

        +
        public void setSyncProductionSetEvents​(boolean syncProductionSetEvents)
        +
        • -
      +
    • +
      +

      buildSettingsSummary

      +
      public java.lang.String buildSettingsSummary()
      +
    +
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/BulkRedactor.html b/docs/com/nuix/superutilities/annotations/BulkRedactor.html index bfb0780..4bd378c 100644 --- a/docs/com/nuix/superutilities/annotations/BulkRedactor.html +++ b/docs/com/nuix/superutilities/annotations/BulkRedactor.html @@ -1,42 +1,48 @@ - + BulkRedactor + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class BulkRedactor

+
Package com.nuix.superutilities.annotations
+

Class BulkRedactor

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.BulkRedactor
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.BulkRedactor
    +
    +
    -
    public class BulkRedactor
 extends java.lang.Object
    Provides bulk redaction functionality, as found in the GUI, but (as of Nuix 7.8.0.10) is not present in the Nuix API.
    @@ -115,144 +99,150 @@

    Class BulkRedactor

    Author:
    Jason Wells
    -
    • -
-
-
+ +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      BulkRedactor() BulkRedactor() 
      +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          BulkRedactor

          -
          public BulkRedactor()
          +
          +

          BulkRedactor

          +
          public BulkRedactor()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        whenMessageLogged

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

        whenMessageLogged

        +
        public void whenMessageLogged​(java.util.function.Consumer<java.lang.String> callback)
        Allows you to provide a callback which will be invoked when this instance emits a log message.
        Parameters:
        callback - The callback to receive logged messages
        +
        • -
      - - - -
      • -

        whenProgressUpdated

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

        whenProgressUpdated

        +
        public void whenProgressUpdated​(java.util.function.Consumer<BulkRedactorProgressInfo> callback)
        Allows you to provide a callback which will be invoked when this instance emits a progress update.
        Parameters:
        callback - The callback to invoke when progress is updated
        +
        • -
      - - - -
      • -

        findExpressionsInPdfFile

        -
        public java.util.List<NuixImageAnnotationRegion> findExpressionsInPdfFile(java.io.File file,
-                                                                          java.util.Collection<java.lang.String> expressions)
        -
        Generates NuixImageAnnotationRegion objects for matches found by Aspose in the given PDF based on the provided regular expressions.
        +
        +

        findExpressionsInPdfFile

        +
        public java.util.List<NuixImageAnnotationRegion> findExpressionsInPdfFile​(java.io.File file, +java.util.Collection<java.lang.String> expressions)
        +
        Generates NuixImageAnnotationRegion objects for matches found by Aspose in the given PDF based on the provided regular expressions.
        Parameters:
        file - The PDF file to search
        @@ -260,48 +250,50 @@

        findExpressionsInPdfFile

        Returns:
        A List of annotation region objects representing the matches.
        +
        • -
      - - - -
      • -

        findAndMarkup

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

        findAndMarkup

        +
        public java.util.List<NuixImageAnnotationRegion> findAndMarkup​(nuix.Case nuixCase, +BulkRedactorSettings settings, +java.util.Collection<nuix.Item> scopeItems, +int concurrency) + throws java.lang.Exception
        Finds text in PDFs of given items. Then generates redactions based on the matches.
        Parameters:
        nuixCase - The source Nuix case. Needed to obtain items (if none were given) and/or obtain the appropriate markup set.
        settings - The settings used to find and generate the redactions.
        scopeItems - Items to find and redact.
        +
        concurrency - How many threads to put in ForkJoinPool
        Returns:
        Returns a list of all match region objects (so they can be reported, inspected, etc)
        Throws:
        java.lang.Exception - If something goes wrong
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/BulkRedactorProgressInfo.html b/docs/com/nuix/superutilities/annotations/BulkRedactorProgressInfo.html index 0ca9c3d..2393c8e 100644 --- a/docs/com/nuix/superutilities/annotations/BulkRedactorProgressInfo.html +++ b/docs/com/nuix/superutilities/annotations/BulkRedactorProgressInfo.html @@ -1,42 +1,48 @@ - + BulkRedactorProgressInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class BulkRedactorProgressInfo

+
Package com.nuix.superutilities.annotations
+

Class BulkRedactorProgressInfo

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.BulkRedactorProgressInfo
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.BulkRedactorProgressInfo
    +
    +
    -
    public class BulkRedactorProgressInfo
 extends java.lang.Object
    -
    • -
-
-
+ +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          BulkRedactorProgressInfo

          -
          public BulkRedactorProgressInfo()
          +
          +

          BulkRedactorProgressInfo

          +
          public BulkRedactorProgressInfo()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - - - -
      • -

        getCurrent

        -
        public int getCurrent()
        -
        • -
      - +
      +

      Method Details

      • -

        setCurrent

        -
        public void setCurrent(int current)
        +
        +

        getCurrent

        +
        public int getCurrent()
        +
        • -
      - - - -
      • -

        getTotal

        -
        public int getTotal()
        +
        +

        setCurrent

        +
        public void setCurrent​(int current)
        +
        • -
      - - - -
      • -

        setTotal

        -
        public void setTotal(int total)
        +
        +

        getTotal

        +
        public int getTotal()
        +
        • -
      - - - -
      • -

        getMatches

        -
        public int getMatches()
        +
        +

        setTotal

        +
        public void setTotal​(int total)
        +
        • -
      - - - -
      • -

        setMatches

        -
        public void setMatches(int matches)
        +
        +

        getMatches

        +
        public int getMatches()
        +
        • -
      +
    • +
      +

      setMatches

      +
      public void setMatches​(int matches)
      +
    +
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/BulkRedactorSettings.html b/docs/com/nuix/superutilities/annotations/BulkRedactorSettings.html index 47b706e..0da0c38 100644 --- a/docs/com/nuix/superutilities/annotations/BulkRedactorSettings.html +++ b/docs/com/nuix/superutilities/annotations/BulkRedactorSettings.html @@ -1,42 +1,48 @@ - + BulkRedactorSettings + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class BulkRedactorSettings

+
Package com.nuix.superutilities.annotations
+

Class BulkRedactorSettings

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.BulkRedactorSettings
      • -
    -
    • -
-
- -
-
+ +
+ - -
    -
  • +
  • +
    -

    Method Summary

    - - +

    Method Summary

    +
    +
    +
    +
    All Methods Static Methods Instance Methods Concrete Methods 
    + - + + - + + + - + - + - + - + - + - + - + - + - + - + - + + - + - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + - + - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + +
    Modifier and TypeMethod and DescriptionMethodDescription
    voidaddExpression(java.lang.String regularExpression) +addExpression​(java.lang.String regularExpression)
    Adds a regular expression to the list of expressions used to locate text to markup.
    voidaddNamedEntity(java.lang.String namedEntityType) +addNamedEntity​(java.lang.String namedEntityType)
    Adds a named entity type to the list of types to be redacted.
    voidaddPhrase(java.lang.String phrase) +addPhrase​(java.lang.String phrase)
    Adds a phrase to the list of expressions used to find and markup text.
    voidaddPhrases(java.util.Collection<java.lang.String> phrases) +addPhrases​(java.util.Collection<java.lang.String> phrases)
    Adds multiple phrases to the list of expressions used to find and markup text.
    static java.lang.StringescapeRegexSpecialCharacters(java.lang.String input) +escapeRegexSpecialCharacters​(java.lang.String input)
    Escapes regular expression characters in the input string.
    booleangetApplyHighLights() getApplyHighLights() 
    booleangetApplyRedactions() getApplyRedactions() 
    java.util.Set<java.lang.String>getExpressions() +getExpressions()
    Gets the regular expressions which will be used to locate text to markup.
    nuix.MarkupSetgetMarkupSet(nuix.Case nuixCase) -
    Gets the Nuix MarkupSet object based on the markup set name as set by setMarkupSetName(String).
    +    		getMarkupSet​(nuix.Case nuixCase) +
    Gets the Nuix MarkupSet object based on the markup set name as set by setMarkupSetName(String).
    java.lang.StringgetMarkupSetName() +getMarkupSetName()
    Gets the name of the markup set to which markups will be recorded against.
    java.util.Set<java.lang.String>getNamedEntityTypes() +getNamedEntityTypes()
    Gets the list of named entity types to be redacted.
    java.io.FilegetTempDirectory() -
    Gets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    +    		getTempDirectory() +
    Gets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    static java.lang.StringphraseToExpression(java.lang.String phrase) +phraseToExpression​(java.lang.String phrase)
    Converts a phrase (string with potentially multiple terms) into a regular expression for used searching for text to redact in a PDF.
    voidsetApplyHighLights(boolean applyHighLights) setApplyHighLights​(boolean applyHighLights) 
    voidsetApplyRedactions(boolean applyRedactions) setApplyRedactions​(boolean applyRedactions) 
    voidsetExpressions(java.util.Collection<java.lang.String> expressions) +setExpressions​(java.util.Collection<java.lang.String> expressions)
    Sets the regular expressions which will be used to locate text to markup.
    voidsetMarkupSetName(java.lang.String markupSetName) +setMarkupSetName​(java.lang.String markupSetName)
    Sets the name of the markup set to which markup will be recorded against.
    voidsetNamedEntityTypes(java.util.Collection<java.lang.String> namedEntityTypes) +setNamedEntityTypes​(java.util.Collection<java.lang.String> namedEntityTypes)
    Sets the list of named entity type to be redacted.
    voidsetTempDirectory(java.io.File tempDirectory) -
    Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    +    		setTempDirectory​(java.io.File tempDirectory) +
    Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    voidsetTempDirectory(java.lang.String tempDirectory) -
    Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    +    		setTempDirectory​(java.lang.String tempDirectory) +
    Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
    static java.util.List<java.lang.String>splitPhrase(java.lang.String phrase) +splitPhrase​(java.lang.String phrase)
    Splits a string into tokens on whitespace using the regular expression: \s+
    static java.lang.StringtermToRegex(java.lang.String inputTerm) +termToRegex​(java.lang.String inputTerm)
    Converts a plain text term to a regular expression which is case insensitive.
    -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          BulkRedactorSettings

          -
          public BulkRedactorSettings()
          +
          +

          BulkRedactorSettings

          +
          public BulkRedactorSettings()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        getMarkupSetName

        -
        public java.lang.String getMarkupSetName()
        +
        +

        getMarkupSetName

        +
        public java.lang.String getMarkupSetName()
        Gets the name of the markup set to which markups will be recorded against.
        Returns:
        The name of the markup set to use.
        +
        • -
      - - - -
      • -

        setMarkupSetName

        -
        public void setMarkupSetName(java.lang.String markupSetName)
        +
        +

        setMarkupSetName

        +
        public void setMarkupSetName​(java.lang.String markupSetName)
        Sets the name of the markup set to which markup will be recorded against.
        Parameters:
        markupSetName - The name of the markup set to use. If the name provided does not exist, a markup set will be created.
        +
        • -
      - - - -
      • -

        getTempDirectory

        -
        public java.io.File getTempDirectory()
        -
        Gets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        +
        +

        getTempDirectory

        +
        public java.io.File getTempDirectory()
        +
        Gets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        Returns:
        The PDF export temp directory.
        +
        • -
      - - - -
      • -

        setTempDirectory

        -
        public void setTempDirectory(java.io.File tempDirectory)
        -
        Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        +
        +

        setTempDirectory

        +
        public void setTempDirectory​(java.io.File tempDirectory)
        +
        Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        Parameters:
        tempDirectory - The PDF export temp directory.
        +
        • -
      - - - -
      • -

        setTempDirectory

        -
        public void setTempDirectory(java.lang.String tempDirectory)
        -
        Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        +
        +

        setTempDirectory

        +
        public void setTempDirectory​(java.lang.String tempDirectory)
        +
        Sets the temp directory to which BulkRedactor will export PDF files which will be provided to Aspose.
        Parameters:
        tempDirectory - The PDF export temp directory.
        +
        • -
      - - - -
      • -

        getExpressions

        -
        public java.util.Set<java.lang.String> getExpressions()
        +
        +

        getExpressions

        +
        public java.util.Set<java.lang.String> getExpressions()
        Gets the regular expressions which will be used to locate text to markup.
        Returns:
        The regular expressions which will be used to locate text to markup.
        +
        • -
      - - - -
      • -

        setExpressions

        -
        public void setExpressions(java.util.Collection<java.lang.String> expressions)
        +
        +

        setExpressions

        +
        public void setExpressions​(java.util.Collection<java.lang.String> expressions)
        Sets the regular expressions which will be used to locate text to markup.
        Parameters:
        expressions - The regular expressions which will be used to locate text to markup.
        +
        • -
      - - - -
      • -

        addExpression

        -
        public void addExpression(java.lang.String regularExpression)
        +
        +

        addExpression

        +
        public void addExpression​(java.lang.String regularExpression)
        Adds a regular expression to the list of expressions used to locate text to markup.
        Parameters:
        regularExpression - A regular expression to add
        +
        • -
      - - - -
      • -

        getNamedEntityTypes

        -
        public java.util.Set<java.lang.String> getNamedEntityTypes()
        +
        +

        getNamedEntityTypes

        +
        public java.util.Set<java.lang.String> getNamedEntityTypes()
        Gets the list of named entity types to be redacted.
        Returns:
        The list of named entity types to be redacted.
        +
        • -
      - - - -
      • -

        setNamedEntityTypes

        -
        public void setNamedEntityTypes(java.util.Collection<java.lang.String> namedEntityTypes)
        +
        +

        setNamedEntityTypes

        +
        public void setNamedEntityTypes​(java.util.Collection<java.lang.String> namedEntityTypes)
        Sets the list of named entity type to be redacted.
        Parameters:
        namedEntityTypes - The named entity types to be redacted.
        +
        • -
      - - - -
      • -

        addNamedEntity

        -
        public void addNamedEntity(java.lang.String namedEntityType)
        +
        +

        addNamedEntity

        +
        public void addNamedEntity​(java.lang.String namedEntityType)
        Adds a named entity type to the list of types to be redacted.
        Parameters:
        namedEntityType - The named entity type to be added to the list.
        +
        • -
      - - - -
      • -

        getMarkupSet

        -
        public nuix.MarkupSet getMarkupSet(nuix.Case nuixCase)
        -
        Gets the Nuix MarkupSet object based on the markup set name as set by setMarkupSetName(String). If the markup set by the given name +
        +

        getMarkupSet

        +
        public nuix.MarkupSet getMarkupSet​(nuix.Case nuixCase)
        +
        Gets the Nuix MarkupSet object based on the markup set name as set by setMarkupSetName(String). If the markup set by the given name already exists, then this will yield that existing markup set. If it does not, a new markup set with the given name will be created.
        Parameters:
        nuixCase - The relevant Nuix Case
        Returns:
        -
        Either the existing markup set or a newly created markup set, based on the markup set name as set by setMarkupSetName(String).
        +
        Either the existing markup set or a newly created markup set, based on the markup set name as set by setMarkupSetName(String).
        +
        • -
      - - - -
      • -

        escapeRegexSpecialCharacters

        -
        public static java.lang.String escapeRegexSpecialCharacters(java.lang.String input)
        +
        +

        escapeRegexSpecialCharacters

        +
        public static java.lang.String escapeRegexSpecialCharacters​(java.lang.String input)
        Escapes regular expression characters in the input string.
        Parameters:
        @@ -498,15 +475,12 @@

        escapeRegexSpecialCharacters

        Returns:
        String with the regular expression characters escaped.
        +
        • -
      - - - -
      • -

        termToRegex

        -
        public static java.lang.String termToRegex(java.lang.String inputTerm)
        +
        +

        termToRegex

        +
        public static java.lang.String termToRegex​(java.lang.String inputTerm)
        Converts a plain text term to a regular expression which is case insensitive. This is done by generating a regular expression with a character class matching each letter in both lower case and upper case. For example if the input term is "cat", this returns @@ -517,15 +491,12 @@

        termToRegex

        Returns:
        String Regular expression that is case insensitive regular expression for input term
        +
        • -
      - - - -
      • -

        splitPhrase

        -
        public static java.util.List<java.lang.String> splitPhrase(java.lang.String phrase)
        +
        +

        splitPhrase

        +
        public static java.util.List<java.lang.String> splitPhrase​(java.lang.String phrase)
        Splits a string into tokens on whitespace using the regular expression: \s+
        Parameters:
        @@ -533,107 +504,89 @@

        splitPhrase

        Returns:
        List of token strings.
        +
        • -
      - - - -
      • -

        phraseToExpression

        -
        public static java.lang.String phraseToExpression(java.lang.String phrase)
        +
        +

        phraseToExpression

        +
        public static java.lang.String phraseToExpression​(java.lang.String phrase)
        Converts a phrase (string with potentially multiple terms) into a regular expression for used searching for text to redact in a PDF.
        Parameters:
        phrase - The phrase to convert into a regular expression. May be single or multiple terms.
        Returns:
        -
        A regular expression to match that phrase in a case insensitive manner. Internally calls splitPhrase(String) and termToRegex(String).
        +
        A regular expression to match that phrase in a case insensitive manner. Internally calls splitPhrase(String) and termToRegex(String).
        +
        • -
      - - - -
      • -

        addPhrase

        -
        public void addPhrase(java.lang.String phrase)
        -
        Adds a phrase to the list of expressions used to find and markup text. Phrase is converted to an expression using phraseToExpression(String). +
        +

        addPhrase

        +
        public void addPhrase​(java.lang.String phrase)
        +
        Adds a phrase to the list of expressions used to find and markup text. Phrase is converted to an expression using phraseToExpression(String). Resulting expression is then surrounded '\b' to anchor it to word boundaries.
        Parameters:
        phrase - The phrase to add to the list of expressions used to find and markup text.
        +
        • -
      - - - -
      • -

        addPhrases

        -
        public void addPhrases(java.util.Collection<java.lang.String> phrases)
        -
        Adds multiple phrases to the list of expressions used to find and markup text. Internally calls addPhrase(String) +
        +

        addPhrases

        +
        public void addPhrases​(java.util.Collection<java.lang.String> phrases)
        +
        Adds multiple phrases to the list of expressions used to find and markup text. Internally calls addPhrase(String) for each string in the provide value.
        Parameters:
        phrases - Multiple phrases to the list of expressions used to find and markup text.
        +
        • -
      - - - -
      • -

        getApplyRedactions

        -
        public boolean getApplyRedactions()
        +
        +

        getApplyRedactions

        +
        public boolean getApplyRedactions()
        +
        • -
      - - - -
      • -

        setApplyRedactions

        -
        public void setApplyRedactions(boolean applyRedactions)
        +
        +

        setApplyRedactions

        +
        public void setApplyRedactions​(boolean applyRedactions)
        +
        • -
      - - - -
      • -

        getApplyHighLights

        -
        public boolean getApplyHighLights()
        +
        +

        getApplyHighLights

        +
        public boolean getApplyHighLights()
        +
        • -
      - - - -
      • -

        setApplyHighLights

        -
        public void setApplyHighLights(boolean applyHighLights)
        +
        +

        setApplyHighLights

        +
        public void setApplyHighLights​(boolean applyHighLights)
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/CustodianEvent.html b/docs/com/nuix/superutilities/annotations/CustodianEvent.html index cea15f8..4b32bd5 100644 --- a/docs/com/nuix/superutilities/annotations/CustodianEvent.html +++ b/docs/com/nuix/superutilities/annotations/CustodianEvent.html @@ -1,42 +1,48 @@ - + CustodianEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class CustodianEvent

+
Package com.nuix.superutilities.annotations
+

Class CustodianEvent

- -
- -
-
+extends AnnotationEvent + +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      CustodianEvent() CustodianEvent() 
      +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          CustodianEvent

          -
          public CustodianEvent()
          +
          +

          CustodianEvent

          +
          public CustodianEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
        • -
      - - - -
      • -

        getAssigned

        -
        public boolean getAssigned()
        +
        +

        getAssigned

        +
        public boolean getAssigned()
        +
        • -
      - - - -
      • -

        getCustodian

        -
        public java.lang.String getCustodian()
        -
        • -
      +
      +

      getCustodian

      +
      public java.lang.String getCustodian()
      +
    +
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/CustomMetadataEvent.html b/docs/com/nuix/superutilities/annotations/CustomMetadataEvent.html index 652b4da..20b3053 100644 --- a/docs/com/nuix/superutilities/annotations/CustomMetadataEvent.html +++ b/docs/com/nuix/superutilities/annotations/CustomMetadataEvent.html @@ -1,42 +1,48 @@ - + CustomMetadataEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class CustomMetadataEvent

+
Package com.nuix.superutilities.annotations
+

Class CustomMetadataEvent

- -
- -
-
+extends AnnotationEvent + +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          CustomMetadataEvent

          -
          public CustomMetadataEvent()
          +
          +

          CustomMetadataEvent

          +
          public CustomMetadataEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getAdded

        -
        public java.lang.Boolean getAdded()
        +
        +

        getAdded

        +
        public java.lang.Boolean getAdded()
        +
        • -
      - - - -
      • -

        getFieldName

        -
        public java.lang.String getFieldName()
        +
        +

        getFieldName

        +
        public java.lang.String getFieldName()
        +
        • -
      - - - -
      • -

        getValueType

        -
        public java.lang.String getValueType()
        +
        +

        getValueType

        +
        public java.lang.String getValueType()
        +
        • -
      - - - -
      • -

        getValueAsDateTime

        -
        public org.joda.time.DateTime getValueAsDateTime()
        +
        +

        getValueAsDateTime

        +
        public org.joda.time.DateTime getValueAsDateTime()
        +
        • -
      - - - -
      • -

        getValueAsLong

        -
        public java.lang.Long getValueAsLong()
        +
        +

        getValueAsLong

        +
        public java.lang.Long getValueAsLong()
        +
        • -
      - - - -
      • -

        getValueAsInteger

        -
        public java.lang.Integer getValueAsInteger()
        +
        +

        getValueAsInteger

        +
        public java.lang.Integer getValueAsInteger()
        +
        • -
      - - - -
      • -

        getValueAsDouble

        -
        public java.lang.Double getValueAsDouble()
        +
        +

        getValueAsDouble

        +
        public java.lang.Double getValueAsDouble()
        +
        • -
      - - - -
      • -

        getValueAsByteArray

        -
        public byte[] getValueAsByteArray()
        +
        +

        getValueAsByteArray

        +
        public byte[] getValueAsByteArray()
        +
        • -
      - - - -
      • -

        getValueAsString

        -
        public java.lang.String getValueAsString()
        +
        +

        getValueAsString

        +
        public java.lang.String getValueAsString()
        +
        • -
      - - - -
      • -

        getValue

        -
        public java.lang.Object getValue()
        +
        +

        getValue

        +
        public java.lang.Object getValue()
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/ExclusionEvent.html b/docs/com/nuix/superutilities/annotations/ExclusionEvent.html index 29a28a2..3188ea5 100644 --- a/docs/com/nuix/superutilities/annotations/ExclusionEvent.html +++ b/docs/com/nuix/superutilities/annotations/ExclusionEvent.html @@ -1,42 +1,48 @@ - + ExclusionEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class ExclusionEvent

+
Package com.nuix.superutilities.annotations
+

Class ExclusionEvent

- -
- -
-
+extends AnnotationEvent + +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      ExclusionEvent() ExclusionEvent() 
      +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          ExclusionEvent

          -
          public ExclusionEvent()
          +
          +

          ExclusionEvent

          +
          public ExclusionEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getExcluded

        -
        public java.lang.Boolean getExcluded()
        +
        +

        getExcluded

        +
        public java.lang.Boolean getExcluded()
        +
        • -
      - - - -
      • -

        getExclusionName

        -
        public java.lang.String getExclusionName()
        +
        +

        getExclusionName

        +
        public java.lang.String getExclusionName()
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/ItemSetEvent.html b/docs/com/nuix/superutilities/annotations/ItemSetEvent.html index 307c18a..af264da 100644 --- a/docs/com/nuix/superutilities/annotations/ItemSetEvent.html +++ b/docs/com/nuix/superutilities/annotations/ItemSetEvent.html @@ -1,42 +1,48 @@ - + ItemSetEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class ItemSetEvent

+
Package com.nuix.superutilities.annotations
+

Class ItemSetEvent

- -
- -
-
+extends AnnotationEvent + +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      ItemSetEvent() ItemSetEvent() 
      +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          ItemSetEvent

          -
          public ItemSetEvent()
          +
          +

          ItemSetEvent

          +
          public ItemSetEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getAdded

        -
        public java.lang.Boolean getAdded()
        +
        +

        getAdded

        +
        public java.lang.Boolean getAdded()
        +
        • -
      - - - -
      • -

        getSettings

        -
        public java.util.Map<java.lang.String,java.lang.Object> getSettings()
        +
        +

        getSettings

        +
        public java.util.Map<java.lang.String,​java.lang.Object> getSettings()
        +
        • -
      - - - -
      • -

        getItemSetName

        -
        public java.lang.String getItemSetName()
        +
        +

        getItemSetName

        +
        public java.lang.String getItemSetName()
        +
        • -
      - - - -
      • -

        getBatchName

        -
        public java.lang.String getBatchName()
        +
        +

        getBatchName

        +
        public java.lang.String getBatchName()
        +
        • -
      - - - -
      • -

        getRelatedItemSet

        -
        public nuix.ItemSet getRelatedItemSet(nuix.Case nuixCase)
        +
        +

        getRelatedItemSet

        +
        public nuix.ItemSet getRelatedItemSet​(nuix.Case nuixCase)
        +
        • -
      - - - -
      • -

        getOrCreateRelatedItemSet

        -
        public nuix.ItemSet getOrCreateRelatedItemSet(nuix.Case nuixCase)
        +
        +

        getOrCreateRelatedItemSet

        +
        public nuix.ItemSet getOrCreateRelatedItemSet​(nuix.Case nuixCase)
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html b/docs/com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html index 676e6fb..058a858 100644 --- a/docs/com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html +++ b/docs/com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html @@ -1,42 +1,48 @@ - + NuixImageAnnotationRegion + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class NuixImageAnnotationRegion

+
Package com.nuix.superutilities.annotations
+

Class NuixImageAnnotationRegion

-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.nuix.superutilities.annotations.NuixImageAnnotationRegion
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    +
    -
    public class NuixImageAnnotationRegion
 extends java.lang.Object
    -
    • -
-
-
+ +
+ - -
+
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          NuixImageAnnotationRegion

          -
          public NuixImageAnnotationRegion()
          +
          +

          NuixImageAnnotationRegion

          +
          public NuixImageAnnotationRegion()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        getX

        -
        public double getX()
        +
        +

        getX

        +
        public double getX()
        +
        • -
      - - - -
      • -

        setX

        -
        public void setX(double x)
        +
        +

        setX

        +
        public void setX​(double x)
        +
        • -
      - - - -
      • -

        getY

        -
        public double getY()
        +
        +

        getY

        +
        public double getY()
        +
        • -
      - - - -
      • -

        setY

        -
        public void setY(double y)
        +
        +

        setY

        +
        public void setY​(double y)
        +
        • -
      - - - -
      • -

        getWidth

        -
        public double getWidth()
        +
        +

        getWidth

        +
        public double getWidth()
        +
        • -
      - - - -
      • -

        setWidth

        -
        public void setWidth(double width)
        +
        +

        setWidth

        +
        public void setWidth​(double width)
        +
        • -
      - - - -
      • -

        getHeight

        -
        public double getHeight()
        +
        +

        getHeight

        +
        public double getHeight()
        +
        • -
      - - - -
      • -

        setHeight

        -
        public void setHeight(double heigh)
        +
        +

        setHeight

        +
        public void setHeight​(double heigh)
        +
        • -
      - - - -
      • -

        getText

        -
        public java.lang.String getText()
        +
        +

        getText

        +
        public java.lang.String getText()
        +
        • -
      - - - -
      • -

        setText

        -
        public void setText(java.lang.String text)
        +
        +

        setText

        +
        public void setText​(java.lang.String text)
        +
        • -
      - - - -
      • -

        getPageNumber

        -
        public int getPageNumber()
        +
        +

        getPageNumber

        +
        public int getPageNumber()
        +
        • -
      - - - -
      • -

        setPageNumber

        -
        public void setPageNumber(int pageNumber)
        +
        +

        setPageNumber

        +
        public void setPageNumber​(int pageNumber)
        +
        • -
      - - - -
      • -

        getItem

        -
        public nuix.Item getItem()
        +
        +

        getItem

        +
        public nuix.Item getItem()
        +
        • -
      - - - -
      • -

        setItem

        -
        public void setItem(nuix.Item item)
        +
        +

        setItem

        +
        public void setItem​(nuix.Item item)
        +
        • -
      - - - -
      • -

        getAsposeSourcePageRectangle

        -
        public com.aspose.pdf.Rectangle getAsposeSourcePageRectangle()
        +
        +

        getAsposeSourcePageRectangle

        +
        public com.aspose.pdf.Rectangle getAsposeSourcePageRectangle()
        +
        • -
      - - - -
      • -

        setAsposeSourcePageRectangle

        -
        public void setAsposeSourcePageRectangle(com.aspose.pdf.Rectangle asposeSourcePageRectangle)
        +
        +

        setAsposeSourcePageRectangle

        +
        public void setAsposeSourcePageRectangle​(com.aspose.pdf.Rectangle asposeSourcePageRectangle)
        +
        • -
      - - - -
      • -

        applyRedaction

        -
        public void applyRedaction(nuix.MarkupSet markupSet)
-                    throws java.lang.Exception
        +
        +

        applyRedaction

        +
        public void applyRedaction​(nuix.MarkupSet markupSet) + throws java.lang.Exception
        Applies a redaction based on the region defined by this instance.
        Parameters:
        @@ -423,16 +385,13 @@

        applyRedaction

        Throws:
        java.lang.Exception - If something goes wrong
        +
        • -
      - - - -
      • -

        applyHighlight

        -
        public void applyHighlight(nuix.MarkupSet markupSet)
-                    throws java.lang.Exception
        +
        +

        applyHighlight

        +
        public void applyHighlight​(nuix.MarkupSet markupSet) + throws java.lang.Exception
        Applies a highlight based on the region defined by this instance.
        Parameters:
        @@ -440,38 +399,38 @@

        applyHighlight

        Throws:
        java.lang.Exception - If something goes wrong
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/ProductionSetEvent.html b/docs/com/nuix/superutilities/annotations/ProductionSetEvent.html index 3b1eafb..02494f9 100644 --- a/docs/com/nuix/superutilities/annotations/ProductionSetEvent.html +++ b/docs/com/nuix/superutilities/annotations/ProductionSetEvent.html @@ -1,42 +1,48 @@ - + ProductionSetEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class ProductionSetEvent

+
Package com.nuix.superutilities.annotations
+

Class ProductionSetEvent

- -
- -
-
+extends AnnotationEvent + +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          ProductionSetEvent

          -
          public ProductionSetEvent()
          +
          +

          ProductionSetEvent

          +
          public ProductionSetEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/TagEvent.html b/docs/com/nuix/superutilities/annotations/TagEvent.html index a5ba51e..b15b9b8 100644 --- a/docs/com/nuix/superutilities/annotations/TagEvent.html +++ b/docs/com/nuix/superutilities/annotations/TagEvent.html @@ -1,42 +1,48 @@ - + TagEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
+ +
+
-
com.nuix.superutilities.annotations
-

Class TagEvent

+
Package com.nuix.superutilities.annotations
+

Class TagEvent

- -
- -
-
+extends AnnotationEvent + +
    -
  • -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      TagEvent() TagEvent() 
      +
+ - -
+
+
+

Methods inherited from class com.nuix.superutilities.annotations.AnnotationEvent

+ - +getAssociatedItems, getExpectedItemCount, getSourceRepo, getTimeStamp
+

Methods inherited from class java.lang.Object

-equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ -
-
+ +
    -
  • -
      -
    • - - -

      Constructor Detail

      - +
    • +
      -
        +

        Constructor Details

        +
        • -

          TagEvent

          -
          public TagEvent()
          +
          +

          TagEvent

          +
          public TagEvent()
          +
        +
      • -
    -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        replay

        -
        public void replay(nuix.Case nuixCase)
-            throws java.lang.Exception
        +
        +

        replay

        +
        public void replay​(nuix.Case nuixCase) + throws java.lang.Exception
        Specified by:
        -
        replay in class AnnotationEvent
        +
        replay in class AnnotationEvent
        Throws:
        java.lang.Exception
        +
        • -
      - - - -
      • -

        getTag

        -
        public java.lang.String getTag()
        +
        +

        getTag

        +
        public java.lang.String getTag()
        +
        • -
      - - - -
      • -

        getAdded

        -
        public java.lang.Boolean getAdded()
        +
        +

        getAdded

        +
        public java.lang.Boolean getAdded()
        +
        • -
      - - - -
      • -

        toString

        -
        public java.lang.String toString()
        +
        +

        toString

        +
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        +
      +
    -
    • -
-
+ + + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationEvent.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationEvent.html index 2289081..115984e 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationEvent

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepository.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepository.html index 6462680..700286f 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepository.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepository.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationHistoryRepository + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationHistoryRepository

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationHistoryRepository

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepositorySummary.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepositorySummary.html index cbf7130..8caa703 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepositorySummary.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationHistoryRepositorySummary.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationMatchingMethod.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationMatchingMethod.html index 92dac33..e09c739 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationMatchingMethod.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationMatchingMethod.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationMatchingMethod + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationMatchingMethod

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationMatchingMethod

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationRepository.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationRepository.html index 6320415..1ff8d02 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationRepository.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationRepository.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationRepository + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationRepository

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationRepository

No usage of com.nuix.superutilities.annotations.AnnotationRepository
+
+ +
+
diff --git a/docs/com/nuix/superutilities/annotations/class-use/AnnotationSyncSettings.html b/docs/com/nuix/superutilities/annotations/class-use/AnnotationSyncSettings.html index 3bc59a1..b689c86 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/AnnotationSyncSettings.html +++ b/docs/com/nuix/superutilities/annotations/class-use/AnnotationSyncSettings.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.AnnotationSyncSettings + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.AnnotationSyncSettings

+

Uses of Class
com.nuix.superutilities.annotations.AnnotationSyncSettings

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactor.html b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactor.html index f8aa414..68f0820 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactor.html +++ b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactor.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.BulkRedactor + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.BulkRedactor

+

Uses of Class
com.nuix.superutilities.annotations.BulkRedactor

No usage of com.nuix.superutilities.annotations.BulkRedactor
+
+ +
+
diff --git a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorProgressInfo.html b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorProgressInfo.html index 7e9a434..3b9e118 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorProgressInfo.html +++ b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorProgressInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.BulkRedactorProgressInfo + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.BulkRedactorProgressInfo

+

Uses of Class
com.nuix.superutilities.annotations.BulkRedactorProgressInfo

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorSettings.html b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorSettings.html index f4740a0..dd386a0 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorSettings.html +++ b/docs/com/nuix/superutilities/annotations/class-use/BulkRedactorSettings.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.BulkRedactorSettings + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.BulkRedactorSettings

+

Uses of Class
com.nuix.superutilities.annotations.BulkRedactorSettings

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/CustodianEvent.html b/docs/com/nuix/superutilities/annotations/class-use/CustodianEvent.html index 16c977d..ac86da6 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/CustodianEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/CustodianEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.CustodianEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.CustodianEvent

+

Uses of Class
com.nuix.superutilities.annotations.CustodianEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/CustomMetadataEvent.html b/docs/com/nuix/superutilities/annotations/class-use/CustomMetadataEvent.html index 70bfbf6..794bc5e 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/CustomMetadataEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/CustomMetadataEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.CustomMetadataEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.CustomMetadataEvent

+

Uses of Class
com.nuix.superutilities.annotations.CustomMetadataEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/ExclusionEvent.html b/docs/com/nuix/superutilities/annotations/class-use/ExclusionEvent.html index 42078c3..2244ad2 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/ExclusionEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/ExclusionEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.ExclusionEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.ExclusionEvent

+

Uses of Class
com.nuix.superutilities.annotations.ExclusionEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/ItemSetEvent.html b/docs/com/nuix/superutilities/annotations/class-use/ItemSetEvent.html index 55b539a..914f191 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/ItemSetEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/ItemSetEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.ItemSetEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.ItemSetEvent

+

Uses of Class
com.nuix.superutilities.annotations.ItemSetEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/NuixImageAnnotationRegion.html b/docs/com/nuix/superutilities/annotations/class-use/NuixImageAnnotationRegion.html index 82fd35a..ef8c375 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/NuixImageAnnotationRegion.html +++ b/docs/com/nuix/superutilities/annotations/class-use/NuixImageAnnotationRegion.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.NuixImageAnnotationRegion + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.NuixImageAnnotationRegion

+

Uses of Class
com.nuix.superutilities.annotations.NuixImageAnnotationRegion

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/ProductionSetEvent.html b/docs/com/nuix/superutilities/annotations/class-use/ProductionSetEvent.html index 61072c4..7797080 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/ProductionSetEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/ProductionSetEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.ProductionSetEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.ProductionSetEvent

+

Uses of Class
com.nuix.superutilities.annotations.ProductionSetEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/class-use/TagEvent.html b/docs/com/nuix/superutilities/annotations/class-use/TagEvent.html index 8f3c47f..514caaa 100644 --- a/docs/com/nuix/superutilities/annotations/class-use/TagEvent.html +++ b/docs/com/nuix/superutilities/annotations/class-use/TagEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.annotations.TagEvent + + + + + + + + + - - + + +
+ +
+
-

Uses of Class
com.nuix.superutilities.annotations.TagEvent

+

Uses of Class
com.nuix.superutilities.annotations.TagEvent

-
+
+ - - +
+ + + + diff --git a/docs/com/nuix/superutilities/annotations/package-summary.html b/docs/com/nuix/superutilities/annotations/package-summary.html index b1b7660..30895fd 100644 --- a/docs/com/nuix/superutilities/annotations/package-summary.html +++ b/docs/com/nuix/superutilities/annotations/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.annotations + + + + + + + + + - - + + +
+ +
+

Package com.nuix.superutilities.annotations

+
  • - +
    +
    + + - +
    Enum Summary 
    Enum Description
    AnnotationMatchingMethodAnnotationMatchingMethod  
    +
    • +
    + + + + diff --git a/docs/com/nuix/superutilities/annotations/package-tree.html b/docs/com/nuix/superutilities/annotations/package-tree.html index 53ceba2..0880aef 100644 --- a/docs/com/nuix/superutilities/annotations/package-tree.html +++ b/docs/com/nuix/superutilities/annotations/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.annotations Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.annotations

    Package Hierarchies: @@ -76,58 +68,65 @@

    Hierarchy For Package com.nuix.superutilities.annotations

    +

    Class Hierarchy

    +
    +

    Enum Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/annotations/package-use.html b/docs/com/nuix/superutilities/annotations/package-use.html index 04523ec..fd9fd7a 100644 --- a/docs/com/nuix/superutilities/annotations/package-use.html +++ b/docs/com/nuix/superutilities/annotations/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.annotations + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.annotations

    -
    +
    +
    + +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/BulkCaseProcessor.html b/docs/com/nuix/superutilities/cases/BulkCaseProcessor.html index ab3744a..8230bdd 100644 --- a/docs/com/nuix/superutilities/cases/BulkCaseProcessor.html +++ b/docs/com/nuix/superutilities/cases/BulkCaseProcessor.html @@ -1,42 +1,48 @@ - + BulkCaseProcessor + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class BulkCaseProcessor

    +
    Package com.nuix.superutilities.cases
    +

    Class BulkCaseProcessor

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.BulkCaseProcessor
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.BulkCaseProcessor
      +
      +
      -
      public class BulkCaseProcessor
 extends java.lang.Object
      This class assists with iteratively doing some form of work in multiple cases. @@ -121,203 +105,212 @@

      Class BulkCaseProcessor

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            BulkCaseProcessor

            -
            public BulkCaseProcessor()
            +
            +

            BulkCaseProcessor

            +
            public BulkCaseProcessor()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          addCaseDirectory

          -
          public void addCaseDirectory(java.io.File caseDirectory)
          +
          +

          addCaseDirectory

          +
          public void addCaseDirectory​(java.io.File caseDirectory)
          Adds a case directory to be iterated.
          Parameters:
          caseDirectory - An additional case directory to be iterated.
          +
          • -
        - - - -
        • -

          addCaseDirectory

          -
          public void addCaseDirectory(java.lang.String caseDirectoryPath)
          +
          +

          addCaseDirectory

          +
          public void addCaseDirectory​(java.lang.String caseDirectoryPath)
          Adds a case directory to be iterated.
          Parameters:
          caseDirectoryPath - An additional case directory to be iterated.
          +
          • -
        - - - -
        • -

          signalAbort

          -
          public void signalAbort()
          +
          +

          signalAbort

          +
          public void signalAbort()
          Signals that no further processing should be performed after current case.
          +
          • -
        - - - -
        • -

          withEachCase

          -
          public void withEachCase(CaseConsumer caseWorkFunction)
          +
          +

          withEachCase

          +
          public void withEachCase​(CaseConsumer caseWorkFunction)
          Begins iterating provided list of cases, passing the following information for each case to the provided callback:
          - The case object
          - Information about the case
          @@ -327,22 +320,19 @@

          withEachCase

          Parameters:
          caseWorkFunction - Callback which does something with each case.
          +
          • -
        - - - -
        • -

          withEachCase

          -
          public void withEachCase(nuix.Case currentCaseFromGui,
-                         CaseConsumer caseWorkFunction)
          +
          +

          withEachCase

          +
          public void withEachCase​(nuix.Case currentCaseFromGui, +CaseConsumer caseWorkFunction)
          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 withEachCase(CaseConsumer) in that you provide the currently open case in the GUI + This method differs from withEachCase(CaseConsumer) in that you provide the currently open case in the GUI (in Ruby this would usually be $current_case). If the case open in the GUI matches a case from the list of cases to be processed, this method will hand the callback the already open case object rather than trying to open the case a second time, which would result in an error.
          @@ -351,111 +341,96 @@

          withEachCase

          currentCaseFromGui - Case currently open in the GUI, in Ruby scripts this is usually $current_case
          caseWorkFunction - Callback which does something with each open case.
          +
          • -
        - - - -
        • -

          onCaseIsLocked

          -
          public void onCaseIsLocked(java.util.function.Consumer<CaseLockedEventInfo> callback)
          +
          +

          onCaseIsLocked

          +
          public void onCaseIsLocked​(java.util.function.Consumer<CaseLockedEventInfo> callback)
          Optional callback which is called when a case is found to be locked in another session of Nuix while being opened. - Callback is provided instance of CaseLockInfo with information about who is locking that case.
          + Callback is provided instance of CaseLockInfo with information about who is locking that case.
    Parameters:
    callback - Callback to handle when a case is locked.
    + - - - - -
    • -

      onErrorOpeningCase

      -
      public void onErrorOpeningCase(java.util.function.Consumer<CaseOpenErrorEvent> callback)
      +
      +

      onErrorOpeningCase

      +
      public void onErrorOpeningCase​(java.util.function.Consumer<CaseOpenErrorEvent> callback)
      Optional callback which is called when opening a case has an error.
      Parameters:
      callback - Callback to handle when opening a case throws an error.
      +
      • -
    - - - - - - - -
    • -

      beforeOpeningCase

      -
      public void beforeOpeningCase(java.util.function.Consumer<CaseInfo> callback)
      +
      +

      beforeOpeningCase

      +
      public void beforeOpeningCase​(java.util.function.Consumer<CaseInfo> callback)
      Optional callback which is called before opening each case.
      Parameters:
      callback - The callback to invoke before opening each case
      +
      • -
    - - - -
    • -

      getAllowCaseMigration

      -
      public boolean getAllowCaseMigration()
      +
      +

      getAllowCaseMigration

      +
      public boolean getAllowCaseMigration()
      Gets whether Nuix will be allowed to migrate cases as they are opened.
      Returns:
      True if Nuix will be allowed to migrate cases as they are opened.
      +
      • -
    - - - -
    • -

      setAllowCaseMigration

      -
      public void setAllowCaseMigration(boolean allowCaseMigration)
      +
      +

      setAllowCaseMigration

      +
      public void setAllowCaseMigration​(boolean allowCaseMigration)
      Sets whether Nuix will be allowed to migrate cases as they are opened.
      Parameters:
      allowCaseMigration - True if Nuix will be allowed to migrate cases as they are opened.
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseConsumer.html b/docs/com/nuix/superutilities/cases/CaseConsumer.html index 98c84da..d8f0824 100644 --- a/docs/com/nuix/superutilities/cases/CaseConsumer.html +++ b/docs/com/nuix/superutilities/cases/CaseConsumer.html @@ -1,42 +1,48 @@ - + CaseConsumer + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Interface CaseConsumer

    +
    Package com.nuix.superutilities.cases
    +

    Interface CaseConsumer

    -
    -
      -
    • +
      -
      public interface CaseConsumer
      -
      Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
      +
      Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Method Summary

        - - +

        Method Summary

        +
        +
        +
        +
        All Methods Instance Methods Abstract Methods 
        + - + + - + + + - + + +
        Modifier and TypeMethod and DescriptionMethodDescription
        java.lang.BooleanacceptCase(nuix.Case nuixCase, - CaseInfo caseInfo, - int currentCaseIndex, - int totalCases) acceptCase​(nuix.Case nuixCase, +CaseInfo caseInfo, +int currentCaseIndex, +int totalCases) 
        +
    +
    + - - -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            acceptCase

            -
            java.lang.Boolean acceptCase(nuix.Case nuixCase,
-                             CaseInfo caseInfo,
-                             int currentCaseIndex,
-                             int totalCases)
            +
            +

            acceptCase

            +
            java.lang.Boolean acceptCase​(nuix.Case nuixCase, +CaseInfo caseInfo, +int currentCaseIndex, +int totalCases)
            +
          +
      -
      • -
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseHistoryHelper.html b/docs/com/nuix/superutilities/cases/CaseHistoryHelper.html index df3d401..a17416c 100644 --- a/docs/com/nuix/superutilities/cases/CaseHistoryHelper.html +++ b/docs/com/nuix/superutilities/cases/CaseHistoryHelper.html @@ -1,42 +1,48 @@ - + CaseHistoryHelper + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseHistoryHelper

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseHistoryHelper

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseHistoryHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseHistoryHelper
      +
      +
      All Implemented Interfaces:
      -
      java.util.Iterator<nuix.HistoryEvent>
      +
      java.util.Iterator<nuix.HistoryEvent>
      -
      public class CaseHistoryHelper
 extends java.lang.Object
 implements java.util.Iterator<nuix.HistoryEvent>
      @@ -122,152 +106,155 @@

      Class CaseHistoryHelper

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        CaseHistoryHelper(nuix.Case nuixCase, - java.util.List<java.lang.String> eventTypes, - org.joda.time.DateTime minStart, - org.joda.time.DateTime maxStart) CaseHistoryHelper​(nuix.Case nuixCase, +java.util.List<java.lang.String> eventTypes, +org.joda.time.DateTime minStart, +org.joda.time.DateTime maxStart) 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - -
      -
    • + - +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +

    Methods inherited from interface java.util.Iterator

    -forEachRemaining, remove - - - + + +forEachRemaining, remove
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            CaseHistoryHelper

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

            CaseHistoryHelper

            +
            public CaseHistoryHelper​(nuix.Case nuixCase, +java.util.List<java.lang.String> eventTypes, +org.joda.time.DateTime minStart, +org.joda.time.DateTime maxStart) + throws java.lang.Exception
            Throws:
            java.lang.Exception
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          hasNext

          -
          public boolean hasNext()
          +
          +

          hasNext

          +
          public boolean hasNext()
          Specified by:
          hasNext in interface java.util.Iterator<nuix.HistoryEvent>
          +
          • -
        - - - -
        • -

          next

          -
          public nuix.HistoryEvent next()
          +
          +

          next

          +
          public nuix.HistoryEvent next()
          Specified by:
          next in interface java.util.Iterator<nuix.HistoryEvent>
          +
          • -
        - - - -
        • -

          getEarliestEventStart

          -
          public static org.joda.time.DateTime getEarliestEventStart(nuix.Case nuixCase)
-                                                    throws java.lang.Exception
          +
          +

          getEarliestEventStart

          +
          public static org.joda.time.DateTime getEarliestEventStart​(nuix.Case nuixCase) + throws java.lang.Exception
          Convenience method for obtaining earliest case history event.
          Parameters:
          @@ -277,16 +264,13 @@

          getEarliestEventStart

          Throws:
          java.lang.Exception - Thrown if an error occurs
          +
          • -
        - - - -
        • -

          getLatestEventStart

          -
          public static org.joda.time.DateTime getLatestEventStart(nuix.Case nuixCase)
-                                                  throws java.lang.Exception
          +
          +

          getLatestEventStart

          +
          public static org.joda.time.DateTime getLatestEventStart​(nuix.Case nuixCase) + throws java.lang.Exception
          Convenience method for obtaining most recent case history event.
          Parameters:
          @@ -296,25 +280,28 @@

          getLatestEventStart

          Throws:
          java.lang.Exception - Thrown if an error occurs
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseInfo.html b/docs/com/nuix/superutilities/cases/CaseInfo.html index 46e64a1..ede8807 100644 --- a/docs/com/nuix/superutilities/cases/CaseInfo.html +++ b/docs/com/nuix/superutilities/cases/CaseInfo.html @@ -1,42 +1,48 @@ - + CaseInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseInfo

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseInfo
      +
      +
      -
      public class CaseInfo
 extends java.lang.Object
      Represents some information which can be determined about a Nuix case directory without having @@ -117,564 +101,537 @@

      Class CaseInfo

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        CaseInfo(java.io.File caseDirectory) +CaseInfo​(java.io.File caseDirectory)
        Creates a new instance associated to the specified case directory.
        CaseInfo(java.lang.String caseDirectoryPath) +CaseInfo​(java.lang.String caseDirectoryPath)
        Creates a new instance associated to the specified case directory.
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -getClass, notify, notifyAll, wait, wait, wait - - - + + +getClass, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          CaseInfo

          -
          public CaseInfo(java.io.File caseDirectory)
          +
          +

          CaseInfo

          +
          public CaseInfo​(java.io.File caseDirectory)
          Creates a new instance associated to the specified case directory.
          Parameters:
          caseDirectory - Case directory to collect information on.
          +
          • -
        - - - -
        • -

          CaseInfo

          -
          public CaseInfo(java.lang.String caseDirectoryPath)
          +
          +

          CaseInfo

          +
          public CaseInfo​(java.lang.String caseDirectoryPath)
          Creates a new instance associated to the specified case directory.
          Parameters:
          caseDirectoryPath - Case directory to collect information on.
          +
        +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getCaseDirectory

          -
          public java.io.File getCaseDirectory()
          +
          +

          getCaseDirectory

          +
          public java.io.File getCaseDirectory()
          Gets case directory associated with this instance.
          Returns:
          The case directory associated with this instance as File object.
          +
          • -
        - - - -
        • -

          getCaseDirectoryPath

          -
          public java.lang.String getCaseDirectoryPath()
          +
          +

          getCaseDirectoryPath

          +
          public java.lang.String getCaseDirectoryPath()
          Gets case directory associated with this instance.
          Returns:
          The case directory associated with this instance as a String.
          +
          • -
        - - - -
        • -

          getFbi2File

          -
          public java.io.File getFbi2File()
          +
          +

          getFbi2File

          +
          public java.io.File getFbi2File()
          Gets file path of FBI2 file associated with this instance.
          Returns:
          The file path of the FBI2 file associated with this instance as File object.
          +
          • -
        - - - -
        • -

          getFbi2FilePath

          -
          public java.lang.String getFbi2FilePath()
          +
          +

          getFbi2FilePath

          +
          public java.lang.String getFbi2FilePath()
          Gets file path of FBI2 file associated with this instance.
          Returns:
          The file path of the FBI2 file associated with this instance as a String.
          +
          • -
        - - - -
        • -

          isCompound

          -
          public boolean isCompound()
          +
          +

          isCompound

          +
          public boolean isCompound()
          Whether this case has been determined to be a compound case
          Returns:
          True if this case has been determined to be compound.
          +
          • -
        - - - -
        • -

          getStoreCount

          -
          public int getStoreCount()
          +
          +

          getStoreCount

          +
          public int getStoreCount()
          Store count of this case.
          Returns:
          Determined store count of this case.
          +
          • -
        - - - -
        • -

          getName

          -
          public java.lang.String getName()
          +
          +

          getName

          +
          public java.lang.String getName()
          The name of this case.
          Returns:
          The name of this case.
          +
          • -
        - - - -
        • -

          getGuid

          -
          public java.lang.String getGuid()
          +
          +

          getGuid

          +
          public java.lang.String getGuid()
          The case GUID of this case.
          Returns:
          The case GUID.
          +
          • -
        - - - -
        • -

          getCreationDateTime

          -
          public org.joda.time.DateTime getCreationDateTime()
          +
          +

          getCreationDateTime

          +
          public org.joda.time.DateTime getCreationDateTime()
          The case creation date time.
          Returns:
          The case creation date time.
          +
          • -
        - - - -
        • -

          getCreationDateTimeString

          -
          public java.lang.String getCreationDateTimeString()
          +
          +

          getCreationDateTimeString

          +
          public java.lang.String getCreationDateTimeString()
          The case creation date time as a String.
          Returns:
          The case creation date time as a String.
          +
          • -
        - - - -
        • -

          getAccessedDateTime

          -
          public org.joda.time.DateTime getAccessedDateTime()
          +
          +

          getAccessedDateTime

          +
          public org.joda.time.DateTime getAccessedDateTime()
          The case last accessed date time.
          Returns:
          The case last accessed date time.
          +
          • -
        - - - -
        • -

          getAccessedDateTimeString

          -
          public java.lang.String getAccessedDateTimeString()
          +
          +

          getAccessedDateTimeString

          +
          public java.lang.String getAccessedDateTimeString()
          The case last accessed date time as a String.
          Returns:
          The case last accessed date time as a String.
          +
          • -
        - - - -
        • -

          getInvestigator

          -
          public java.lang.String getInvestigator()
          +
          +

          getInvestigator

          +
          public java.lang.String getInvestigator()
          The investigator value.
          Returns:
          The investigator value.
          +
          • -
        - - - -
        • -

          getSavedByName

          -
          public java.lang.String getSavedByName()
          +
          +

          getSavedByName

          +
          public java.lang.String getSavedByName()
          The saved by name.
          Returns:
          The saved by name.
          +
          • -
        - - - -
        • -

          getSavedByVersion

          -
          public java.lang.String getSavedByVersion()
          +
          +

          getSavedByVersion

          +
          public java.lang.String getSavedByVersion()
          The saved by version.
          Returns:
          The saved by version.
          +
          • -
        - - - -
        • -

          getChildCases

          -
          public java.util.List<CaseInfo> getChildCases()
          +
          +

          getChildCases

          +
          public java.util.List<CaseInfo> getChildCases()
          A list of CaseInfo objects representing child cases if this is a compound case.
          Returns:
          A list of CaseInfo objects representing child cases if this is a compound case.
          +
          • -
        - - - -
        • -

          getChildCaseCount

          -
          public int getChildCaseCount()
          +
          +

          getChildCaseCount

          +
          public int getChildCaseCount()
          Count of child cases if this is a compound case.
          Returns:
          Count of child cases if this is a compound case.
          +
          • -
        - - - -
        • -

          caseExists

          -
          public boolean caseExists()
          +
          +

          caseExists

          +
          public boolean caseExists()
          Whether a case was determined to exist in the directory specified, as determined by presence of FBI2 file in directory.
          Returns:
          True if case was determined to exist in the directory specified when this instance was created.
          +
          • -
        - - - -
        • -

          isLocked

          -
          public boolean isLocked()
          +
          +

          isLocked

          +
          public boolean isLocked()
          Whether this case was determined to be locked, as determined by the presence of a case.lock file in the specified case directory.
          Returns:
          True is case has been determined to be locked.
          +
          • -
        - - - -
        • -

          getLockProperties

          -
          public CaseLockInfo getLockProperties()
          +
          +

          getLockProperties

          +
          public CaseLockInfo getLockProperties()
          If case is determined to be locked, gets information about who is currently locking the case.
          Returns:
          A CaseLockInfo object with information about who is locking the case, if the case is locked.
          +
          • -
        - - - -
        • -

          withCase

          -
          public void withCase(boolean allowMigration,
-                     java.util.function.Consumer<nuix.Case> caseConsumer)
-              throws java.lang.Exception
          +
          +

          withCase

          +
          public void withCase​(boolean allowMigration, +java.util.function.Consumer<nuix.Case> caseConsumer) + throws java.lang.Exception
          Opens case and passes it to specified callback.
          Parameters:
          @@ -683,17 +640,14 @@

          withCase

          Throws:
          java.lang.Exception - Thrown if there is an error.
          +
          • -
        - - - -
        • -

          withCase

          -
          public void withCase(java.util.function.Consumer<nuix.Case> caseConsumer)
-              throws java.lang.Exception
          -
          Opens case and passes it to specified callback. This differs from withCase(boolean, Consumer) in that +
          +

          withCase

          +
          public void withCase​(java.util.function.Consumer<nuix.Case> caseConsumer) + throws java.lang.Exception
          +
          Opens case and passes it to specified callback. This differs from withCase(boolean, Consumer) in that this version implictly does not allow Nuix to migrate the case.
          Parameters:
          @@ -701,15 +655,12 @@

          withCase

          Throws:
          java.lang.Exception - Thrown if there is an error.
          +
          • -
        - - - -
        • -

          hasSameGuidAs

          -
          public boolean hasSameGuidAs(nuix.Case nuixCase)
          +
          +

          hasSameGuidAs

          +
          public boolean hasSameGuidAs​(nuix.Case nuixCase)
          Determines whether a Nuix case object shares the same GUID as this CaseInfo object.
          Parameters:
          @@ -717,15 +668,12 @@

          hasSameGuidAs

          Returns:
          True if this CaseInfo and the provided Case object are found to have the same GUID.
          +
          • -
        - - - -
        • -

          fromCasePaths

          -
          public static java.util.List<CaseInfo> fromCasePaths(java.util.List<java.lang.String> paths)
          +
          +

          fromCasePaths

          +
          public static java.util.List<CaseInfo> fromCasePaths​(java.util.List<java.lang.String> paths)
          Given a list of case paths (specified as Strings) creates a series of CaseInfo objects.
          Parameters:
          @@ -733,15 +681,12 @@

          fromCasePaths

          Returns:
          List of CaseInfo objects for the list of case directories.
          +
          • -
        - - - -
        • -

          fromCaseDirectories

          -
          public static java.util.List<CaseInfo> fromCaseDirectories(java.util.List<java.io.File> directories)
          +
          +

          fromCaseDirectories

          +
          public static java.util.List<CaseInfo> fromCaseDirectories​(java.util.List<java.io.File> directories)
          Given a list of case paths (specified as File objects) creates a series of CaseInfo objects.
          Parameters:
          @@ -749,65 +694,59 @@

          fromCaseDirectories

          Returns:
          List of CaseInfo objects for the list of case directories.
          +
          • -
        - - - -
        • -

          toString

          -
          public java.lang.String toString()
          +
          +

          toString

          +
          public java.lang.String toString()
          Creates a user friendly String "dump" of information contained in this CaseInfo instance.
          Overrides:
          toString in class java.lang.Object
          +
          • -
        - - - -
        • -

          hashCode

          -
          public int hashCode()
          +
          +

          hashCode

          +
          public int hashCode()
          Overrides:
          hashCode in class java.lang.Object
          +
          • -
        - - - -
        • -

          equals

          -
          public boolean equals(java.lang.Object obj)
          +
          +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          Overrides:
          equals in class java.lang.Object
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseIssueReaction.html b/docs/com/nuix/superutilities/cases/CaseIssueReaction.html index 1a60837..4af4053 100644 --- a/docs/com/nuix/superutilities/cases/CaseIssueReaction.html +++ b/docs/com/nuix/superutilities/cases/CaseIssueReaction.html @@ -1,42 +1,48 @@ - + CaseIssueReaction + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Enum CaseIssueReaction

    +
    Package com.nuix.superutilities.cases
    +

    Enum CaseIssueReaction

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • java.lang.Enum<CaseIssueReaction>
        • -
      • -
          -
        • com.nuix.superutilities.cases.CaseIssueReaction
          • -
        -
        • -
      -
      • -
    -
    - -
    -
    + +
      +
    • +
      + + +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from class java.lang.Enum

      + + +java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
      +
      +
      • -
        -
      • +
      • +
        -

        Enum Constant Summary

        - +

        Enum Constant Summary

        +
        +
        + - + + + + - + + - + + - + + +
        Enum Constants 
        Enum Constant and DescriptionEnum ConstantDescription
        Abort Abort 
        Retry Retry 
        SkipCase SkipCase 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Enum

    -compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf - -
      -
    • + - +compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +

    Methods inherited from class java.lang.Object

    -getClass, notify, notifyAll, wait, wait, wait - - - + + +getClass, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
    • -

      valueOf

      -
      public static CaseIssueReaction valueOf(java.lang.String name)
      +
      +

      valueOf

      +
      public static CaseIssueReaction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are @@ -283,25 +272,28 @@

      valueOf

      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseLockInfo.html b/docs/com/nuix/superutilities/cases/CaseLockInfo.html index 20b209b..4d50970 100644 --- a/docs/com/nuix/superutilities/cases/CaseLockInfo.html +++ b/docs/com/nuix/superutilities/cases/CaseLockInfo.html @@ -1,42 +1,48 @@ - + CaseLockInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseLockInfo

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseLockInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseLockInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseLockInfo
      +
      +
      -
      public class CaseLockInfo
 extends java.lang.Object
      -
      Represents information parsed from a case lock file. Used by BulkCaseProcessor.
      +
      Represents information parsed from a case lock file. Used by BulkCaseProcessor.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        CaseLockInfo() CaseLockInfo() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            CaseLockInfo

            -
            public CaseLockInfo()
            +
            +

            CaseLockInfo

            +
            public CaseLockInfo()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - - - - - -
        • -

          getUser

          -
          public java.lang.String getUser()
          +
          +

          getUser

          +
          public java.lang.String getUser()
          +
          • -
        - - - -
        • -

          setUser

          -
          public void setUser(java.lang.String user)
          +
          +

          setUser

          +
          public void setUser​(java.lang.String user)
          +
          • -
        - - - -
        • -

          getHost

          -
          public java.lang.String getHost()
          +
          +

          getHost

          +
          public java.lang.String getHost()
          +
          • -
        - - - -
        • -

          setHost

          -
          public void setHost(java.lang.String host)
          +
          +

          setHost

          +
          public void setHost​(java.lang.String host)
          +
          • -
        - - - -
        • -

          getProduct

          -
          public java.lang.String getProduct()
          +
          +

          getProduct

          +
          public java.lang.String getProduct()
          +
          • -
        - - - -
        • -

          setProduct

          -
          public void setProduct(java.lang.String product)
          +
          +

          setProduct

          +
          public void setProduct​(java.lang.String product)
          +
          • -
        - - - -
        • -

          toString

          -
          public java.lang.String toString()
          +
          +

          toString

          +
          public java.lang.String toString()
          Overrides:
          toString in class java.lang.Object
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseLockedEventInfo.html b/docs/com/nuix/superutilities/cases/CaseLockedEventInfo.html index 66ef9c2..21b7d36 100644 --- a/docs/com/nuix/superutilities/cases/CaseLockedEventInfo.html +++ b/docs/com/nuix/superutilities/cases/CaseLockedEventInfo.html @@ -1,42 +1,48 @@ - + CaseLockedEventInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseLockedEventInfo

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseLockedEventInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseLockedEventInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseLockedEventInfo
      +
      +
      -
      public class CaseLockedEventInfo
 extends java.lang.Object
      -
      This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was - locked. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      +
      This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was + locked. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            CaseLockedEventInfo

            -
            public CaseLockedEventInfo(CaseInfo lockedCaseInfo)
            +
            +

            CaseLockedEventInfo

            +
            public CaseLockedEventInfo​(CaseInfo lockedCaseInfo)
            Creates a new instance
            Parameters:
            lockedCaseInfo - Information about the case which was locked
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getCaseInfo

          -
          public CaseInfo getCaseInfo()
          +
          +

          getCaseInfo

          +
          public CaseInfo getCaseInfo()
          Gets information related to case which was locked
          Returns:
          Information related to case which was locked
          +
          • -
        - - - - - - - -
        • -

          setReaction

          -
          public void setReaction(CaseIssueReaction reaction)
          +
          +

          setReaction

          +
          public void setReaction​(CaseIssueReaction reaction)
          Sets the reaction that should be taken to this case being locked
          Parameters:
          reaction - The reaction to take
          +
          • -
        - - - -
        • -

          skipCase

          -
          public void skipCase()
          -
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          +

          skipCase

          +
          public void skipCase()
          +
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          • -
        - - - -
        • -

          retry

          -
          public void retry()
          -
          Notifies BulkCaseProcessor that it should try to open this case again
          +
          +

          retry

          +
          public void retry()
          +
          Notifies BulkCaseProcessor that it should try to open this case again
          +
          • -
        - - - -
        • -

          abort

          -
          public void abort()
          -
          Notifies BulkCaseProcessor that all further processing should be aborted
          -
          • -
        +
        +

        abort

        +
        public void abort()
        +
        Notifies BulkCaseProcessor that all further processing should be aborted
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseOpenErrorEvent.html b/docs/com/nuix/superutilities/cases/CaseOpenErrorEvent.html index e1aa24f..6584b08 100644 --- a/docs/com/nuix/superutilities/cases/CaseOpenErrorEvent.html +++ b/docs/com/nuix/superutilities/cases/CaseOpenErrorEvent.html @@ -1,42 +1,48 @@ - + CaseOpenErrorEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseOpenErrorEvent

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseOpenErrorEvent

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseOpenErrorEvent
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseOpenErrorEvent
      +
      +
      -
      public class CaseOpenErrorEvent
 extends java.lang.Object
      -
      This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had - and error when opened. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      +
      This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had + and error when opened. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        CaseOpenErrorEvent(CaseInfo erroredCaseInfo, - java.lang.Exception caseOpenError) +CaseOpenErrorEvent​(CaseInfo erroredCaseInfo, +java.lang.Exception caseOpenError)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            CaseOpenErrorEvent

            -
            public CaseOpenErrorEvent(CaseInfo erroredCaseInfo,
-                          java.lang.Exception caseOpenError)
            +
            +

            CaseOpenErrorEvent

            +
            public CaseOpenErrorEvent​(CaseInfo erroredCaseInfo, +java.lang.Exception caseOpenError)
            Creates a new instance
            Parameters:
            erroredCaseInfo - Information related to the case which had the error
            caseOpenError - The exception thrown while opening the case
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getCaseInfo

          -
          public CaseInfo getCaseInfo()
          +
          +

          getCaseInfo

          +
          public CaseInfo getCaseInfo()
          Gets information related to case which was locked
          Returns:
          Information related to case which was locked
          +
          • -
        - - - - - - - -
        • -

          setReaction

          -
          public void setReaction(CaseIssueReaction reaction)
          +
          +

          setReaction

          +
          public void setReaction​(CaseIssueReaction reaction)
          Sets the reaction that should be taken
          Parameters:
          reaction - The reaction to take
          +
          • -
        - - - -
        • -

          getError

          -
          public java.lang.Exception getError()
          +
          +

          getError

          +
          public java.lang.Exception getError()
          Gets the exception which was thrown
          Returns:
          The exception thrown
          +
          • -
        - - - -
        • -

          skipCase

          -
          public void skipCase()
          -
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          +

          skipCase

          +
          public void skipCase()
          +
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          • -
        - - - -
        • -

          retry

          -
          public void retry()
          -
          Notifies BulkCaseProcessor that it should try to open this case again
          +
          +

          retry

          +
          public void retry()
          +
          Notifies BulkCaseProcessor that it should try to open this case again
          +
          • -
        - - - -
        • -

          abort

          -
          public void abort()
          -
          Notifies BulkCaseProcessor that all further processing should be aborted
          +
          +

          abort

          +
          public void abort()
          +
          Notifies BulkCaseProcessor that all further processing should be aborted
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/CaseUtility.html b/docs/com/nuix/superutilities/cases/CaseUtility.html index e7132b1..c16e1e8 100644 --- a/docs/com/nuix/superutilities/cases/CaseUtility.html +++ b/docs/com/nuix/superutilities/cases/CaseUtility.html @@ -1,42 +1,48 @@ - + CaseUtility + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class CaseUtility

    +
    Package com.nuix.superutilities.cases
    +

    Class CaseUtility

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.CaseUtility
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.CaseUtility
      +
      +
      -
      public class CaseUtility
 extends java.lang.Object
      Class which provides some additional functionality regarding Nuix cases, mainly finding cases @@ -116,122 +100,128 @@

      Class CaseUtility

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Method Summary

        - - +

        Method Summary

        +
        +
        +
        +
        All Methods Static Methods Instance Methods Concrete Methods 
        + - + + - + + + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - - - + + + - - - + + + + +
        Modifier and TypeMethod and DescriptionMethodDescription
        voidarchiveCase(java.io.File nuixCaseDirectory, - java.io.File archiveFile, - boolean deleteCaseOnCompletion, - int compressionLevel) +archiveCase​(java.io.File nuixCaseDirectory, +java.io.File archiveFile, +boolean deleteCaseOnCompletion, +int compressionLevel)
        Archives a Nuix case into a Zip file, optionally deleting the case once completed.
        voidarchiveCase(java.lang.String nuixCaseDirectory, - java.lang.String archiveFile, - boolean deleteCaseOnCompletion, - int compressionLevel) +archiveCase​(java.lang.String nuixCaseDirectory, +java.lang.String archiveFile, +boolean deleteCaseOnCompletion, +int compressionLevel)
        Archives a Nuix case into a Zip file, optionally deleting the case once completed.
        java.util.Collection<java.io.File>findCaseDirectories(java.io.File rootSearchDirectory) +findCaseDirectories​(java.io.File rootSearchDirectory)
        Searches for case directories in a given directory and sub-directories.
        java.util.Collection<java.io.File>findCaseDirectories(java.lang.String rootSearchPath) +findCaseDirectories​(java.lang.String rootSearchPath)
        Searches for case directories in a given directory and sub-directories.
        java.util.Collection<java.lang.String>findCaseDirectoryPaths(java.io.File rootSearchDirectory) +findCaseDirectoryPaths​(java.io.File rootSearchDirectory)
        Searches for case directories in a given directory and sub-directories.
        java.util.Collection<java.lang.String>findCaseDirectoryPaths(java.lang.String rootSearchPath) +findCaseDirectoryPaths​(java.lang.String rootSearchPath)
        Searches for case directories in a given directory and sub-directories.
        java.util.List<CaseInfo>findCaseInformation(java.io.File rootSearchDirectory) -
        Scans specified root directory and sub-directories for cases, returning CaseInfo objects +
        java.util.List<CaseInfo>findCaseInformation​(java.io.File rootSearchDirectory) +
        Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
        java.util.List<CaseInfo>findCaseInformation(java.lang.String rootSearchPath) -
        Scans specified root directory and sub-directories for cases, returning CaseInfo objects +
        java.util.List<CaseInfo>findCaseInformation​(java.lang.String rootSearchPath) +
        Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
        static CaseUtilitygetInstance() 
        static CaseUtilitygetInstance() 
        -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - -
        • -

          findCaseDirectories

          -
          public java.util.Collection<java.io.File> findCaseDirectories(java.io.File rootSearchDirectory)
          +
          +

          findCaseDirectories

          +
          public java.util.Collection<java.io.File> findCaseDirectories​(java.io.File rootSearchDirectory)
          Searches for case directories in a given directory and sub-directories.
          Parameters:
          @@ -239,15 +229,12 @@

          findCaseDirectories

          Returns:
          A collection of File objects for case directories located.
          +
          • -
        - - - -
        • -

          findCaseDirectories

          -
          public java.util.Collection<java.io.File> findCaseDirectories(java.lang.String rootSearchPath)
          +
          +

          findCaseDirectories

          +
          public java.util.Collection<java.io.File> findCaseDirectories​(java.lang.String rootSearchPath)
          Searches for case directories in a given directory and sub-directories.
          Parameters:
          @@ -255,15 +242,12 @@

          findCaseDirectories

          Returns:
          A collection of File objects for case directories located.
          +
          • -
        - - - -
        • -

          findCaseDirectoryPaths

          -
          public java.util.Collection<java.lang.String> findCaseDirectoryPaths(java.io.File rootSearchDirectory)
          +
          +

          findCaseDirectoryPaths

          +
          public java.util.Collection<java.lang.String> findCaseDirectoryPaths​(java.io.File rootSearchDirectory)
          Searches for case directories in a given directory and sub-directories.
          Parameters:
          @@ -271,15 +255,12 @@

          findCaseDirectoryPaths

          Returns:
          A collection of String representing case directories located.
          +
          • -
        - - - -
        • -

          findCaseDirectoryPaths

          -
          public java.util.Collection<java.lang.String> findCaseDirectoryPaths(java.lang.String rootSearchPath)
          +
          +

          findCaseDirectoryPaths

          +
          public java.util.Collection<java.lang.String> findCaseDirectoryPaths​(java.lang.String rootSearchPath)
          Searches for case directories in a given directory and sub-directories.
          Parameters:
          @@ -287,16 +268,13 @@

          findCaseDirectoryPaths

          Returns:
          A collection of String representing case directories located.
          +
          • -
        - - - -
        • -

          findCaseInformation

          -
          public java.util.List<CaseInfo> findCaseInformation(java.io.File rootSearchDirectory)
          -
          Scans specified root directory and sub-directories for cases, returning CaseInfo objects +
          +

          findCaseInformation

          +
          public java.util.List<CaseInfo> findCaseInformation​(java.io.File rootSearchDirectory)
          +
          Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
          Parameters:
          @@ -304,16 +282,13 @@

          findCaseInformation

          Returns:
          Case info objects for each case found
          +
          • -
        - - - -
        • -

          findCaseInformation

          -
          public java.util.List<CaseInfo> findCaseInformation(java.lang.String rootSearchPath)
          -
          Scans specified root directory and sub-directories for cases, returning CaseInfo objects +
          +

          findCaseInformation

          +
          public java.util.List<CaseInfo> findCaseInformation​(java.lang.String rootSearchPath)
          +
          Scans specified root directory and sub-directories for cases, returning CaseInfo objects for each case located.
          Parameters:
          @@ -321,19 +296,16 @@

          findCaseInformation

          Returns:
          Case info objects for each case found
          +
          • -
        - - - -
        • -

          archiveCase

          -
          public void archiveCase(java.lang.String nuixCaseDirectory,
-                        java.lang.String archiveFile,
-                        boolean deleteCaseOnCompletion,
-                        int compressionLevel)
-                 throws java.io.IOException
          +
          +

          archiveCase

          +
          public void archiveCase​(java.lang.String nuixCaseDirectory, +java.lang.String archiveFile, +boolean deleteCaseOnCompletion, +int compressionLevel) + throws java.io.IOException
          Archives a Nuix case into a Zip file, optionally deleting the case once completed. Based on: https://stackoverflow.com/questions/23318383/compress-directory-into-a-zipfile-with-commons-io
          @@ -346,19 +318,16 @@

          archiveCase

          Throws:
          java.io.IOException - Thrown if there are issues creating the archive or deleting the directory.
          +
          • -
        - - - -
        • -

          archiveCase

          -
          public void archiveCase(java.io.File nuixCaseDirectory,
-                        java.io.File archiveFile,
-                        boolean deleteCaseOnCompletion,
-                        int compressionLevel)
-                 throws java.io.IOException
          +
          +

          archiveCase

          +
          public void archiveCase​(java.io.File nuixCaseDirectory, +java.io.File archiveFile, +boolean deleteCaseOnCompletion, +int compressionLevel) + throws java.io.IOException
          Archives a Nuix case into a Zip file, optionally deleting the case once completed. Based on: https://stackoverflow.com/questions/23318383/compress-directory-into-a-zipfile-with-commons-io
          @@ -371,25 +340,28 @@

          archiveCase

          Throws:
          java.io.IOException - Thrown if there are issues creating the archive or deleting the directory.
          +
        +
      -
      • -
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/WorkFunctionErrorEvent.html b/docs/com/nuix/superutilities/cases/WorkFunctionErrorEvent.html index 83e3ba7..527fd29 100644 --- a/docs/com/nuix/superutilities/cases/WorkFunctionErrorEvent.html +++ b/docs/com/nuix/superutilities/cases/WorkFunctionErrorEvent.html @@ -1,42 +1,48 @@ - + WorkFunctionErrorEvent + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.cases
    -

    Class WorkFunctionErrorEvent

    +
    Package com.nuix.superutilities.cases
    +

    Class WorkFunctionErrorEvent

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.cases.WorkFunctionErrorEvent
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.cases.WorkFunctionErrorEvent
      +
      +
      -
      public class WorkFunctionErrorEvent
 extends java.lang.Object
      -
      This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while - executing code provided in user code. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      +
      This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while + executing code provided in user code. This class also provides a way for that callback to instruct BulkCaseProcessor how to react to this.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        WorkFunctionErrorEvent(CaseInfo erroredCaseInfo, - java.lang.Exception functionError) +WorkFunctionErrorEvent​(CaseInfo erroredCaseInfo, +java.lang.Exception functionError)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            WorkFunctionErrorEvent

            -
            public WorkFunctionErrorEvent(CaseInfo erroredCaseInfo,
-                              java.lang.Exception functionError)
            +
            +

            WorkFunctionErrorEvent

            +
            public WorkFunctionErrorEvent​(CaseInfo erroredCaseInfo, +java.lang.Exception functionError)
            Creates a new instance
            Parameters:
            erroredCaseInfo - Information about the case open when the error occurred
            functionError - The exception which was thrown
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getCaseInfo

          -
          public CaseInfo getCaseInfo()
          +
          +

          getCaseInfo

          +
          public CaseInfo getCaseInfo()
          Gets information related to case which was locked
          Returns:
          Information related to case which was locked
          +
          • -
        - - - - - - - -
        • -

          setReaction

          -
          public void setReaction(CaseIssueReaction reaction)
          +
          +

          setReaction

          +
          public void setReaction​(CaseIssueReaction reaction)
          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.
          @@ -280,59 +271,53 @@

          setReaction

          Parameters:
          reaction - The reaction to take
          +
          • -
        - - - -
        • -

          getError

          -
          public java.lang.Exception getError()
          +
          +

          getError

          +
          public java.lang.Exception getError()
          Gets the exception thrown
          Returns:
          The exception which was thrown
          +
          • -
        - - - -
        • -

          skipCase

          -
          public void skipCase()
          -
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          +

          skipCase

          +
          public void skipCase()
          +
          Notifies BulkCaseProcessor that this case should be skipped in response
          +
          • -
        - - - -
        • -

          abort

          -
          public void abort()
          -
          Notifies BulkCaseProcessor that all further processing should be aborted
          -
          • -
        +
        +

        abort

        +
        public void abort()
        +
        Notifies BulkCaseProcessor that all further processing should be aborted
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/BulkCaseProcessor.html b/docs/com/nuix/superutilities/cases/class-use/BulkCaseProcessor.html index 9d6e114..c40a7e9 100644 --- a/docs/com/nuix/superutilities/cases/class-use/BulkCaseProcessor.html +++ b/docs/com/nuix/superutilities/cases/class-use/BulkCaseProcessor.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.BulkCaseProcessor + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.BulkCaseProcessor

    +

    Uses of Class
    com.nuix.superutilities.cases.BulkCaseProcessor

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseConsumer.html b/docs/com/nuix/superutilities/cases/class-use/CaseConsumer.html index df145e2..f44226f 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseConsumer.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseConsumer.html @@ -1,38 +1,44 @@ - + Uses of Interface com.nuix.superutilities.cases.CaseConsumer + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.nuix.superutilities.cases.CaseConsumer

    +

    Uses of Interface
    com.nuix.superutilities.cases.CaseConsumer

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseHistoryHelper.html b/docs/com/nuix/superutilities/cases/class-use/CaseHistoryHelper.html index 43d06a8..64f336b 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseHistoryHelper.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseHistoryHelper.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseHistoryHelper + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseHistoryHelper

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseHistoryHelper

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseInfo.html b/docs/com/nuix/superutilities/cases/class-use/CaseInfo.html index 6cad84d..12961d1 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseInfo.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseInfo

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseIssueReaction.html b/docs/com/nuix/superutilities/cases/class-use/CaseIssueReaction.html index 4487e2c..c3061fb 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseIssueReaction.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseIssueReaction.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseIssueReaction + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseIssueReaction

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseIssueReaction

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseLockInfo.html b/docs/com/nuix/superutilities/cases/class-use/CaseLockInfo.html index 20b471b..ae42176 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseLockInfo.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseLockInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseLockInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseLockInfo

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseLockInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseLockedEventInfo.html b/docs/com/nuix/superutilities/cases/class-use/CaseLockedEventInfo.html index 4124054..60f44f1 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseLockedEventInfo.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseLockedEventInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseLockedEventInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseLockedEventInfo

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseLockedEventInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseOpenErrorEvent.html b/docs/com/nuix/superutilities/cases/class-use/CaseOpenErrorEvent.html index 1ffd791..2f8f498 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseOpenErrorEvent.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseOpenErrorEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseOpenErrorEvent + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseOpenErrorEvent

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseOpenErrorEvent

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/CaseUtility.html b/docs/com/nuix/superutilities/cases/class-use/CaseUtility.html index f2b144f..ee6825d 100644 --- a/docs/com/nuix/superutilities/cases/class-use/CaseUtility.html +++ b/docs/com/nuix/superutilities/cases/class-use/CaseUtility.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.CaseUtility + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.CaseUtility

    +

    Uses of Class
    com.nuix.superutilities.cases.CaseUtility

    -
    +
    + -
  • +
  • +
    -

    Uses of CaseUtility in com.nuix.superutilities.cases

    - - +

    Uses of CaseUtility in com.nuix.superutilities.cases

    +
    +
    Methods in com.nuix.superutilities.cases that return CaseUtility 
    + + - + + + - - + + +
    Methods in com.nuix.superutilities.cases that return CaseUtility 
    Modifier and TypeMethod and DescriptionMethodDescription
    static CaseUtilityCaseUtility.getInstance() static CaseUtilityCaseUtility.getInstance() 
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/cases/class-use/WorkFunctionErrorEvent.html b/docs/com/nuix/superutilities/cases/class-use/WorkFunctionErrorEvent.html index a347695..221c98e 100644 --- a/docs/com/nuix/superutilities/cases/class-use/WorkFunctionErrorEvent.html +++ b/docs/com/nuix/superutilities/cases/class-use/WorkFunctionErrorEvent.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.cases.WorkFunctionErrorEvent + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.cases.WorkFunctionErrorEvent

    +

    Uses of Class
    com.nuix.superutilities.cases.WorkFunctionErrorEvent

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/cases/package-summary.html b/docs/com/nuix/superutilities/cases/package-summary.html index 3158acb..86c13c9 100644 --- a/docs/com/nuix/superutilities/cases/package-summary.html +++ b/docs/com/nuix/superutilities/cases/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.cases + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.cases

    +
  • - +
    +
    + + - + - + - + - + - + - + - + - +
    Class Summary 
    Class Description
    BulkCaseProcessorBulkCaseProcessor
    This class assists with iteratively doing some form of work in multiple cases.
    CaseHistoryHelperCaseHistoryHelper
    Helper class for iterating a case's history.
    CaseInfoCaseInfo
    Represents some information which can be determined about a Nuix case directory without having yet opened the case through the API.
    CaseLockedEventInfoCaseLockedEventInfo -
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was +
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was locked.
    CaseLockInfoCaseLockInfo
    Represents information parsed from a case lock file.
    CaseOpenErrorEventCaseOpenErrorEvent -
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had +
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had and error when opened.
    CaseUtilityCaseUtility
    Class which provides some additional functionality regarding Nuix cases, mainly finding cases present in directories and their sub directories.
    WorkFunctionErrorEventWorkFunctionErrorEvent -
    This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while +
    This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while executing code provided in user code.
    +
  • - +
    +
    + + - +
    Enum Summary 
    Enum Description
    CaseIssueReactionCaseIssueReaction -
    Used to respond to issues opening a case by BulkCaseProcessor.
    +
    Used to respond to issues opening a case by BulkCaseProcessor.
    +
    • + + + + + diff --git a/docs/com/nuix/superutilities/cases/package-tree.html b/docs/com/nuix/superutilities/cases/package-tree.html index 62e6f92..5045f49 100644 --- a/docs/com/nuix/superutilities/cases/package-tree.html +++ b/docs/com/nuix/superutilities/cases/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.cases Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.cases

    Package Hierarchies: @@ -76,48 +68,57 @@

    Hierarchy For Package com.nuix.superutilities.cases

    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

    +
    +

    Enum Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/cases/package-use.html b/docs/com/nuix/superutilities/cases/package-use.html index f38f3a5..c0635e3 100644 --- a/docs/com/nuix/superutilities/cases/package-use.html +++ b/docs/com/nuix/superutilities/cases/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.cases + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.cases

    -
    +
    +
    + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.cases used by com.nuix.superutilities.cases 
    + + - + + + - + - + - + - + - + - + - + - +
    Classes in com.nuix.superutilities.cases used by com.nuix.superutilities.cases 
    Class and DescriptionClassDescription
    CaseConsumer -
    Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
    +    		CaseConsumer +
    Interface for callback which accepts cases as they are iterated by BulkCaseProcessor.
    CaseInfo +CaseInfo
    Represents some information which can be determined about a Nuix case directory without having yet opened the case through the API.
    CaseIssueReaction -
    Used to respond to issues opening a case by BulkCaseProcessor.
    +    		CaseIssueReaction +
    Used to respond to issues opening a case by BulkCaseProcessor.
    CaseLockedEventInfo -
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was +
    		CaseLockedEventInfo +
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which was locked.
    CaseLockInfo +CaseLockInfo
    Represents information parsed from a case lock file.
    CaseOpenErrorEvent -
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had +
    		CaseOpenErrorEvent +
    This class is used to provide a callback information regarding a case encountered by BulkCaseProcessor which had and error when opened.
    CaseUtility +CaseUtility
    Class which provides some additional functionality regarding Nuix cases, mainly finding cases present in directories and their sub directories.
    WorkFunctionErrorEvent -
    This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while +
    		WorkFunctionErrorEvent +
    This class is used to provide a callback information regarding an exception encountered by BulkCaseProcessor while executing code provided in user code.
    +
    • + + + + + + diff --git a/docs/com/nuix/superutilities/class-use/SuperUtilities.html b/docs/com/nuix/superutilities/class-use/SuperUtilities.html index e146d4c..e7d0ddf 100644 --- a/docs/com/nuix/superutilities/class-use/SuperUtilities.html +++ b/docs/com/nuix/superutilities/class-use/SuperUtilities.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.SuperUtilities + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.SuperUtilities

    +

    Uses of Class
    com.nuix.superutilities.SuperUtilities

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/export/ChunkedDATExporter.ChunkInfo.html b/docs/com/nuix/superutilities/export/ChunkedDATExporter.ChunkInfo.html index f5e00f3..cd5c359 100644 --- a/docs/com/nuix/superutilities/export/ChunkedDATExporter.ChunkInfo.html +++ b/docs/com/nuix/superutilities/export/ChunkedDATExporter.ChunkInfo.html @@ -1,36 +1,42 @@ - + ChunkedDATExporter.ChunkInfo + + + + + + + + + - - + + +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class ChunkedDATExporter.ChunkInfo

    +
    Package com.nuix.superutilities.export
    +

    Class ChunkedDATExporter.ChunkInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
      +
      +
      Enclosing class:
      -
      ChunkedDATExporter
      +
      ChunkedDATExporter
      -
      public class ChunkedDATExporter.ChunkInfo
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Field Summary

        - +

        Field Summary

        +
        +
        + - + + + + - + + - + + +
        Fields 
        Modifier and TypeField and DescriptionFieldDescription
        intchunkIndex chunkIndex 
        java.util.List<nuix.Item>items items 
        +
    + - -
      -
    • +
    • +
      -

      Constructor Summary

      - +

      Constructor Summary

      +
      +
      + - + + + + - + + +
      Constructors 
      Constructor and DescriptionConstructorDescription
      ChunkInfo(int index) ChunkInfo​(int index) 
      +
    + - -
      -
    • - - -

      Method Summary

      -
        -
      • +
      • +
        +

        Method Summary

        +

        Methods inherited from class java.lang.Object

        -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Field Detail

        - +
      • +
        +

        Field Details

        • -

          chunkIndex

          -
          public int chunkIndex
          +
          +

          chunkIndex

          +
          public int chunkIndex
          +
          • -
        - - - -
        • -

          items

          -
          public java.util.List<nuix.Item> items
          +
          +

          items

          +
          public java.util.List<nuix.Item> items
          +
        +
        • -
      -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ChunkInfo

            -
            public ChunkInfo(int index)
            -
            • -
          +
          +

          ChunkInfo

          +
          public ChunkInfo​(int index)
          +
        +
      -
    + + + + + diff --git a/docs/com/nuix/superutilities/export/ChunkedDATExporter.html b/docs/com/nuix/superutilities/export/ChunkedDATExporter.html index 08bb2d0..5e272b4 100644 --- a/docs/com/nuix/superutilities/export/ChunkedDATExporter.html +++ b/docs/com/nuix/superutilities/export/ChunkedDATExporter.html @@ -1,42 +1,48 @@ - + ChunkedDATExporter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class ChunkedDATExporter

    +
    Package com.nuix.superutilities.export
    +

    Class ChunkedDATExporter

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.ChunkedDATExporter
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.ChunkedDATExporter
      +
      +
      -
      public class ChunkedDATExporter
 extends java.lang.Object
      Generates a series of DAT loadfiles, based on a metadata profile.
      @@ -115,298 +99,291 @@

      Class ChunkedDATExporter

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + - -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ChunkedDATExporter

            -
            public ChunkedDATExporter()
            +
            +

            ChunkedDATExporter

            +
            public ChunkedDATExporter()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - - - -
        • -

          export

          -
          public void export(java.util.List<nuix.Item> items)
          -
          • -
        - +
        +

        Method Details

        • -

          getConcurrency

          -
          public int getConcurrency()
          +
          +

          export

          +
          public void export​(java.util.List<nuix.Item> items)
          +
          • -
        - - - -
        • -

          setConcurrency

          -
          public void setConcurrency(int concurrency)
          +
          +

          getConcurrency

          +
          public int getConcurrency()
          +
          • -
        - - - -
        • -

          getChunkSize

          -
          public int getChunkSize()
          +
          +

          setConcurrency

          +
          public void setConcurrency​(int concurrency)
          +
          • -
        - - - -
        • -

          setChunkSize

          -
          public void setChunkSize(int chunkSize)
          +
          +

          getChunkSize

          +
          public int getChunkSize()
          +
          • -
        - - - -
        • -

          getExportDirectory

          -
          public java.io.File getExportDirectory()
          +
          +

          setChunkSize

          +
          public void setChunkSize​(int chunkSize)
          +
          • -
        - - - -
        • -

          setExportDirectory

          -
          public void setExportDirectory(java.io.File exportDirectory)
          +
          +

          getExportDirectory

          +
          public java.io.File getExportDirectory()
          +
          • -
        - - - -
        • -

          setExportDirectory

          -
          public void setExportDirectory(java.lang.String exportDirectory)
          +
          +

          setExportDirectory

          +
          public void setExportDirectory​(java.io.File exportDirectory)
          +
          • -
        - - - -
        • -

          getProfile

          -
          public nuix.MetadataProfile getProfile()
          +
          +

          setExportDirectory

          +
          public void setExportDirectory​(java.lang.String exportDirectory)
          +
          • -
        - - - -
        • -

          setProfile

          -
          public void setProfile(nuix.MetadataProfile profile)
          +
          +

          getProfile

          +
          public nuix.MetadataProfile getProfile()
          +
          • -
        - - - -
        • -

          getFilenamePrefix

          -
          public java.lang.String getFilenamePrefix()
          +
          +

          setProfile

          +
          public void setProfile​(nuix.MetadataProfile profile)
          +
          • -
        - - - -
        • -

          setFilenamePrefix

          -
          public void setFilenamePrefix(java.lang.String filenamePrefix)
          +
          +

          getFilenamePrefix

          +
          public java.lang.String getFilenamePrefix()
          +
          • -
        - - - -
        • -

          getHeadersOnFirstChunkOnly

          -
          public boolean getHeadersOnFirstChunkOnly()
          +
          +

          setFilenamePrefix

          +
          public void setFilenamePrefix​(java.lang.String filenamePrefix)
          +
          • -
        - - - -
        • -

          setHeadersOnFirstChunkOnly

          -
          public void setHeadersOnFirstChunkOnly(boolean headersOnFirstChunkOnly)
          +
          +

          getHeadersOnFirstChunkOnly

          +
          public boolean getHeadersOnFirstChunkOnly()
          +
          • -
        +
      • +
        +

        setHeadersOnFirstChunkOnly

        +
        public void setHeadersOnFirstChunkOnly​(boolean headersOnFirstChunkOnly)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/export/CustomExporter.html b/docs/com/nuix/superutilities/export/CustomExporter.html index c4f3e7c..10910f6 100644 --- a/docs/com/nuix/superutilities/export/CustomExporter.html +++ b/docs/com/nuix/superutilities/export/CustomExporter.html @@ -1,42 +1,48 @@ - + CustomExporter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class CustomExporter

    +
    Package com.nuix.superutilities.export
    +

    Class CustomExporter

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.CustomExporter
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.CustomExporter
      +
      +
      -
      public class CustomExporter
 extends java.lang.Object
      Provides customized exports while still leveraging the performance of BatchExporter. @@ -117,234 +101,260 @@

      Class CustomExporter

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        CustomExporter() CustomExporter() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidclearAllDynamicPlaholders() +clearAllDynamicPlaholders()
      Removes all previously added dynamic placeholders.
      voidexportItems(nuix.Case nuixCase, - java.io.File exportDirectory, - java.util.List<nuix.Item> items) +exportItems​(nuix.Case nuixCase, +java.io.File exportDirectory, +java.util.List<nuix.Item> items)
      Exports given items in custom structure.
      voidexportItems(nuix.Case nuixCase, - java.lang.String exportDirectory, - java.util.List<nuix.Item> items) +exportItems​(nuix.Case nuixCase, +java.lang.String exportDirectory, +java.util.List<nuix.Item> items)
      Exports given items in custom structure.
      voidexportJson(java.lang.String fileNameTemplate) exportJson​(java.lang.String fileNameTemplate) 
      voidexportJson(java.lang.String fileNameTemplate, - JsonExporter jsonExporter) exportJson​(java.lang.String fileNameTemplate, +JsonExporter jsonExporter) 
      voidexportNatives(java.lang.String fileNameTemplate, - java.util.Map<java.lang.String,java.lang.Object> emailExportSettings) exportNatives​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> emailExportSettings) 
      voidexportPdfs(java.lang.String fileNameTemplate, - java.util.Map<java.lang.String,java.lang.Object> pdfExportSettings) exportPdfs​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> pdfExportSettings) 
      voidexportText(java.lang.String fileNameTemplate, - java.util.Map<java.lang.String,java.lang.Object> textExportSettings) exportText​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> textExportSettings) 
      voidexportTiffs(java.lang.String fileNameTemplate, - java.util.Map<java.lang.String,java.lang.Object> tiffExportSettings) exportTiffs​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> tiffExportSettings) 
      booleangetExportXlsx() +getExportXlsx()
      Gets whether DAT contents should additionally be exported as an XLSX spreadsheet.
      booleangetKeepOriginalDat() +getKeepOriginalDat()
      Gets whether original DAT will be kept by moving it to final export directory.
      nuix.MetadataProfilegetProfile() +getProfile()
      Gets the metadata profile which will be used during export.
      voidremoveDynamicPlaceholder(java.lang.String placeholderName) +removeDynamicPlaceholder​(java.lang.String placeholderName)
      Removes a previously added dynamic placeholder.
      voidsetColumnRemovals(java.util.Collection<java.lang.String> columnHeaders) +setColumnRemovals​(java.util.Collection<java.lang.String> columnHeaders)
      Allows you to provide a list of header names to specify columns to remove.
      voidsetDynamicPlaceholder(java.lang.String placeholderName, - java.util.function.BiFunction<nuix.Item,java.lang.String,java.lang.String> function) +setDynamicPlaceholder​(java.lang.String placeholderName, +java.util.function.BiFunction<nuix.Item,​java.lang.String,​java.lang.String> function)
      Assigns a dynamically calculated placeholder to this instance.
      voidsetExportXlsx(boolean exportXlsx) +setExportXlsx​(boolean exportXlsx)
      Sets whether DAT contents should additionally be exported as an XLSX spreadsheet.
      voidsetHeaderRenames(java.util.Map<java.lang.String,java.lang.String> renames) +setHeaderRenames​(java.util.Map<java.lang.String,​java.lang.String> renames)
      Allows you to provide a Map of headers to rename.
      voidsetImagingOptions(java.util.Map<?,?> settings) +setImagingOptions​(java.util.Map<?,​?> settings)
      Sets the Map of settings which will be passed to BatchExporter.setImagingOptions(Map) when performing the temporary export before restructuring.
      voidsetKeepOriginalDat(boolean keepOriginalDat) +setKeepOriginalDat​(boolean keepOriginalDat)
      Sets whether final DAT will be kept by moving it to final export directory/
      voidsetParallelProcessingSettings(java.util.Map<?,?> settings) +setParallelProcessingSettings​(java.util.Map<?,​?> settings)
      Sets the Map of settings which will be passed to BatchExporter.setParallelProcessingSettings(Map) when performing the temporary export before restructuring.
      voidsetProfile(nuix.MetadataProfile profile) +setProfile​(nuix.MetadataProfile profile)
      Sets the metadata profile used during export.
      voidsetStampingOptions(java.util.Map<?,?> settings) +setStampingOptions​(java.util.Map<?,​?> settings)
      Sets the Map of settings which will be passed to BatchExporter.setStampingOptions(Map) when performing the temporary export before restructuring.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            CustomExporter

            -
            public CustomExporter()
            +
            +

            CustomExporter

            +
            public CustomExporter()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getProfile

          -
          public nuix.MetadataProfile getProfile()
          +
          +

          getProfile

          +
          public nuix.MetadataProfile getProfile()
          Gets the metadata profile which will be used during export. May be null.
          Returns:
          The metadata profile used during export.
          +
          • -
        - - - -
        • -

          setProfile

          -
          public void setProfile(nuix.MetadataProfile profile)
          +
          +

          setProfile

          +
          public void setProfile​(nuix.MetadataProfile profile)
          Sets the metadata profile used during export. May be null, in which case a metadata profile containing only the column "GUID" will be created. Note that if a metadata profile is provided that does not contain the column "GUID", then a copy of the submit metadata profile is made and @@ -355,16 +365,13 @@

          setProfile

          Parameters:
          profile - The profile to use when generating metadata loadfiles.
          +
          • -
        - - - -
        • -

          setDynamicPlaceholder

          -
          public void setDynamicPlaceholder(java.lang.String placeholderName,
-                                  java.util.function.BiFunction<nuix.Item,java.lang.String,java.lang.String> function)
          +
          +

          setDynamicPlaceholder

          +
          public void setDynamicPlaceholder​(java.lang.String placeholderName, +java.util.function.BiFunction<nuix.Item,​java.lang.String,​java.lang.String> function)
          Assigns a dynamically calculated placeholder to this instance.
          Parameters:
          @@ -373,98 +380,71 @@

          setDynamicPlaceholder

          function - A function which accepts as arguments an item and String with product type. Expected to return a String value. If function yields a null then placeholder will resolve to "NO_VALUE" when resolving the template.
          +
          • -
        - - - -
        • -

          removeDynamicPlaceholder

          -
          public void removeDynamicPlaceholder(java.lang.String placeholderName)
          +
          +

          removeDynamicPlaceholder

          +
          public void removeDynamicPlaceholder​(java.lang.String placeholderName)
          Removes a previously added dynamic placeholder.
          Parameters:
          placeholderName - The name of the dynamic placeholder to remove
          +
          • -
        - - - -
        • -

          clearAllDynamicPlaholders

          -
          public void clearAllDynamicPlaholders()
          +
          +

          clearAllDynamicPlaholders

          +
          public void clearAllDynamicPlaholders()
          Removes all previously added dynamic placeholders.
          +
          • -
        - - - -
        • -

          exportNatives

          -
          public void exportNatives(java.lang.String fileNameTemplate,
-                          java.util.Map<java.lang.String,java.lang.Object> emailExportSettings)
          +
          +

          exportNatives

          +
          public void exportNatives​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> emailExportSettings)
          +
          • -
        - - - -
        • -

          exportText

          -
          public void exportText(java.lang.String fileNameTemplate,
-                       java.util.Map<java.lang.String,java.lang.Object> textExportSettings)
          +
          +

          exportText

          +
          public void exportText​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> textExportSettings)
          +
          • -
        - - - -
        • -

          exportPdfs

          -
          public void exportPdfs(java.lang.String fileNameTemplate,
-                       java.util.Map<java.lang.String,java.lang.Object> pdfExportSettings)
          +
          +

          exportPdfs

          +
          public void exportPdfs​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> pdfExportSettings)
          +
          • -
        - - - -
        • -

          exportTiffs

          -
          public void exportTiffs(java.lang.String fileNameTemplate,
-                        java.util.Map<java.lang.String,java.lang.Object> tiffExportSettings)
          +
          +

          exportTiffs

          +
          public void exportTiffs​(java.lang.String fileNameTemplate, +java.util.Map<java.lang.String,​java.lang.Object> tiffExportSettings)
          +
          • -
        - - - -
        • -

          exportJson

          -
          public void exportJson(java.lang.String fileNameTemplate)
          +
          +

          exportJson

          +
          public void exportJson​(java.lang.String fileNameTemplate)
          +
          • -
        - - - -
        • -

          exportJson

          -
          public void exportJson(java.lang.String fileNameTemplate,
-                       JsonExporter jsonExporter)
          +
          +

          exportJson

          +
          public void exportJson​(java.lang.String fileNameTemplate, +JsonExporter jsonExporter)
          +
          • -
        - - - -
        • -

          setHeaderRenames

          -
          public void setHeaderRenames(java.util.Map<java.lang.String,java.lang.String> renames)
          +
          +

          setHeaderRenames

          +
          public void setHeaderRenames​(java.util.Map<java.lang.String,​java.lang.String> renames)
          Allows you to provide a Map of headers to rename. Intended to provide a way to rename headers that Nuix automatically adds to DAT files it generates:
          DOCID
          @@ -483,15 +463,12 @@

          setHeaderRenames

          Parameters:
          renames - A Map with the map key being the header name before and the map value being what you want that header renamed to. Map key is case sensitive!
          +
          • -
        - - - -
        • -

          setColumnRemovals

          -
          public void setColumnRemovals(java.util.Collection<java.lang.String> columnHeaders)
          +
          +

          setColumnRemovals

          +
          public void setColumnRemovals​(java.util.Collection<java.lang.String> columnHeaders)
          Allows you to provide a list of header names to specify columns to remove. Intended to provide a way to remove columns that Nuix automatically adds to DAT files it generates:
          DOCID
          @@ -512,18 +489,15 @@

          setColumnRemovals

          columnHeaders - Collection of column header names for columns to be removed. Case sensitive and takes priority over column renaming, so make sure you provide original pre-rename headers.
          +
          • -
        - - - -
        • -

          exportItems

          -
          public void exportItems(nuix.Case nuixCase,
-                        java.lang.String exportDirectory,
-                        java.util.List<nuix.Item> items)
-                 throws java.lang.Exception
          +
          +

          exportItems

          +
          public void exportItems​(nuix.Case nuixCase, +java.lang.String exportDirectory, +java.util.List<nuix.Item> items) + throws java.lang.Exception
          Exports given items in custom structure. This is accomplished by first performing a temporary "legal export" using the API object BatchExporter. Once that export is complete, files are restructured into final format. Load file paths are updated to reflect restructuring.
          @@ -535,18 +509,15 @@

          exportItems

          Throws:
          java.lang.Exception - If something goes wrong
          +
          • -
        - - - -
        • -

          exportItems

          -
          public void exportItems(nuix.Case nuixCase,
-                        java.io.File exportDirectory,
-                        java.util.List<nuix.Item> items)
-                 throws java.lang.Exception
          +
          +

          exportItems

          +
          public void exportItems​(nuix.Case nuixCase, +java.io.File exportDirectory, +java.util.List<nuix.Item> items) + throws java.lang.Exception
          Exports given items in custom structure. This is accomplished by first performing a temporary "legal export" using the API object BatchExporter. Once that export is complete, files are restructured into final format. Load file paths are updated to reflect restructuring.
          @@ -558,15 +529,12 @@

          exportItems

          Throws:
          java.lang.Exception - If something goes wrong
          +
          • -
        - - - -
        • -

          setParallelProcessingSettings

          -
          public void setParallelProcessingSettings(java.util.Map<?,?> settings)
          +
          +

          setParallelProcessingSettings

          +
          public void setParallelProcessingSettings​(java.util.Map<?,​?> settings)
          Sets the Map of settings which will be passed to BatchExporter.setParallelProcessingSettings(Map) when performing the temporary export before restructuring.
          @@ -575,15 +543,12 @@

          setParallelProcessingSettings

          BatchExporter.setParallelProcessingSettings for a list of settings accepted.
          +
          • -
        - - - -
        • -

          setImagingOptions

          -
          public void setImagingOptions(java.util.Map<?,?> settings)
          +
          +

          setImagingOptions

          +
          public void setImagingOptions​(java.util.Map<?,​?> settings)
          Sets the Map of settings which will be passed to BatchExporter.setImagingOptions(Map) when performing the temporary export before restructuring.
          @@ -592,15 +557,12 @@

          setImagingOptions

          BatchExporter.setImagingOptions for a list of settings accepted.
          +
          • -
        - - - -
        • -

          setStampingOptions

          -
          public void setStampingOptions(java.util.Map<?,?> settings)
          +
          +

          setStampingOptions

          +
          public void setStampingOptions​(java.util.Map<?,​?> settings)
          Sets the Map of settings which will be passed to BatchExporter.setStampingOptions(Map) when performing the temporary export before restructuring.
          @@ -609,81 +571,72 @@

          setStampingOptions

          BatchExporter.setStampingOptions for a list of settings accepted.
          +
          • -
        - - - -
        • -

          getExportXlsx

          -
          public boolean getExportXlsx()
          +
          +

          getExportXlsx

          +
          public boolean getExportXlsx()
          Gets whether DAT contents should additionally be exported as an XLSX spreadsheet.
          Returns:
          Whether DAT contents should additionally be exported as an XLSX spreadsheet.
          +
          • -
        - - - -
        • -

          setExportXlsx

          -
          public void setExportXlsx(boolean exportXlsx)
          +
          +

          setExportXlsx

          +
          public void setExportXlsx​(boolean exportXlsx)
          Sets whether DAT contents should additionally be exported as an XLSX spreadsheet.
          Parameters:
          exportXlsx - Whether DAT contents should additionally be exported as an XLSX spreadsheet.
          +
          • -
        - - - -
        • -

          getKeepOriginalDat

          -
          public boolean getKeepOriginalDat()
          +
          +

          getKeepOriginalDat

          +
          public boolean getKeepOriginalDat()
          Gets whether original DAT will be kept by moving it to final export directory.
          Returns:
          True if final DAT will be kept
          +
          • -
        - - - -
        • -

          setKeepOriginalDat

          -
          public void setKeepOriginalDat(boolean keepOriginalDat)
          +
          +

          setKeepOriginalDat

          +
          public void setKeepOriginalDat​(boolean keepOriginalDat)
          Sets whether final DAT will be kept by moving it to final export directory/
          Parameters:
          keepOriginalDat - True if final DAT should be kept
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/export/JsonExporter.html b/docs/com/nuix/superutilities/export/JsonExporter.html index c00b27b..e9cc971 100644 --- a/docs/com/nuix/superutilities/export/JsonExporter.html +++ b/docs/com/nuix/superutilities/export/JsonExporter.html @@ -1,42 +1,48 @@ - + JsonExporter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class JsonExporter

    +
    Package com.nuix.superutilities.export
    +

    Class JsonExporter

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.JsonExporter
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.JsonExporter
      +
      +
      -
      public class JsonExporter
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        JsonExporter() JsonExporter() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
    Parameters:
    callback - A callback which may inspect or modify the nested Map form of an item before it is serialized to JSON
    + - - - - -
    • -

      getIncludeText

      -
      public boolean getIncludeText()
      +
      +

      getIncludeText

      +
      public boolean getIncludeText()
      Gets whether item content text will be included in generated JSON
      Returns:
      True if content text will be included
      +
      • -
    - - - -
    • -

      setIncludeText

      -
      public void setIncludeText(boolean includeText)
      +
      +

      setIncludeText

      +
      public void setIncludeText​(boolean includeText)
      Sets whether item content text will be included in generated JSON
      Parameters:
      includeText - True if content text should be included
      +
      • -
    - - - -
    • -

      getIncludeProperties

      -
      public boolean getIncludeProperties()
      +
      +

      getIncludeProperties

      +
      public boolean getIncludeProperties()
      Gets whether item metadata properties will be included in generated JSON
      Returns:
      True if item metadata properties will be included in generated JSON
      +
      • -
    - - - -
    • -

      setIncludeProperties

      -
      public void setIncludeProperties(boolean includeProperties)
      +
      +

      setIncludeProperties

      +
      public void setIncludeProperties​(boolean includeProperties)
      Sets whether item metadata properties will be included in generated JSON
      Parameters:
      includeProperties - True if item metadata properties should be included in generated JSON
      +
      • -
    - - - -
    • -

      getIncludeCustomMetadata

      -
      public boolean getIncludeCustomMetadata()
      +
      +

      getIncludeCustomMetadata

      +
      public boolean getIncludeCustomMetadata()
      Gets whether item custom metadata will be included in generated JSON
      Returns:
      True if item custom metadata will be included in generated JSON
      +
      • -
    - - - -
    • -

      setIncludeCustomMetadata

      -
      public void setIncludeCustomMetadata(boolean includeCustomMetadata)
      +
      +

      setIncludeCustomMetadata

      +
      public void setIncludeCustomMetadata​(boolean includeCustomMetadata)
      Sets whether item custom metadata will be included in generated JSON
      Parameters:
      includeCustomMetadata - True if item custom metadata should be included in JSON
      +
      • -
    - - - -
    • -

      getIncludeTags

      -
      public boolean getIncludeTags()
      +
      +

      getIncludeTags

      +
      public boolean getIncludeTags()
      Gets whether items' tags will be included in generated JSON
      Returns:
      True if items' tags will be included in generated JSON
      +
      • -
    - - - -
    • -

      setIncludeTags

      -
      public void setIncludeTags(boolean includeTags)
      +
      +

      setIncludeTags

      +
      public void setIncludeTags​(boolean includeTags)
      Sets whether items' tags will be included in generated JSON
      Parameters:
      includeTags - True if items' tags should be included in generated JSON
      +
      • -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    • -

      getSerializeNulls

      -
      public boolean getSerializeNulls()
      +
      +

      getSerializeNulls

      +
      public boolean getSerializeNulls()
      Gets whether entries with a null value are included in the generated JSON
      Returns:
      True if entries with a null value will be included in generated JSON
      +
      • -
    - - - -
    • -

      setSerializeNulls

      -
      public void setSerializeNulls(boolean serializeNulls)
      +
      +

      setSerializeNulls

      +
      public void setSerializeNulls​(boolean serializeNulls)
      Sets whether entries with null value are included in the generated JSON
      Parameters:
      serializeNulls - True if entries with null value should be included in generated JSON
      +
      • -
    - - - -
    • -

      getPrettyPrint

      -
      public boolean getPrettyPrint()
      +
      +

      getPrettyPrint

      +
      public boolean getPrettyPrint()
      Gets whether JSON will be "pretty printed". Makes file more human readable, but can also make the file larger with all the extra white space characters for formatting.
      Returns:
      True if JSON will be "pretty printed"
      +
      • -
    - - - -
    • -

      setPrettyPrint

      -
      public void setPrettyPrint(boolean prettyPrint)
      +
      +

      setPrettyPrint

      +
      public void setPrettyPrint​(boolean prettyPrint)
      Sets whether JSON will be "pretty printed". Makes file more human readable, but can also make the file larger with all the extra white space characters for formatting.
      Parameters:
      prettyPrint - True if the output should be "pretty printed"
      +
      • -
    - - - -
    • -

      mapWorkerItem

      -
      public java.util.Map<java.lang.String,java.lang.Object> mapWorkerItem(nuix.WorkerItem workerItem)
      +
      +

      mapWorkerItem

      +
      public java.util.Map<java.lang.String,​java.lang.Object> mapWorkerItem​(nuix.WorkerItem workerItem)
      This method take a provided WorkerItem and generates a series of nested Map instances representing the WorkerItem and its data. The resulting Map is later used as input to GSON for serializing to JSON. - Internally this gets the SourceItem for the given WorkerItem and provides that to mapSourceItem(SourceItem) to + Internally this gets the SourceItem for the given WorkerItem and provides that to mapSourceItem(SourceItem) to build most of the Map. After that it adds a few additional entries based on what is available from the WorkerItem.
      Parameters:
      @@ -678,36 +645,30 @@

      mapWorkerItem

      Returns:
      Map representing the WorkerItem and its SourceItem
      +
      • -
    - - - -
    • -

      mapSourceItem

      -
      public java.util.Map<java.lang.String,java.lang.Object> mapSourceItem(nuix.SourceItem sourceItem)
      +
      +

      mapSourceItem

      +
      public java.util.Map<java.lang.String,​java.lang.Object> mapSourceItem​(nuix.SourceItem sourceItem)
      This method takes a provided SourceItem and generates a series of nested Map instances representing the SourceItem and its data. The resulting Map is later used as input to GSON for serializing to JSON. - In turn the following methods are called by this one: mapItemType(ItemType), mapProperties(Map), - mapCommunication(Communication)
      + In turn the following methods are called by this one: mapItemType(ItemType), mapProperties(Map), + mapCommunication(Communication)
      Parameters:
      sourceItem - Source item to serialize into a Map
      Returns:
      Map representation of the source item
      +
      • -
    - - - -
    • -

      mapItem

      -
      public java.util.Map<java.lang.String,java.lang.Object> mapItem(nuix.Item item)
      +
      +

      mapItem

      +
      public java.util.Map<java.lang.String,​java.lang.Object> mapItem​(nuix.Item item)
      Converts a Nuix item into a series of nested Map objects, which later can be easily serialized into JSON.
      @@ -716,117 +677,96 @@

      mapItem

      Returns:
      Map representation of the item
      +
      • -
    - - - -
    • -

      exportItemAsJson

      -
      public void exportItemAsJson(nuix.Item item,
-                             java.io.File exportFilePath)
      +
      +

      exportItemAsJson

      +
      public void exportItemAsJson​(nuix.Item item, +java.io.File exportFilePath)
      Exports an item as a JSON representation. Items information is first converted into a series of Map objects - by calling mapItem(Item), the result of which is then converted into JSON.
      + by calling mapItem(Item), the result of which is then converted into JSON.
      Parameters:
      item - The item to serialize into JSON
      exportFilePath - File path to write the JSON result to.
      +
      • -
    - - - -
    • -

      exportSourceItemAsJson

      -
      public void exportSourceItemAsJson(nuix.SourceItem sourceItem,
-                                   java.io.File exportFilePath)
      +
      +

      exportSourceItemAsJson

      +
      public void exportSourceItemAsJson​(nuix.SourceItem sourceItem, +java.io.File exportFilePath)
      Exports an source item as a JSON representation. The SourceItem's information is first converted into a series of Map objects - by calling mapSourceItem(SourceItem), the result of which is then converted into JSON.
      + by calling mapSourceItem(SourceItem), the result of which is then converted into JSON.
      Parameters:
      sourceItem - The SourceItem to serialize into JSON
      exportFilePath - File path to write the JSON result to.
      +
      • -
    - - - -
    • -

      exportWorkerItemAsJson

      -
      public void exportWorkerItemAsJson(nuix.WorkerItem workerItem,
-                                   java.io.File exportFilePath)
      +
      +

      exportWorkerItemAsJson

      +
      public void exportWorkerItemAsJson​(nuix.WorkerItem workerItem, +java.io.File exportFilePath)
      Exports a worker item as a JSON representation. The WorkerItem's information is first converted into a series of Map objects - by calling mapWorkerItem(WorkerItem), the result of which is then converted into JSON.
      + by calling mapWorkerItem(WorkerItem), the result of which is then converted into JSON.
      Parameters:
      workerItem - The WorkerItem to serialize into JSON
      exportFilePath - File path to write the JSON result to.
      +
      • -
    - - - -
    • -

      convertItemToJsonString

      -
      public java.lang.String convertItemToJsonString(nuix.Item item)
      +
      +

      convertItemToJsonString

      +
      public java.lang.String convertItemToJsonString​(nuix.Item item)
      Converts an item to a JSON String representation. The Item's information is first converted into a series of Map objects - by calling mapItem(Item), result of which is then serialized into a JSON String and returned.
      + by calling mapItem(Item), result of which is then serialized into a JSON String and returned.
      Parameters:
      item - The item to serialize into JSON
      Returns:
      A JSON String representation of the given item.
      +
      • -
    - - - -
    • -

      convertSourceItemToJsonString

      -
      public java.lang.String convertSourceItemToJsonString(nuix.SourceItem sourceItem)
      +
      +

      convertSourceItemToJsonString

      +
      public java.lang.String convertSourceItemToJsonString​(nuix.SourceItem sourceItem)
      Converts a SourceItem to a JSON String representation. The SourceItem's information is first converted into a series of Map objects - by calling mapSourceItem(SourceItem), result of which is then serialized into a JSON String and returned.
      + by calling mapSourceItem(SourceItem), result of which is then serialized into a JSON String and returned.
      Parameters:
      sourceItem - The SourceItem to serialize into JSON
      Returns:
      A JSON String representation of the given SourceItem.
      +
      • -
    - - - -
    • -

      convertWorkerItemToJsonString

      -
      public java.lang.String convertWorkerItemToJsonString(nuix.WorkerItem workerItem)
      +
      +

      convertWorkerItemToJsonString

      +
      public java.lang.String convertWorkerItemToJsonString​(nuix.WorkerItem workerItem)
      Converts a WorkerItem to a JSON String representation. The WorkerItem's information is first converted into a series of Map objects - by calling mapWorkerItem(WorkerItem), result of which is then serialized into a JSON String and returned.
      + by calling mapWorkerItem(WorkerItem), result of which is then serialized into a JSON String and returned.
      Parameters:
      workerItem - The WorkerItem to serialize into JSON
      Returns:
      A JSON String representation of the given WorkerItem.
      +
      • -
    - - - -
    • -

      mapProperties

      -
      public static java.util.Map<java.lang.String,java.lang.Object> mapProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
      +
      +

      mapProperties

      +
      public static java.util.Map<java.lang.String,​java.lang.Object> mapProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
      This method generates a Map of the properties for an item, organizing properties into sub-categories based on the data type of their values.
      @@ -835,15 +775,12 @@

      mapProperties

      Returns:
      A nested series of Map instances with properties categorized by value data type
      +
      • -
    - - - -
    • -

      mapItemType

      -
      public static java.util.Map<java.lang.String,java.lang.String> mapItemType(nuix.ItemType itemType)
      +
      +

      mapItemType

      +
      public static java.util.Map<java.lang.String,​java.lang.String> mapItemType​(nuix.ItemType itemType)
      Converts a Nuix ItemType object to a HashMap<String,String> for JSON serialization. This method first checks a local cache to see if the value has already been converted and returns that if so.
      @@ -853,32 +790,26 @@

      mapItemType

      Returns:
      The resulting Map
      +
      • -
    - - - -
    • -

      mapCommunication

      -
      public static java.util.Map<java.lang.String,java.lang.Object> mapCommunication(nuix.Communication comm)
      +
      +

      mapCommunication

      +
      public static java.util.Map<java.lang.String,​java.lang.Object> mapCommunication​(nuix.Communication comm)
      Converts a Nuix Communication object to a HashMap<String,Object> for JSON serialization. This method in turn - calls mapAddresses(List).
      + calls mapAddresses(List).
      Parameters:
      comm - The Nuix Communication object to Map-ify
      Returns:
      The resulting Map
      +
      • -
    - - - -
    • -

      mapAddress

      -
      public static java.util.Map<java.lang.String,java.lang.Object> mapAddress(nuix.Address address)
      +
      +

      mapAddress

      +
      public static java.util.Map<java.lang.String,​java.lang.Object> mapAddress​(nuix.Address address)
      Converts a Nuix Address object to a HashMap<String,Object> for JSON serialization.
      Parameters:
      @@ -886,42 +817,42 @@

      mapAddress

      Returns:
      The resulting Map
      +
      • -
    - - - -
    • -

      mapAddresses

      -
      public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> mapAddresses(java.util.List<nuix.Address> addresses)
      +
      +

      mapAddresses

      +
      public static java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> mapAddresses​(java.util.List<nuix.Address> addresses)
      Converts a List of Nuix Address objects to a list of HashMap<String,Object> for JSON serialization. This method - calls mapAddress(Address) for each Address object provided.
      + calls mapAddress(Address) for each Address object provided.
      Parameters:
      addresses - The list of Nuix Address objects to Mapify
      Returns:
      The resulting Map
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/export/PdfWorkCache.html b/docs/com/nuix/superutilities/export/PdfWorkCache.html index 7a9978b..4429d3d 100644 --- a/docs/com/nuix/superutilities/export/PdfWorkCache.html +++ b/docs/com/nuix/superutilities/export/PdfWorkCache.html @@ -1,42 +1,48 @@ - + PdfWorkCache + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class PdfWorkCache

    +
    Package com.nuix.superutilities.export
    +

    Class PdfWorkCache

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.PdfWorkCache
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.PdfWorkCache
      +
      +
      -
      public class PdfWorkCache
 extends java.lang.Object
      -
      This class provides access to PDFs as files when you need them on the file system to perform some operation. Calls to getPdfPath(Item) will +
      This class provides access to PDFs as files when you need them on the file system to perform some operation. Calls to getPdfPath(Item) will either provide a path to an already exported PDF for the given item or generate the PDF as needed.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        PdfWorkCache(java.io.File tempDirectory) +PdfWorkCache​(java.io.File tempDirectory)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            PdfWorkCache

            -
            public PdfWorkCache(java.io.File tempDirectory)
            +
            +

            PdfWorkCache

            +
            public PdfWorkCache​(java.io.File tempDirectory)
            Creates a new instance
            Parameters:
            tempDirectory - Temporary directory where PDF files will be saved to.
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getPdfPath

          -
          public java.io.File getPdfPath(nuix.Item item)
-                        throws java.lang.Exception
          +
          +

          getPdfPath

          +
          public java.io.File getPdfPath​(nuix.Item item) + throws java.lang.Exception
          Gets the path to a PDF exported for an item if it is already exported. If the given item's PDF has not yet been exported, this will export a PDF for that item and then return the newly generated PDFs path.
          @@ -242,15 +238,12 @@

          getPdfPath

          Throws:
          java.lang.Exception - If something goes wrong
          +
          • -
        - - - -
        • -

          forgetItem

          -
          public void forgetItem(nuix.Item item)
          +
          +

          forgetItem

          +
          public void forgetItem​(nuix.Item item)
          Removes PDF from cache and deletes it from the file system. Should not error if:
          - PDF file no longer exists
          - There is no entry in cache for given item
          @@ -258,59 +251,53 @@

          forgetItem

          Parameters:
          item - The item to "forget" (remove from cache and delete PDF file)
          +
          • -
        - - - -
        • -

          cleanupTemporaryPdfs

          -
          public void cleanupTemporaryPdfs()
-                          throws java.io.IOException
          +
          +

          cleanupTemporaryPdfs

          +
          public void cleanupTemporaryPdfs() + throws java.io.IOException
          Calling this will delete all temporary PDFs created by this instance, as well as clear internal listing of PDFs and their associated file paths.
          Throws:
          java.io.IOException - If something goes wrong
          +
          • -
        - - - -
        • -

          getRegenerateStored

          -
          public boolean getRegenerateStored()
          +
          +

          getRegenerateStored

          +
          public boolean getRegenerateStored()
          +
          • -
        - - - -
        • -

          setRegenerateStored

          -
          public void setRegenerateStored(boolean value)
          -
          • -
        +
        +

        setRegenerateStored

        +
        public void setRegenerateStored​(boolean value)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/export/TemplateExporter.html b/docs/com/nuix/superutilities/export/TemplateExporter.html index be03dd9..a7e39cd 100644 --- a/docs/com/nuix/superutilities/export/TemplateExporter.html +++ b/docs/com/nuix/superutilities/export/TemplateExporter.html @@ -1,42 +1,48 @@ - + TemplateExporter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.export
    -

    Class TemplateExporter

    +
    Package com.nuix.superutilities.export
    +

    Class TemplateExporter

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.export.TemplateExporter
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.export.TemplateExporter
      +
      +
      -
      public class TemplateExporter
 extends java.lang.Object
      Experimental class attempting to integrate Ruby ERB templates with Java by using JRuby to @@ -116,226 +100,225 @@

      Class TemplateExporter

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        TemplateExporter(java.io.File erbTemplateFile) TemplateExporter​(java.io.File erbTemplateFile) 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Instance Methods Concrete Methods 
      + - + + - + + + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidhtmlToPdf(java.lang.String htmlSource, - java.io.File outputPdfPath) htmlToPdf​(java.lang.String htmlSource, +java.io.File outputPdfPath) 
      static voidhtmlToPdf(java.lang.String htmlSource, - java.lang.String outputPdfPath) htmlToPdf​(java.lang.String htmlSource, +java.lang.String outputPdfPath) 
      java.lang.Stringrender(nuix.Item item) render​(nuix.Item item) 
      java.lang.Stringrender(nuix.Item item, - java.util.Map<java.lang.String,java.lang.Object> data) render​(nuix.Item item, +java.util.Map<java.lang.String,​java.lang.Object> data) 
      voidrenderToFile(nuix.Item item, - java.io.File outputFile, - java.util.Map<java.lang.String,java.lang.Object> data) renderToFile​(nuix.Item item, +java.io.File outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) 
      voidrenderToFile(nuix.Item item, - java.lang.String outputFile, - java.util.Map<java.lang.String,java.lang.Object> data) renderToFile​(nuix.Item item, +java.lang.String outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) 
      voidrenderToPdf(nuix.Item item, - java.io.File outputFile, - java.util.Map<java.lang.String,java.lang.Object> data) renderToPdf​(nuix.Item item, +java.io.File outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            TemplateExporter

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

            TemplateExporter

            +
            public TemplateExporter​(java.io.File erbTemplateFile) + throws java.lang.Exception
            Throws:
            java.lang.Exception
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          render

          -
          public java.lang.String render(nuix.Item item)
          +
          +

          render

          +
          public java.lang.String render​(nuix.Item item)
          +
          • -
        - - - -
        • -

          render

          -
          public java.lang.String render(nuix.Item item,
-                               java.util.Map<java.lang.String,java.lang.Object> data)
          +
          +

          render

          +
          public java.lang.String render​(nuix.Item item, +java.util.Map<java.lang.String,​java.lang.Object> data)
          +
          • -
        - - - -
        • -

          renderToFile

          -
          public void renderToFile(nuix.Item item,
-                         java.io.File outputFile,
-                         java.util.Map<java.lang.String,java.lang.Object> data)
-                  throws java.lang.Exception
          +
          +

          renderToFile

          +
          public void renderToFile​(nuix.Item item, +java.io.File outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          renderToFile

          -
          public void renderToFile(nuix.Item item,
-                         java.lang.String outputFile,
-                         java.util.Map<java.lang.String,java.lang.Object> data)
-                  throws java.lang.Exception
          +
          +

          renderToFile

          +
          public void renderToFile​(nuix.Item item, +java.lang.String outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          renderToPdf

          -
          public void renderToPdf(nuix.Item item,
-                        java.io.File outputFile,
-                        java.util.Map<java.lang.String,java.lang.Object> data)
-                 throws java.lang.Exception
          +
          +

          renderToPdf

          +
          public void renderToPdf​(nuix.Item item, +java.io.File outputFile, +java.util.Map<java.lang.String,​java.lang.Object> data) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          htmlToPdf

          -
          public static void htmlToPdf(java.lang.String htmlSource,
-                             java.io.File outputPdfPath)
          +
          +

          htmlToPdf

          +
          public static void htmlToPdf​(java.lang.String htmlSource, +java.io.File outputPdfPath)
          +
          • -
        - - - -
        • -

          htmlToPdf

          -
          public static void htmlToPdf(java.lang.String htmlSource,
-                             java.lang.String outputPdfPath)
          +
          +

          htmlToPdf

          +
          public static void htmlToPdf​(java.lang.String htmlSource, +java.lang.String outputPdfPath)
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.ChunkInfo.html b/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.ChunkInfo.html index 74c178a..b5aee68 100644 --- a/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.ChunkInfo.html +++ b/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.ChunkInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo

    +

    Uses of Class
    com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo

    No usage of com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.html b/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.html index c51fd8d..815e39d 100644 --- a/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.html +++ b/docs/com/nuix/superutilities/export/class-use/ChunkedDATExporter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.ChunkedDATExporter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.ChunkedDATExporter

    +

    Uses of Class
    com.nuix.superutilities.export.ChunkedDATExporter

    No usage of com.nuix.superutilities.export.ChunkedDATExporter
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/export/class-use/CustomExporter.html b/docs/com/nuix/superutilities/export/class-use/CustomExporter.html index 4fb62da..a40d67c 100644 --- a/docs/com/nuix/superutilities/export/class-use/CustomExporter.html +++ b/docs/com/nuix/superutilities/export/class-use/CustomExporter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.CustomExporter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.CustomExporter

    +

    Uses of Class
    com.nuix.superutilities.export.CustomExporter

    No usage of com.nuix.superutilities.export.CustomExporter
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/export/class-use/JsonExporter.html b/docs/com/nuix/superutilities/export/class-use/JsonExporter.html index 3243023..bd95666 100644 --- a/docs/com/nuix/superutilities/export/class-use/JsonExporter.html +++ b/docs/com/nuix/superutilities/export/class-use/JsonExporter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.JsonExporter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.JsonExporter

    +

    Uses of Class
    com.nuix.superutilities.export.JsonExporter

    -
    +
    + -
  • +
  • +
    -

    Uses of JsonExporter in com.nuix.superutilities.export

    - - +

    Uses of JsonExporter in com.nuix.superutilities.export

    +
    +
    Methods in com.nuix.superutilities.export with parameters of type JsonExporter 
    + + - + + + - + +
    Methods in com.nuix.superutilities.export with parameters of type JsonExporter 
    Modifier and TypeMethod and DescriptionMethodDescription
    voidCustomExporter.exportJson(java.lang.String fileNameTemplate, - JsonExporter jsonExporter) CustomExporter.exportJson​(java.lang.String fileNameTemplate, +JsonExporter jsonExporter) 
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/export/class-use/PdfWorkCache.html b/docs/com/nuix/superutilities/export/class-use/PdfWorkCache.html index dba07b3..24e569a 100644 --- a/docs/com/nuix/superutilities/export/class-use/PdfWorkCache.html +++ b/docs/com/nuix/superutilities/export/class-use/PdfWorkCache.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.PdfWorkCache + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.PdfWorkCache

    +

    Uses of Class
    com.nuix.superutilities.export.PdfWorkCache

    No usage of com.nuix.superutilities.export.PdfWorkCache
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/export/class-use/TemplateExporter.html b/docs/com/nuix/superutilities/export/class-use/TemplateExporter.html index 4297b16..7aa74f2 100644 --- a/docs/com/nuix/superutilities/export/class-use/TemplateExporter.html +++ b/docs/com/nuix/superutilities/export/class-use/TemplateExporter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.export.TemplateExporter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.export.TemplateExporter

    +

    Uses of Class
    com.nuix.superutilities.export.TemplateExporter

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/export/package-summary.html b/docs/com/nuix/superutilities/export/package-summary.html index 5de3b19..81e3940 100644 --- a/docs/com/nuix/superutilities/export/package-summary.html +++ b/docs/com/nuix/superutilities/export/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.export + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.export

    +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/export/package-tree.html b/docs/com/nuix/superutilities/export/package-tree.html index b143b4c..18955d4 100644 --- a/docs/com/nuix/superutilities/export/package-tree.html +++ b/docs/com/nuix/superutilities/export/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.export Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.export

    Package Hierarchies: @@ -76,30 +68,35 @@

    Hierarchy For Package com.nuix.superutilities.export

    +

    Class Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/export/package-use.html b/docs/com/nuix/superutilities/export/package-use.html index fc0d6e0..85765cd 100644 --- a/docs/com/nuix/superutilities/export/package-use.html +++ b/docs/com/nuix/superutilities/export/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.export + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.export

    -
    +
    +
    + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.export used by com.nuix.superutilities.export 
    + + - + + + - + +
    Classes in com.nuix.superutilities.export used by com.nuix.superutilities.export 
    Class and DescriptionClassDescription
    JsonExporter JsonExporter 
    +
    • + + + + + + diff --git a/docs/com/nuix/superutilities/items/SuperItemUtility.html b/docs/com/nuix/superutilities/items/SuperItemUtility.html index b33ae0e..c813d7c 100644 --- a/docs/com/nuix/superutilities/items/SuperItemUtility.html +++ b/docs/com/nuix/superutilities/items/SuperItemUtility.html @@ -1,42 +1,48 @@ - + SuperItemUtility + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.items
    -

    Class SuperItemUtility

    +
    Package com.nuix.superutilities.items
    +

    Class SuperItemUtility

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.items.SuperItemUtility
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.items.SuperItemUtility
      +
      +
      -
      public class SuperItemUtility
 extends java.lang.Object
      Offers methods for working with items and item collections in the same spirit of the @@ -116,128 +100,160 @@

      Class SuperItemUtility

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Method Summary

        - - +

        Method Summary

        +
        +
        +
        +
        All Methods Static Methods Instance Methods Concrete Methods 
        + - + + - + + + - + - + - + - + - + - + + + + + + - + - + - + - - - + + + + + + + + + - + - + - + - + - + + + + + + - + - + - + +
        Modifier and TypeMethod and DescriptionMethodDescription
        java.util.Set<nuix.Item>deduplicateCustomTieBreaker(java.util.Collection<nuix.Item> items, - java.util.function.BiFunction<nuix.Item,nuix.Item,nuix.Item> tieBreaker) +deduplicateCustomTieBreaker​(java.util.Collection<nuix.Item> items, +java.util.function.BiFunction<nuix.Item,​nuix.Item,​nuix.Item> tieBreaker)
        Custom deduplication implementation allowing code to specify which original is kept.
        nuix.ItemfindContainerAncestor(nuix.Item item) +findContainerAncestor​(nuix.Item item)
        Traverses up an item's path to locate the nearest ancestor container item (kind:container) or null if there is no container ancestor item.
        java.util.Set<nuix.Item>findContainerAncestors(java.util.Collection<nuix.Item> items) -
        Similar to findContainerAncestor(Item), but resolves nearest container ancestor items +
        		findContainerAncestors​(java.util.Collection<nuix.Item> items) +
        Similar to findContainerAncestor(Item), but resolves nearest container ancestor items for multiple items at once.
        java.util.Set<nuix.Item>findFamiliesWithoutItemsResponsiveToQuery​(nuix.Case nuixCase, +java.util.Collection<nuix.Item> inputItems, +java.lang.String itemsToRemoveQuery) 
        nuix.ItemfindPhysicalFileAncestor(nuix.Item item) +findPhysicalFileAncestor​(nuix.Item item)
        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.
        java.util.Set<nuix.Item>findPhysicalFileAncestors(java.util.Collection<nuix.Item> items) -
        Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items +
        		findPhysicalFileAncestors​(java.util.Collection<nuix.Item> items) +
        Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items for multiple items at once.
        static SuperItemUtilitygetInstance() 
        static SuperItemUtilitygetInstance() 
        java.util.List<nuix.Item>getItemsAndNeighboringSiblings​(java.util.List<nuix.Item> items, +int itemsBefore, +int itemsAfter) +
        Gets items and sibling items within a certain ordinal distance.
        +
        java.lang.StringgetPhysicalAncestorPath(nuix.Item item) +getPhysicalAncestorPath​(nuix.Item item)
        Returns the file system path of an item's physical file ancestor.
        booleanitemsAreSiblings(nuix.Item a, - nuix.Item b) +itemsAreSiblings​(nuix.Item a, +nuix.Item b)
        Tests whether 2 items have the same parent by comparing their tree position values
        java.util.Set<nuix.Item>removeItemsResponsiveToQuery​(nuix.Case nuixCase, +java.util.Collection<nuix.Item> inputItems, +java.lang.String itemsToRemoveQuery) +
        Convenience method for removing items responsive to a query from another collection of items.
        +
        voidsplitAndMaintainFamilies(java.util.Collection<nuix.Item> items, - int targetChunkSize, - java.util.function.Consumer<java.util.Collection<nuix.Item>> chunkConsumer) +splitAndMaintainFamilies​(java.util.Collection<nuix.Item> items, +int targetChunkSize, +java.util.function.Consumer<java.util.Collection<nuix.Item>> chunkConsumer)
        Splits a collection of items into a target chunk size, while maintaining families.
        java.util.Set<nuix.Item>unionMany(java.util.List<java.util.Collection<nuix.Item>> itemCollections) +unionMany​(java.util.List<java.util.Collection<nuix.Item>> itemCollections)
        Unions multiple collections of items into a single Set of items.
        -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - -
        • -

          unionMany

          -
          public java.util.Set<nuix.Item> unionMany(java.util.List<java.util.Collection<nuix.Item>> itemCollections)
          +
          +

          unionMany

          +
          public java.util.Set<nuix.Item> unionMany​(java.util.List<java.util.Collection<nuix.Item>> itemCollections)
          Unions multiple collections of items into a single Set of items.
          Parameters:
          @@ -245,15 +261,12 @@

          unionMany

          Returns:
          A set at most 1 of each item in the provided input item collections
          +
          • -
        - - - -
        • -

          findPhysicalFileAncestor

          -
          public nuix.Item findPhysicalFileAncestor(nuix.Item item)
          +
          +

          findPhysicalFileAncestor

          +
          public nuix.Item findPhysicalFileAncestor​(nuix.Item item)
          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.
          @@ -262,16 +275,13 @@

          findPhysicalFileAncestor

          Returns:
          The physical file ancestor item (if there is on) otherwise null
          +
          • -
        - - - -
        • -

          findPhysicalFileAncestors

          -
          public java.util.Set<nuix.Item> findPhysicalFileAncestors(java.util.Collection<nuix.Item> items)
          -
          Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items +
          +

          findPhysicalFileAncestors

          +
          public java.util.Set<nuix.Item> findPhysicalFileAncestors​(java.util.Collection<nuix.Item> items)
          +
          Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items for multiple items at once. Resulting set will not contain nulls.
          Parameters:
          @@ -279,15 +289,12 @@

          findPhysicalFileAncestors

          Returns:
          The physical file ancestors of the input items (if there were any)
          +
          • -
        - - - -
        • -

          findContainerAncestor

          -
          public nuix.Item findContainerAncestor(nuix.Item item)
          +
          +

          findContainerAncestor

          +
          public nuix.Item findContainerAncestor​(nuix.Item item)
          Traverses up an item's path to locate the nearest ancestor container item (kind:container) or null if there is no container ancestor item.
          @@ -296,16 +303,13 @@

          findContainerAncestor

          Returns:
          The nearest container ancestor of the input item or null if no container ancestor could be found
          +
          • -
        - - - -
        • -

          findContainerAncestors

          -
          public java.util.Set<nuix.Item> findContainerAncestors(java.util.Collection<nuix.Item> items)
          -
          Similar to findContainerAncestor(Item), but resolves nearest container ancestor items +
          +

          findContainerAncestors

          +
          public java.util.Set<nuix.Item> findContainerAncestors​(java.util.Collection<nuix.Item> items)
          +
          Similar to findContainerAncestor(Item), but resolves nearest container ancestor items for multiple items at once. Resulting set will not contain nulls.
          Parameters:
          @@ -313,17 +317,14 @@

          findContainerAncestors

          Returns:
          The nearest container ancestors of the input items.
          +
          • -
        - - - -
        • -

          splitAndMaintainFamilies

          -
          public void splitAndMaintainFamilies(java.util.Collection<nuix.Item> items,
-                                     int targetChunkSize,
-                                     java.util.function.Consumer<java.util.Collection<nuix.Item>> chunkConsumer)
          +
          +

          splitAndMaintainFamilies

          +
          public void splitAndMaintainFamilies​(java.util.Collection<nuix.Item> items, +int targetChunkSize, +java.util.function.Consumer<java.util.Collection<nuix.Item>> chunkConsumer)
          Splits a collection of items into a target chunk size, while maintaining families. Each chunk is passed as an argument to the provided chunkConsumer.
          @@ -333,16 +334,48 @@

          splitAndMaintainFamilies

          family boundaries land.
          chunkConsumer - A Consumer<Collection<Item>> which will receive each chunk as it is built.
          +
          +
          • +
        • +
          +

          removeItemsResponsiveToQuery

          +
          public java.util.Set<nuix.Item> removeItemsResponsiveToQuery​(nuix.Case nuixCase, +java.util.Collection<nuix.Item> inputItems, +java.lang.String itemsToRemoveQuery) + throws java.io.IOException
          +
          Convenience method for removing items responsive to a query from another collection of items. Internally this + method runs a search for the given query and then uses ItemUtility.difference to remove them from the provided + input items, returning the differenced result.
          +
          +
          Parameters:
          +
          nuixCase - The Nuix case (needed to run the search)
          +
          inputItems - The items from which you wish to remove items which are responsive to the given query
          +
          itemsToRemoveQuery - The query used to define items you wish to have removed form the input items
          +
          Returns:
          +
          The input items, with items responsive to the query removed
          +
          Throws:
          +
          java.io.IOException - Likely thrown if there is an issue with the provided query
          +
          +
          +
          • +
        • +
          +

          findFamiliesWithoutItemsResponsiveToQuery

          +
          public java.util.Set<nuix.Item> findFamiliesWithoutItemsResponsiveToQuery​(nuix.Case nuixCase, +java.util.Collection<nuix.Item> inputItems, +java.lang.String itemsToRemoveQuery) + throws java.io.IOException
          +
          +
          Throws:
          +
          java.io.IOException
          +
          +
          • -
        - - - -
        • -

          getPhysicalAncestorPath

          -
          public java.lang.String getPhysicalAncestorPath(nuix.Item item)
          -
          Returns the file system path of an item's physical file ancestor. Begins by calling findPhysicalFileAncestor(Item). +
          +

          getPhysicalAncestorPath

          +
          public java.lang.String getPhysicalAncestorPath​(nuix.Item item)
          +
          Returns the file system path of an item's physical file ancestor. Begins by calling findPhysicalFileAncestor(Item). If an physical file ancestor is located, then gets its URI and attempts to convert that to an actual file system path.
          Parameters:
          @@ -350,16 +383,13 @@

          getPhysicalAncestorPath

          Returns:
          The physical file ancestor file system path (if possible), otherwise null
          +
          • -
        - - - -
        • -

          deduplicateCustomTieBreaker

          -
          public java.util.Set<nuix.Item> deduplicateCustomTieBreaker(java.util.Collection<nuix.Item> items,
-                                                            java.util.function.BiFunction<nuix.Item,nuix.Item,nuix.Item> tieBreaker)
          +
          +

          deduplicateCustomTieBreaker

          +
          public java.util.Set<nuix.Item> deduplicateCustomTieBreaker​(java.util.Collection<nuix.Item> items, +java.util.function.BiFunction<nuix.Item,​nuix.Item,​nuix.Item> tieBreaker)
          Custom deduplication implementation allowing code to specify which original is kept. The normal behavior of ItemUtility.deduplicate is that the original with the earliest position value, amongst the items with the same MD5, is considered the original. This implementation allows code to provide a 2 argument function which will @@ -377,16 +407,13 @@

          deduplicateCustomTieBreaker

          Returns:
          A custom deduplicated set of items
          +
          • -
        - - - -
        • -

          itemsAreSiblings

          -
          public boolean itemsAreSiblings(nuix.Item a,
-                                nuix.Item b)
          +
          +

          itemsAreSiblings

          +
          public boolean itemsAreSiblings​(nuix.Item a, +nuix.Item b)
          Tests whether 2 items have the same parent by comparing their tree position values
          Parameters:
          @@ -395,25 +422,45 @@

          itemsAreSiblings

          Returns:
          True if items appear to have the same parent item based on their tree position values
          +
          • -
        +
      • +
        +

        getItemsAndNeighboringSiblings

        +
        public java.util.List<nuix.Item> getItemsAndNeighboringSiblings​(java.util.List<nuix.Item> items, +int itemsBefore, +int itemsAfter)
        +
        Gets items and sibling items within a certain ordinal distance.
        +
        +
        Parameters:
        +
        items - The items to obtain the neighboring siblings of
        +
        itemsBefore - How many siblings before each item to include
        +
        itemsAfter - How many siblings after each item to include
        +
        Returns:
        +
        A new list of items which includes both input items and neighboring siblings, sorted by position
        +
        +
      +
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/items/class-use/SuperItemUtility.html b/docs/com/nuix/superutilities/items/class-use/SuperItemUtility.html index 6479a91..2bfb2f2 100644 --- a/docs/com/nuix/superutilities/items/class-use/SuperItemUtility.html +++ b/docs/com/nuix/superutilities/items/class-use/SuperItemUtility.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.items.SuperItemUtility + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.items.SuperItemUtility

    +

    Uses of Class
    com.nuix.superutilities.items.SuperItemUtility

    -
    +
    + -
  • +
  • +
    -

    Uses of SuperItemUtility in com.nuix.superutilities.items

    - - +

    Uses of SuperItemUtility in com.nuix.superutilities.items

    +
    +
    Methods in com.nuix.superutilities.items that return SuperItemUtility 
    + + - + + + - - + + +
    Methods in com.nuix.superutilities.items that return SuperItemUtility 
    Modifier and TypeMethod and DescriptionMethodDescription
    static SuperItemUtilitySuperItemUtility.getInstance() static SuperItemUtilitySuperItemUtility.getInstance() 
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/items/package-summary.html b/docs/com/nuix/superutilities/items/package-summary.html index d832d8b..c8eda30 100644 --- a/docs/com/nuix/superutilities/items/package-summary.html +++ b/docs/com/nuix/superutilities/items/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.items + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.items

    +
    • - +
      +
      + + - +
      Class Summary 
      Class Description
      SuperItemUtilitySuperItemUtility
      Offers methods for working with items and item collections in the same spirit of the ItemUtility offered in the Nuix API.
      @@ -90,19 +86,24 @@

      Package com.nuix.superutilities.items
      +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/items/package-tree.html b/docs/com/nuix/superutilities/items/package-tree.html index 49f6c2c..8ce9724 100644 --- a/docs/com/nuix/superutilities/items/package-tree.html +++ b/docs/com/nuix/superutilities/items/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.items Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.items

    Package Hierarchies: @@ -76,25 +68,30 @@

    Hierarchy For Package com.nuix.superutilities.items

    +

    Class Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/items/package-use.html b/docs/com/nuix/superutilities/items/package-use.html index 3321390..4c227b2 100644 --- a/docs/com/nuix/superutilities/items/package-use.html +++ b/docs/com/nuix/superutilities/items/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.items + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.items

    -
    +
    +
    + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.items used by com.nuix.superutilities.items 
    + + - + + + - +
    Classes in com.nuix.superutilities.items used by com.nuix.superutilities.items 
    Class and DescriptionClassDescription
    SuperItemUtility +SuperItemUtility
    Offers methods for working with items and item collections in the same spirit of the ItemUtility offered in the Nuix API.
    +
    • + + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/DatLoadFile.html b/docs/com/nuix/superutilities/loadfiles/DatLoadFile.html index b70a8b4..d804923 100644 --- a/docs/com/nuix/superutilities/loadfiles/DatLoadFile.html +++ b/docs/com/nuix/superutilities/loadfiles/DatLoadFile.html @@ -1,42 +1,48 @@ - + DatLoadFile + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class DatLoadFile

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class DatLoadFile

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.DatLoadFile
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.DatLoadFile
      +
      +
      -
      public class DatLoadFile
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        DatLoadFile() DatLoadFile() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - - - + + + + + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static java.util.LinkedHashMap<java.lang.String,java.lang.String>fromLine(java.lang.String[] headers, - java.lang.String line) 
      static java.util.LinkedHashMap<java.lang.String,​java.lang.String>fromLine​(java.lang.String[] headers, +java.lang.String line) 
      static java.util.List<java.lang.String>getHeadersFromRecord(java.util.LinkedHashMap<java.lang.String,java.lang.String> record) getHeadersFromRecord​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record) 
      static java.lang.String[]splitLine(java.lang.String line) splitLine​(java.lang.String line) 
      static java.lang.StringtoHeaderLine(java.util.LinkedHashMap<java.lang.String,java.lang.String> record) toHeaderLine​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record) 
      static java.lang.StringtoHeaderLine(java.util.List<java.lang.String> headers) toHeaderLine​(java.util.List<java.lang.String> headers) 
      static java.lang.StringtoLine(java.util.LinkedHashMap<java.lang.String,java.lang.String> record) toLine​(java.lang.String[] values) 
      static java.lang.StringtoLine(java.lang.String[] values) toLine​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record) 
      static voidtranspose(java.io.File sourceFile, - java.io.File destinationFile, - java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,java.lang.String>> recordModifier) transpose​(java.io.File sourceFile, +java.io.File destinationFile, +java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,​java.lang.String>> recordModifier) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            DatLoadFile

            -
            public DatLoadFile()
            +
            +

            DatLoadFile

            +
            public DatLoadFile()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          splitLine

          -
          public static java.lang.String[] splitLine(java.lang.String line)
          +
          +

          splitLine

          +
          public static java.lang.String[] splitLine​(java.lang.String line)
          +
          • -
        - - - -
        • -

          fromLine

          -
          public static java.util.LinkedHashMap<java.lang.String,java.lang.String> fromLine(java.lang.String[] headers,
-                                                                                  java.lang.String line)
          +
          +

          fromLine

          +
          public static java.util.LinkedHashMap<java.lang.String,​java.lang.String> fromLine​(java.lang.String[] headers, +java.lang.String line)
          +
          • -
        - - - -
        • -

          toLine

          -
          public static java.lang.String toLine(java.util.LinkedHashMap<java.lang.String,java.lang.String> record)
          +
          +

          toLine

          +
          public static java.lang.String toLine​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record)
          +
          • -
        - - - -
        • -

          toLine

          -
          public static java.lang.String toLine(java.lang.String[] values)
          +
          +

          toLine

          +
          public static java.lang.String toLine​(java.lang.String[] values)
          +
          • -
        - - - -
        • -

          toHeaderLine

          -
          public static java.lang.String toHeaderLine(java.util.LinkedHashMap<java.lang.String,java.lang.String> record)
          +
          +

          toHeaderLine

          +
          public static java.lang.String toHeaderLine​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record)
          +
          • -
        - - - -
        • -

          toHeaderLine

          -
          public static java.lang.String toHeaderLine(java.util.List<java.lang.String> headers)
          +
          +

          toHeaderLine

          +
          public static java.lang.String toHeaderLine​(java.util.List<java.lang.String> headers)
          +
          • -
        - - - -
        • -

          getHeadersFromRecord

          -
          public static java.util.List<java.lang.String> getHeadersFromRecord(java.util.LinkedHashMap<java.lang.String,java.lang.String> record)
          +
          +

          getHeadersFromRecord

          +
          public static java.util.List<java.lang.String> getHeadersFromRecord​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record)
          +
          • -
        - - - -
        • -

          transpose

          -
          public static void transpose(java.io.File sourceFile,
-                             java.io.File destinationFile,
-                             java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,java.lang.String>> recordModifier)
-                      throws java.io.IOException
          +
          +

          transpose

          +
          public static void transpose​(java.io.File sourceFile, +java.io.File destinationFile, +java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,​java.lang.String>> recordModifier) + throws java.io.IOException
          Throws:
          java.io.IOException
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/DatLoadFileReader.html b/docs/com/nuix/superutilities/loadfiles/DatLoadFileReader.html index 086b8c7..8951c36 100644 --- a/docs/com/nuix/superutilities/loadfiles/DatLoadFileReader.html +++ b/docs/com/nuix/superutilities/loadfiles/DatLoadFileReader.html @@ -1,42 +1,48 @@ - + DatLoadFileReader + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class DatLoadFileReader

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class DatLoadFileReader

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.DatLoadFileReader
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.DatLoadFileReader
      +
      +
      -
      public class DatLoadFileReader
 extends java.lang.Object
      -
      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidwithEachRecord(java.io.File sourceFile, - java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,java.lang.String>> recordConsumer) withEachRecord​(java.io.File sourceFile, +java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,​java.lang.String>> recordConsumer) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            DatLoadFileReader

            -
            public DatLoadFileReader()
            +
            +

            DatLoadFileReader

            +
            public DatLoadFileReader()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            withEachRecord

            -
            public static void withEachRecord(java.io.File sourceFile,
-                                  java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,java.lang.String>> recordConsumer)
-                           throws java.io.IOException
            +
            +

            withEachRecord

            +
            public static void withEachRecord​(java.io.File sourceFile, +java.util.function.Consumer<java.util.LinkedHashMap<java.lang.String,​java.lang.String>> recordConsumer) + throws java.io.IOException
            Throws:
            java.io.IOException
            +
          +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/DatLoadFileWriter.html b/docs/com/nuix/superutilities/loadfiles/DatLoadFileWriter.html index af9b611..57bb55a 100644 --- a/docs/com/nuix/superutilities/loadfiles/DatLoadFileWriter.html +++ b/docs/com/nuix/superutilities/loadfiles/DatLoadFileWriter.html @@ -1,42 +1,48 @@ - + DatLoadFileWriter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class DatLoadFileWriter

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class DatLoadFileWriter

    - -
    - -
    -
    +extends SimpleTextFileWriter + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        DatLoadFileWriter(java.io.File destinationFile) DatLoadFileWriter​(java.io.File destinationFile) 
        +
    + - -
    +
    +
    +

    Methods inherited from class com.nuix.superutilities.loadfiles.SimpleTextFileWriter

    + - +close, getDestinationFile, writeLine
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            DatLoadFileWriter

            -
            public DatLoadFileWriter(java.io.File destinationFile)
-                  throws java.io.IOException
            +
            +

            DatLoadFileWriter

            +
            public DatLoadFileWriter​(java.io.File destinationFile) + throws java.io.IOException
            Throws:
            java.io.IOException
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - - - -
        • -

          writeDatLine

          -
          public void writeDatLine(java.lang.String[] values)
          -
          • -
        - +
        +

        Method Details

        • -

          writeRecordValues

          -
          public void writeRecordValues(java.util.LinkedHashMap<java.lang.String,java.lang.String> record)
          +
          +

          writeDatLine

          +
          public void writeDatLine​(java.lang.String[] values)
          +
          • -
        - - - -
        • -

          writeRecordKeys

          -
          public void writeRecordKeys(java.util.LinkedHashMap<java.lang.String,java.lang.String> record)
          +
          +

          writeRecordValues

          +
          public void writeRecordValues​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record)
          +
          • -
        - - - -
        • -

          writeValues

          -
          public void writeValues(java.util.List<java.lang.String> headers)
          +
          +

          writeRecordKeys

          +
          public void writeRecordKeys​(java.util.LinkedHashMap<java.lang.String,​java.lang.String> record)
          +
          • -
        +
      • +
        +

        writeValues

        +
        public void writeValues​(java.util.List<java.lang.String> headers)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/OptLoadFile.html b/docs/com/nuix/superutilities/loadfiles/OptLoadFile.html index 6f33f93..8bda2e8 100644 --- a/docs/com/nuix/superutilities/loadfiles/OptLoadFile.html +++ b/docs/com/nuix/superutilities/loadfiles/OptLoadFile.html @@ -1,42 +1,48 @@ - + OptLoadFile + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class OptLoadFile

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class OptLoadFile

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.OptLoadFile
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.OptLoadFile
      +
      +
      -
      public class OptLoadFile
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        OptLoadFile() OptLoadFile() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            OptLoadFile

            -
            public OptLoadFile()
            +
            +

            OptLoadFile

            +
            public OptLoadFile()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          fromFile

          -
          public static OptLoadFile fromFile(java.lang.String sourceFile)
-                            throws java.io.IOException
          +
          +

          fromFile

          +
          public static OptLoadFile fromFile​(java.lang.String sourceFile) + throws java.io.IOException
          Throws:
          java.io.IOException
          +
          • -
        - - - -
        • -

          fromFile

          -
          public static OptLoadFile fromFile(java.io.File sourceFile)
-                            throws java.io.IOException
          +
          +

          fromFile

          +
          public static OptLoadFile fromFile​(java.io.File sourceFile) + throws java.io.IOException
          Throws:
          java.io.IOException
          +
          • -
        - - - -
        • -

          toFile

          -
          public void toFile(java.io.File destinationFile)
-            throws java.io.IOException
          +
          +

          toFile

          +
          public void toFile​(java.io.File destinationFile) + throws java.io.IOException
          Throws:
          java.io.IOException
          +
          • -
        - - - -
        • -

          transpose

          -
          public static void transpose(java.io.File sourceFile,
-                             java.io.File destinationFile,
-                             java.util.function.Consumer<OptRecord> recordModifier)
-                      throws java.io.IOException
          +
          +

          transpose

          +
          public static void transpose​(java.io.File sourceFile, +java.io.File destinationFile, +java.util.function.Consumer<OptRecord> recordModifier) + throws java.io.IOException
          Throws:
          java.io.IOException
          +
          • -
        - - - -
        • -

          getVolumeNames

          -
          public java.util.Set<java.lang.String> getVolumeNames()
          +
          +

          getVolumeNames

          +
          public java.util.Set<java.lang.String> getVolumeNames()
          +
          • -
        - - - - - - - - - - - -
        • -

          setRecords

          -
          public void setRecords(java.util.List<OptRecord> records)
          +
          +

          setRecords

          +
          public void setRecords​(java.util.List<OptRecord> records)
          +
          • -
        - - - -
        • -

          addRecord

          -
          public void addRecord(OptRecord record)
          -
          • -
        +
        +

        addRecord

        +
        public void addRecord​(OptRecord record)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/OptRecord.html b/docs/com/nuix/superutilities/loadfiles/OptRecord.html index bc3a951..011a085 100644 --- a/docs/com/nuix/superutilities/loadfiles/OptRecord.html +++ b/docs/com/nuix/superutilities/loadfiles/OptRecord.html @@ -1,42 +1,48 @@ - + OptRecord + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class OptRecord

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class OptRecord

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.OptRecord
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.OptRecord
      +
      +
      -
      public class OptRecord
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        OptRecord() OptRecord() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            OptRecord

            -
            public OptRecord()
            +
            +

            OptRecord

            +
            public OptRecord()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - - - -
        • -

          fromLine

          -
          public static OptRecord fromLine(java.lang.String line)
          -
          • -
        - +
        +

        Method Details

        • -

          toLine

          -
          public java.lang.String toLine()
          +
          +

          fromLine

          +
          public static OptRecord fromLine​(java.lang.String line)
          +
          • -
        - - - -
        • -

          getId

          -
          public java.lang.String getId()
          +
          +

          toLine

          +
          public java.lang.String toLine()
          +
          • -
        - - - -
        • -

          setId

          -
          public void setId(java.lang.String id)
          +
          +

          getId

          +
          public java.lang.String getId()
          +
          • -
        - - - -
        • -

          getVolume

          -
          public java.lang.String getVolume()
          +
          +

          setId

          +
          public void setId​(java.lang.String id)
          +
          • -
        - - - -
        • -

          setVolume

          -
          public void setVolume(java.lang.String volume)
          +
          +

          getVolume

          +
          public java.lang.String getVolume()
          +
          • -
        - - - -
        • -

          getPath

          -
          public java.lang.String getPath()
          +
          +

          setVolume

          +
          public void setVolume​(java.lang.String volume)
          +
          • -
        - - - -
        • -

          setPath

          -
          public void setPath(java.lang.String path)
          +
          +

          getPath

          +
          public java.lang.String getPath()
          +
          • -
        - - - -
        • -

          isFirstPage

          -
          public boolean isFirstPage()
          +
          +

          setPath

          +
          public void setPath​(java.lang.String path)
          +
          • -
        - - - -
        • -

          setFirstPage

          -
          public void setFirstPage(boolean firstPage)
          +
          +

          isFirstPage

          +
          public boolean isFirstPage()
          +
          • -
        - - - -
        • -

          getBox

          -
          public java.lang.String getBox()
          +
          +

          setFirstPage

          +
          public void setFirstPage​(boolean firstPage)
          +
          • -
        - - - -
        • -

          setBox

          -
          public void setBox(java.lang.String box)
          +
          +

          getBox

          +
          public java.lang.String getBox()
          +
          • -
        - - - -
        • -

          getFolder

          -
          public java.lang.String getFolder()
          +
          +

          setBox

          +
          public void setBox​(java.lang.String box)
          +
          • -
        - - - -
        • -

          setFolder

          -
          public void setFolder(java.lang.String folder)
          +
          +

          getFolder

          +
          public java.lang.String getFolder()
          +
          • -
        - - - -
        • -

          getPages

          -
          public int getPages()
          +
          +

          setFolder

          +
          public void setFolder​(java.lang.String folder)
          +
          • -
        - - - -
        • -

          setPages

          -
          public void setPages(int pages)
          +
          +

          getPages

          +
          public int getPages()
          +
          • -
        +
      • +
        +

        setPages

        +
        public void setPages​(int pages)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/SimpleTextFileReader.html b/docs/com/nuix/superutilities/loadfiles/SimpleTextFileReader.html index da1be54..8ebb1b8 100644 --- a/docs/com/nuix/superutilities/loadfiles/SimpleTextFileReader.html +++ b/docs/com/nuix/superutilities/loadfiles/SimpleTextFileReader.html @@ -1,42 +1,48 @@ - + SimpleTextFileReader + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class SimpleTextFileReader

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class SimpleTextFileReader

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.SimpleTextFileReader
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.SimpleTextFileReader
      +
      +
      -
      public class SimpleTextFileReader
 extends java.lang.Object
      -
      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidwithEachLine(java.io.File sourceFile, - java.util.function.Consumer<java.lang.String> consumer) withEachLine​(java.io.File sourceFile, +java.util.function.Consumer<java.lang.String> consumer) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            SimpleTextFileReader

            -
            public SimpleTextFileReader()
            +
            +

            SimpleTextFileReader

            +
            public SimpleTextFileReader()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            withEachLine

            -
            public static void withEachLine(java.io.File sourceFile,
-                                java.util.function.Consumer<java.lang.String> consumer)
-                         throws java.io.IOException
            +
            +

            withEachLine

            +
            public static void withEachLine​(java.io.File sourceFile, +java.util.function.Consumer<java.lang.String> consumer) + throws java.io.IOException
            Throws:
            java.io.IOException
            +
          +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/SimpleTextFileWriter.html b/docs/com/nuix/superutilities/loadfiles/SimpleTextFileWriter.html index dcc2cdd..f044585 100644 --- a/docs/com/nuix/superutilities/loadfiles/SimpleTextFileWriter.html +++ b/docs/com/nuix/superutilities/loadfiles/SimpleTextFileWriter.html @@ -1,42 +1,48 @@ - + SimpleTextFileWriter + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.loadfiles
    -

    Class SimpleTextFileWriter

    +
    Package com.nuix.superutilities.loadfiles
    +

    Class SimpleTextFileWriter

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.loadfiles.SimpleTextFileWriter
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.loadfiles.SimpleTextFileWriter
      +
      +
      All Implemented Interfaces:
      -
      java.io.Closeable, java.lang.AutoCloseable
      +
      java.io.Closeable, java.lang.AutoCloseable
      Direct Known Subclasses:
      -
      DatLoadFileWriter
      +
      DatLoadFileWriter
      -
      public class SimpleTextFileWriter
 extends java.lang.Object
 implements java.io.Closeable
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        SimpleTextFileWriter(java.io.File destinationFile) SimpleTextFileWriter​(java.io.File destinationFile) 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            SimpleTextFileWriter

            -
            public SimpleTextFileWriter(java.io.File destinationFile)
-                     throws java.io.IOException
            +
            +

            SimpleTextFileWriter

            +
            public SimpleTextFileWriter​(java.io.File destinationFile) + throws java.io.IOException
            Throws:
            java.io.IOException
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          writeLine

          -
          public void writeLine(java.lang.String line)
          +
          +

          writeLine

          +
          public void writeLine​(java.lang.String line)
          +
          • -
        - - - -
        • -

          getDestinationFile

          -
          public java.io.File getDestinationFile()
          +
          +

          getDestinationFile

          +
          public java.io.File getDestinationFile()
          +
          • -
        - - - -
        • -

          close

          -
          public void close()
-           throws java.io.IOException
          +
          +

          close

          +
          public void close() + throws java.io.IOException
          Specified by:
          -
          close in interface java.io.Closeable
          -
          Specified by:
          close in interface java.lang.AutoCloseable
          +
          Specified by:
          +
          close in interface java.io.Closeable
          Throws:
          java.io.IOException
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFile.html b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFile.html index cb88db3..b5498f8 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFile.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFile.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.DatLoadFile + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFile

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFile

    No usage of com.nuix.superutilities.loadfiles.DatLoadFile
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileReader.html b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileReader.html index 28abf7c..2f94818 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileReader.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileReader.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.DatLoadFileReader + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFileReader

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFileReader

    No usage of com.nuix.superutilities.loadfiles.DatLoadFileReader
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileWriter.html b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileWriter.html index 8c63dba..e4affa2 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileWriter.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/DatLoadFileWriter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.DatLoadFileWriter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFileWriter

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.DatLoadFileWriter

    No usage of com.nuix.superutilities.loadfiles.DatLoadFileWriter
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/OptLoadFile.html b/docs/com/nuix/superutilities/loadfiles/class-use/OptLoadFile.html index 7d390b7..c416f74 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/OptLoadFile.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/OptLoadFile.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.OptLoadFile + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.OptLoadFile

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.OptLoadFile

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/OptRecord.html b/docs/com/nuix/superutilities/loadfiles/class-use/OptRecord.html index 794d83e..fc9df16 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/OptRecord.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/OptRecord.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.OptRecord + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.OptRecord

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.OptRecord

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileReader.html b/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileReader.html index 579bc58..4e350fe 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileReader.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileReader.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.SimpleTextFileReader + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.SimpleTextFileReader

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.SimpleTextFileReader

    No usage of com.nuix.superutilities.loadfiles.SimpleTextFileReader
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileWriter.html b/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileWriter.html index 532be48..7c320ce 100644 --- a/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileWriter.html +++ b/docs/com/nuix/superutilities/loadfiles/class-use/SimpleTextFileWriter.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.loadfiles.SimpleTextFileWriter + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.loadfiles.SimpleTextFileWriter

    +

    Uses of Class
    com.nuix.superutilities.loadfiles.SimpleTextFileWriter

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/loadfiles/package-summary.html b/docs/com/nuix/superutilities/loadfiles/package-summary.html index 4f08524..96d206a 100644 --- a/docs/com/nuix/superutilities/loadfiles/package-summary.html +++ b/docs/com/nuix/superutilities/loadfiles/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.loadfiles + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.loadfiles

    +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/loadfiles/package-tree.html b/docs/com/nuix/superutilities/loadfiles/package-tree.html index f5767cc..3c6212c 100644 --- a/docs/com/nuix/superutilities/loadfiles/package-tree.html +++ b/docs/com/nuix/superutilities/loadfiles/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.loadfiles Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.loadfiles

    Package Hierarchies: @@ -76,34 +68,39 @@

    Hierarchy For Package com.nuix.superutilities.loadfiles

    +

    Class Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/loadfiles/package-use.html b/docs/com/nuix/superutilities/loadfiles/package-use.html index b84dde6..e50bce0 100644 --- a/docs/com/nuix/superutilities/loadfiles/package-use.html +++ b/docs/com/nuix/superutilities/loadfiles/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.loadfiles + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.loadfiles

    -
    +
    +
    + +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/DigestList.html b/docs/com/nuix/superutilities/misc/DigestList.html index d89f35a..11a8054 100644 --- a/docs/com/nuix/superutilities/misc/DigestList.html +++ b/docs/com/nuix/superutilities/misc/DigestList.html @@ -1,42 +1,48 @@ - + DigestList + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class DigestList

    +
    Package com.nuix.superutilities.misc
    +

    Class DigestList

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.DigestList
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.DigestList
      +
      +
      All Implemented Interfaces:
      -
      java.lang.Iterable<java.lang.String>
      +
      java.lang.Iterable<java.lang.String>
      -
      public class DigestList
 extends java.lang.Object
 implements java.lang.Iterable<java.lang.String>
      @@ -123,291 +107,321 @@

      Class DigestList

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        DigestList() +DigestList()
        Creates a new empty instance.
        DigestList(java.io.File... sourceFiles) +DigestList​(java.io.File... sourceFiles)
        Creates a new instance and then imports digests from each provided source Nuix binary digest list file by iteratively - calling importFile(File) for each.
        + calling importFile(File) for each.
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidaddItem(nuix.Item item) +addItem​(nuix.Item item)
      Adds the MD5 of the provided item to this instance (if not already present).
      voidaddItems(java.util.Collection<nuix.Item> items) +addItems​(java.util.Collection<nuix.Item> items)
      Adds the MD5s of the provided items to this instance (if not already present).
      voidaddMd5(byte[] md5Bytes) +addMd5​(byte[] md5Bytes)
      Adds the given MD5 to this instance (if not already present).
      voidaddMd5(java.lang.String md5) +addMd5​(java.lang.String md5)
      Adds the given MD5 to this instance (if not already present).
      static voidcombineDigestFiles(java.io.File outputFile, - java.util.Collection<java.io.File> inputFiles) +combineDigestFiles​(java.io.File outputFile, +java.util.Collection<java.io.File> inputFiles)
      Create a new digest list file from multiple source digest lists.
      static voidcombineDigestFiles(java.lang.String outputFile, - java.util.Collection<java.lang.String> inputFiles) +combineDigestFiles​(java.lang.String outputFile, +java.util.Collection<java.lang.String> inputFiles)
      Create a new digest list file from multiple source digest lists.
      booleancontainsMd5(byte[] md5Bytes) +containsMd5​(byte[] md5Bytes)
      Gets whether the given MD5 is present in this instance.
      booleancontainsMd5(java.lang.String md5) +containsMd5​(java.lang.String md5)
      Gets whether the given MD5 is present in this instance.
      static voideachDigest(java.io.File sourceDigestList, - java.util.function.Consumer<java.lang.String> md5StringConsumer) +eachDigest​(java.io.File sourceDigestList, +java.util.function.Consumer<java.lang.String> md5StringConsumer)
      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.
      java.util.Set<nuix.Item>findMatchingItems(nuix.Case nuixCase) +findMatchingItems​(nuix.Case nuixCase)
      Finds items in given case which have MD5s matching those found in this instance.
      java.util.Set<nuix.Item>findMatchingItems(nuix.Case nuixCase, - int chunkSize) +findMatchingItems​(nuix.Case nuixCase, +int chunkSize)
      Finds items in given case which have MD5s matching those found in this instance.
      static intgetDigestCount(java.io.File sourceDigestList) +getDigestCount​(java.io.File sourceDigestList)
      Returns a count of digests present in the given Nuix binary digest list file.
      intimportCaseLevelDigestList(nuix.Case nuixCase, - java.lang.String name) +importCaseLevelDigestList​(nuix.Case nuixCase, +java.lang.String name)
      Imports digests from a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
      intimportFile(java.io.File digestListFile) +importFile​(java.io.File digestListFile)
      Imports digests found in given input file to this instance (if not already present).
      intimportFile(java.lang.String digestListFile) +importFile​(java.lang.String digestListFile)
      Imports digests found in given input file to this instance (if not already present).
      intimportSystemLevelDigestList(java.lang.String name) +importSystemLevelDigestList​(java.lang.String name)
      Imports digests from a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location).
      intimportUserLevelDigestList(java.lang.String name) +importUserLevelDigestList​(java.lang.String name)
      Imports digests from a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location).
      java.util.Iterator<java.lang.String>iterator() +iterator()
      Provides an iterator over the hexadecimal string versions of the MD5s present in this instance.
      voidremoveItem(nuix.Item item) +removeItem​(nuix.Item item)
      Removes MD5 of provided item from this instance.
      voidremoveItems(java.util.Collection<nuix.Item> items) +removeItems​(java.util.Collection<nuix.Item> items)
      Removes MD5s from this instance based on the MD5s of the given items.
      voidremoveMd5(byte[] md5Bytes) +removeMd5​(byte[] md5Bytes)
      Removes the given MD5 from this instance.
      voidremoveMd5(java.lang.String md5) +removeMd5​(java.lang.String md5)
      Removes the given MD5 from this instance.
      voidsaveCaseLevelDigestList(nuix.Case nuixCase, - java.lang.String name) +saveCaseLevelDigestList​(nuix.Case nuixCase, +java.lang.String name)
      Saves a new digest list to a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
      voidsaveFile(java.io.File digestListFile) +saveFile​(java.io.File digestListFile)
      Saves a new Nuix binary digest list based on the digests stored in memory of this instance.
      voidsaveSystemLevelDigestList(java.lang.String name) +saveSystemLevelDigestList​(java.lang.String name)
      Saves a new digest list to a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location).
      voidsaveUserLevelDigestList(java.lang.String name) +saveUserLevelDigestList​(java.lang.String name)
      Saves a new digest list to a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location).
      intsize() +size()
      Gets the count of digests present in this instance.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - -
      -
    • + - +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +

    Methods inherited from interface java.lang.Iterable

    -forEach, spliterator - - - + + +forEach, spliterator
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          DigestList

          -
          public DigestList()
          +
          +

          DigestList

          +
          public DigestList()
          Creates a new empty instance.
          +
          • -
        - - - -
        • -

          DigestList

          -
          public DigestList(java.io.File... sourceFiles)
-           throws java.lang.Exception
          +
          +

          DigestList

          +
          public DigestList​(java.io.File... sourceFiles) + throws java.lang.Exception
          Creates a new instance and then imports digests from each provided source Nuix binary digest list file by iteratively - calling importFile(File) for each.
          + calling importFile(File) for each.
    Parameters:
    sourceFiles - One or more Nuix binary digest list files to import into this instance.
    Throws:
    java.lang.Exception - Thrown if there is an error while importing any digest list file.
    + + - -
      -
    • - - -

      Method Detail

      - +
    • +
      +

      Method Details

      • -

        saveFile

        -
        public void saveFile(java.io.File digestListFile)
-              throws java.lang.Exception
        +
        +

        saveFile

        +
        public void saveFile​(java.io.File digestListFile) + throws java.lang.Exception
        Saves a new Nuix binary digest list based on the digests stored in memory of this instance. Will overwrite existing files.
        Parameters:
        @@ -415,16 +429,13 @@

        saveFile

        Throws:
        java.lang.Exception - Thrown most likely if there are IO errors.
        +
        • -
      - - - -
      • -

        importFile

        -
        public int importFile(java.lang.String digestListFile)
-               throws java.lang.Exception
        +
        +

        importFile

        +
        public int importFile​(java.lang.String digestListFile) + throws java.lang.Exception
        Imports digests found in given input file to this instance (if not already present).
        Parameters:
        @@ -435,17 +446,14 @@

        importFile

        Throws:
        java.lang.Exception - Thrown most likely due to IO errors.
        +
        • -
      - - - -
      • -

        combineDigestFiles

        -
        public static void combineDigestFiles(java.io.File outputFile,
-                                      java.util.Collection<java.io.File> inputFiles)
-                               throws java.lang.Exception
        +
        +

        combineDigestFiles

        +
        public static void combineDigestFiles​(java.io.File outputFile, +java.util.Collection<java.io.File> inputFiles) + throws java.lang.Exception
        Create a new digest list file from multiple source digest lists. A convenience method for the process of creating a new DigestList instance, importing each source digest list and then saving the combined imported results to a new output digest list.
        @@ -456,17 +464,14 @@

        combineDigestFiles

        Throws:
        java.lang.Exception - Thrown if an exception occurs while importing or saving combined result.
        +
        • -
      - - - -
      • -

        combineDigestFiles

        -
        public static void combineDigestFiles(java.lang.String outputFile,
-                                      java.util.Collection<java.lang.String> inputFiles)
-                               throws java.lang.Exception
        +
        +

        combineDigestFiles

        +
        public static void combineDigestFiles​(java.lang.String outputFile, +java.util.Collection<java.lang.String> inputFiles) + throws java.lang.Exception
        Create a new digest list file from multiple source digest lists. A convenience method for the process of creating a new DigestList instance, importing each source digest list and then saving the combined imported results to a new output digest list.
        @@ -477,17 +482,14 @@

        combineDigestFiles

        Throws:
        java.lang.Exception - Thrown if an exception occurs while importing or saving combined result.
        +
        • -
      - - - -
      • -

        eachDigest

        -
        public static void eachDigest(java.io.File sourceDigestList,
-                              java.util.function.Consumer<java.lang.String> md5StringConsumer)
-                       throws java.lang.Exception
        +
        +

        eachDigest

        +
        public static void eachDigest​(java.io.File sourceDigestList, +java.util.function.Consumer<java.lang.String> md5StringConsumer) + throws java.lang.Exception
        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.
        @@ -497,15 +499,12 @@

        eachDigest

        Throws:
        java.lang.Exception - Most likely thrown if there are IO errors while reading from the source file.
        +
        • -
      - - - -
      • -

        getDigestCount

        -
        public static int getDigestCount(java.io.File sourceDigestList)
        +
        +

        getDigestCount

        +
        public static int getDigestCount​(java.io.File sourceDigestList)
        Returns a count of digests present in the given Nuix binary digest list file. This is really just a convenience for the calculation:

        DIGEST_COUNT = (FILE_SIZE_BYTES - 13) / 16
        @@ -515,16 +514,13 @@

        getDigestCount

        Returns:
        The number of digest lists present in the given file based on file size in bytes.
        +
        • -
      - - - -
      • -

        importFile

        -
        public int importFile(java.io.File digestListFile)
-               throws java.lang.Exception
        +
        +

        importFile

        +
        public int importFile​(java.io.File digestListFile) + throws java.lang.Exception
        Imports digests found in given input file to this instance (if not already present).
        Parameters:
        @@ -535,17 +531,14 @@

        importFile

        Throws:
        java.lang.Exception - Thrown most likely due to IO errors.
        +
        • -
      - - - -
      • -

        saveCaseLevelDigestList

        -
        public void saveCaseLevelDigestList(nuix.Case nuixCase,
-                                    java.lang.String name)
-                             throws java.lang.Exception
        +
        +

        saveCaseLevelDigestList

        +
        public void saveCaseLevelDigestList​(nuix.Case nuixCase, +java.lang.String name) + throws java.lang.Exception
        Saves a new digest list to a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location). If digest list file already exists, it will be overwritten.
        @@ -555,16 +548,13 @@

        saveCaseLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there is an error while saving.
        +
        • -
      - - - -
      • -

        saveUserLevelDigestList

        -
        public void saveUserLevelDigestList(java.lang.String name)
-                             throws java.lang.Exception
        +
        +

        saveUserLevelDigestList

        +
        public void saveUserLevelDigestList​(java.lang.String name) + throws java.lang.Exception
        Saves a new digest list to a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location). If digest list file already exists, it will be overwritten.
        @@ -573,16 +563,13 @@

        saveUserLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there is an error while saving.
        +
        • -
      - - - -
      • -

        saveSystemLevelDigestList

        -
        public void saveSystemLevelDigestList(java.lang.String name)
-                               throws java.lang.Exception
        +
        +

        saveSystemLevelDigestList

        +
        public void saveSystemLevelDigestList​(java.lang.String name) + throws java.lang.Exception
        Saves a new digest list to a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location). If digest list file already exists, it will be overwritten.
        @@ -591,17 +578,14 @@

        saveSystemLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there is an error while saving.
        +
        • -
      - - - -
      • -

        importCaseLevelDigestList

        -
        public int importCaseLevelDigestList(nuix.Case nuixCase,
-                                     java.lang.String name)
-                              throws java.lang.Exception
        +
        +

        importCaseLevelDigestList

        +
        public int importCaseLevelDigestList​(nuix.Case nuixCase, +java.lang.String name) + throws java.lang.Exception
        Imports digests from a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
        Parameters:
        @@ -613,16 +597,13 @@

        importCaseLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there was an error while importing.
        +
        • -
      - - - -
      • -

        importUserLevelDigestList

        -
        public int importUserLevelDigestList(java.lang.String name)
-                              throws java.lang.Exception
        +
        +

        importUserLevelDigestList

        +
        public int importUserLevelDigestList​(java.lang.String name) + throws java.lang.Exception
        Imports digests from a file located at "%appdata%\Nuix\Digest Lists\[NAME].hash" (user level digest list location).
        Parameters:
        @@ -633,16 +614,13 @@

        importUserLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there was an error while importing.
        +
        • -
      - - - -
      • -

        importSystemLevelDigestList

        -
        public int importSystemLevelDigestList(java.lang.String name)
-                                throws java.lang.Exception
        +
        +

        importSystemLevelDigestList

        +
        public int importSystemLevelDigestList​(java.lang.String name) + throws java.lang.Exception
        Imports digests from a file located at "%programdata%\Nuix\Digest Lists\[NAME].hash" (system level digest list location).
        Parameters:
        @@ -653,129 +631,102 @@

        importSystemLevelDigestList

        Throws:
        java.lang.Exception - Thrown if there was an error while importing.
        +
        • -
      - - - -
      • -

        addItem

        -
        public void addItem(nuix.Item item)
        +
        +

        addItem

        +
        public void addItem​(nuix.Item item)
        Adds the MD5 of the provided item to this instance (if not already present). If the item has no MD5 it is ignored.
        Parameters:
        item - The item for which the MD5 of will be added to this instance.
        +
        • -
      - - - -
      • -

        addItems

        -
        public void addItems(java.util.Collection<nuix.Item> items)
        +
        +

        addItems

        +
        public void addItems​(java.util.Collection<nuix.Item> items)
        Adds the MD5s of the provided items to this instance (if not already present). Items without and MD5 value are ignored.
        Parameters:
        items - The items for which the MD5s will be added to this instance.
        +
        • -
      - - - -
      • -

        removeItem

        -
        public void removeItem(nuix.Item item)
        +
        +

        removeItem

        +
        public void removeItem​(nuix.Item item)
        Removes MD5 of provided item from this instance. If the item has no MD5, it is ignored.
        Parameters:
        item - The item for which the MD5 will be removed from this instance.
        +
        • -
      - - - -
      • -

        removeItems

        -
        public void removeItems(java.util.Collection<nuix.Item> items)
        +
        +

        removeItems

        +
        public void removeItems​(java.util.Collection<nuix.Item> items)
        Removes MD5s from this instance based on the MD5s of the given items. Items without an MD5 value are ignored.
        Parameters:
        items - The items for which MD5s will be removed from this instance.
        +
        • -
      - - - -
      • -

        addMd5

        -
        public void addMd5(java.lang.String md5)
        +
        +

        addMd5

        +
        public void addMd5​(java.lang.String md5)
        Adds the given MD5 to this instance (if not already present).
        Parameters:
        md5 - Hexadecimal string of MD5 to add to this instance.
        +
        • -
      - - - -
      • -

        addMd5

        -
        public void addMd5(byte[] md5Bytes)
        +
        +

        addMd5

        +
        public void addMd5​(byte[] md5Bytes)
        Adds the given MD5 to this instance (if not already present).
        Parameters:
        md5Bytes - Byte array of MD5 to add to this instance.
        +
        • -
      - - - -
      • -

        removeMd5

        -
        public void removeMd5(java.lang.String md5)
        +
        +

        removeMd5

        +
        public void removeMd5​(java.lang.String md5)
        Removes the given MD5 from this instance.
        Parameters:
        md5 - MD5 string to remove.
        +
        • -
      - - - -
      • -

        removeMd5

        -
        public void removeMd5(byte[] md5Bytes)
        +
        +

        removeMd5

        +
        public void removeMd5​(byte[] md5Bytes)
        Removes the given MD5 from this instance.
        Parameters:
        md5Bytes - MD5 byte array to remove.
        +
        • -
      - - - -
      • -

        containsMd5

        -
        public boolean containsMd5(byte[] md5Bytes)
        +
        +

        containsMd5

        +
        public boolean containsMd5​(byte[] md5Bytes)
        Gets whether the given MD5 is present in this instance.
        Parameters:
        @@ -783,15 +734,12 @@

        containsMd5

        Returns:
        True if the given MD5 is present in this instance.
        +
        • -
      - - - -
      • -

        containsMd5

        -
        public boolean containsMd5(java.lang.String md5)
        +
        +

        containsMd5

        +
        public boolean containsMd5​(java.lang.String md5)
        Gets whether the given MD5 is present in this instance.
        Parameters:
        @@ -799,31 +747,25 @@

        containsMd5

        Returns:
        True if the given MD5 is present in this instance.
        +
        • -
      - - - -
      • -

        size

        -
        public int size()
        +
        +

        size

        +
        public int size()
        Gets the count of digests present in this instance.
        Returns:
        The number of digests present.
        +
        • -
      - - - -
      • -

        findMatchingItems

        -
        public java.util.Set<nuix.Item> findMatchingItems(nuix.Case nuixCase,
-                                                  int chunkSize)
-                                           throws java.lang.Exception
        +
        +

        findMatchingItems

        +
        public java.util.Set<nuix.Item> findMatchingItems​(nuix.Case nuixCase, +int chunkSize) + throws java.lang.Exception
        Finds items in given case which have MD5s matching those found in this instance. Searches for MD5 values rather than using "digest-list" search field, meaning this digest list does not need to exist as a file in a location Nuix can find it, it can exist purely in memory. Searches are ran using a query like "md5:(md5A OR md5B OR ...)" with chunkSize determining how many MD5s max are submit in any @@ -839,16 +781,13 @@

        findMatchingItems

        Throws:
        java.lang.Exception - If there is an error while searching for a chunk of items.
        +
        • -
      - - - -
      • -

        findMatchingItems

        -
        public java.util.Set<nuix.Item> findMatchingItems(nuix.Case nuixCase)
-                                           throws java.lang.Exception
        +
        +

        findMatchingItems

        +
        public java.util.Set<nuix.Item> findMatchingItems​(nuix.Case nuixCase) + throws java.lang.Exception
        Finds items in given case which have MD5s matching those found in this instance. Searches for MD5 values rather than using "digest-list" search field, meaning this digest list does not need to exist as a file in a location Nuix can find it, it can exist purely in memory. Searches are ran using a query like "md5:(md5A OR md5B OR ...)" with chunkSize determining how many MD5s max are submit in any @@ -863,40 +802,40 @@

        findMatchingItems

        Throws:
        java.lang.Exception - If there is an error while searching for a chunk of items.
        +
        • -
      - - - -
      • -

        iterator

        -
        public java.util.Iterator<java.lang.String> iterator()
        +
        +

        iterator

        +
        public java.util.Iterator<java.lang.String> iterator()
        Provides an iterator over the hexadecimal string versions of the MD5s present in this instance. MD5 values iterate in order of MD5 values, based on comparison logic of ByteBuffer.
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>
        +
      +
    - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/DriveSpaceInfo.html b/docs/com/nuix/superutilities/misc/DriveSpaceInfo.html index 5418597..4ccf233 100644 --- a/docs/com/nuix/superutilities/misc/DriveSpaceInfo.html +++ b/docs/com/nuix/superutilities/misc/DriveSpaceInfo.html @@ -1,42 +1,48 @@ - + DriveSpaceInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class DriveSpaceInfo

    +
    Package com.nuix.superutilities.misc
    +

    Class DriveSpaceInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.DriveSpaceInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.DriveSpaceInfo
      +
      +
      -
      public class DriveSpaceInfo
 extends java.lang.Object
      Encapsulates drive space information to callback responding to events fired - by FreeSpaceMonitor.
      + by FreeSpaceMonitor.
    Author:
    Jason Wells
    - - -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        DriveSpaceInfo(java.lang.String pathString) +DriveSpaceInfo​(java.lang.String pathString)
        Creates a new instance for the specified file path.
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    + - -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            DriveSpaceInfo

            -
            public DriveSpaceInfo(java.lang.String pathString)
            +
            +

            DriveSpaceInfo

            +
            public DriveSpaceInfo​(java.lang.String pathString)
            Creates a new instance for the specified file path.
            Parameters:
            pathString - The file path
            +
          +
        • -
      -
    + - - - - -
    • -

      getPathString

      -
      public java.lang.String getPathString()
      +
      +

      getPathString

      +
      public java.lang.String getPathString()
      Gets the path this instance is associated with.
      Returns:
      The associate path string
      +
      • -
    - - - -
    • -

      getTotalBytes

      -
      public long getTotalBytes()
      +
      +

      getTotalBytes

      +
      public long getTotalBytes()
      +
      • -
    - - - -
    • -

      getFreeBytes

      -
      public long getFreeBytes()
      +
      +

      getFreeBytes

      +
      public long getFreeBytes()
      +
      • -
    - - - -
    • -

      hadError

      -
      public boolean hadError()
      +
      +

      hadError

      +
      public boolean hadError()
      +
      • -
    - - - -
    • -

      getError

      -
      public java.lang.Exception getError()
      +
      +

      getError

      +
      public java.lang.Exception getError()
      +
      • -
    - - - -
    • -

      getTotalGigaBytes

      -
      public double getTotalGigaBytes()
      +
      +

      getTotalGigaBytes

      +
      public double getTotalGigaBytes()
      +
      • -
    - - - -
    • -

      getFreeGigaBytes

      -
      public double getFreeGigaBytes()
      +
      +

      getFreeGigaBytes

      +
      public double getFreeGigaBytes()
      +
      • -
    - - - -
    • -

      getLastUpdated

      -
      public org.joda.time.DateTime getLastUpdated()
      +
      +

      getLastUpdated

      +
      public org.joda.time.DateTime getLastUpdated()
      +
      • -
    - - - -
    • -

      toString

      -
      public java.lang.String toString()
      +
      +

      toString

      +
      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/ExpandedTermInfo.html b/docs/com/nuix/superutilities/misc/ExpandedTermInfo.html index 8c7e44c..c206d5c 100644 --- a/docs/com/nuix/superutilities/misc/ExpandedTermInfo.html +++ b/docs/com/nuix/superutilities/misc/ExpandedTermInfo.html @@ -1,42 +1,48 @@ - + ExpandedTermInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class ExpandedTermInfo

    +
    Package com.nuix.superutilities.misc
    +

    Class ExpandedTermInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.ExpandedTermInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.ExpandedTermInfo
      +
      +
      -
      public class ExpandedTermInfo
 extends java.lang.Object
      -
      Encapsulates information about a term designated as a match result generated by TermExpander.
      +
      Encapsulates information about a term designated as a match result generated by TermExpander.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ExpandedTermInfo

            -
            public ExpandedTermInfo()
            +
            +

            ExpandedTermInfo

            +
            public ExpandedTermInfo()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getOriginalTerm

          -
          public java.lang.String getOriginalTerm()
          +
          +

          getOriginalTerm

          +
          public java.lang.String getOriginalTerm()
          +
          • -
        - - - -
        • -

          setOriginalTerm

          -
          public void setOriginalTerm(java.lang.String originalTerm)
          +
          +

          setOriginalTerm

          +
          public void setOriginalTerm​(java.lang.String originalTerm)
          +
          • -
        - - - -
        • -

          getMatchedTerm

          -
          public java.lang.String getMatchedTerm()
          +
          +

          getMatchedTerm

          +
          public java.lang.String getMatchedTerm()
          +
          • -
        - - - -
        • -

          setMatchedTerm

          -
          public void setMatchedTerm(java.lang.String matchedTerm)
          +
          +

          setMatchedTerm

          +
          public void setMatchedTerm​(java.lang.String matchedTerm)
          +
          • -
        - - - -
        • -

          getOcurrences

          -
          public long getOcurrences()
          +
          +

          getOcurrences

          +
          public long getOcurrences()
          +
          • -
        - - - -
        • -

          setOcurrences

          -
          public void setOcurrences(long ocurrences)
          +
          +

          setOcurrences

          +
          public void setOcurrences​(long ocurrences)
          +
          • -
        - - - -
        • -

          getSimilarity

          -
          public float getSimilarity()
          +
          +

          getSimilarity

          +
          public float getSimilarity()
          +
          • -
        - - - -
        • -

          setSimilarity

          -
          public void setSimilarity(float similarity)
          +
          +

          setSimilarity

          +
          public void setSimilarity​(float similarity)
          +
          • -
        - - - -
        • -

          toString

          -
          public java.lang.String toString()
          +
          +

          toString

          +
          public java.lang.String toString()
          Overrides:
          toString in class java.lang.Object
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/FormatUtility.html b/docs/com/nuix/superutilities/misc/FormatUtility.html index bf3cea6..abfbfda 100644 --- a/docs/com/nuix/superutilities/misc/FormatUtility.html +++ b/docs/com/nuix/superutilities/misc/FormatUtility.html @@ -1,42 +1,48 @@ - + FormatUtility + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class FormatUtility

    +
    Package com.nuix.superutilities.misc
    +

    Class FormatUtility

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.FormatUtility
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.FormatUtility
      +
      +
      -
      public class FormatUtility
 extends java.lang.Object
      Class which offers methods for formatting values.
      @@ -115,215 +99,242 @@

      Class FormatUtility

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Method Summary

        - - +

        Method Summary

        +
        +
        +
        +
        All Methods Static Methods Instance Methods Concrete Methods 
        + - + + - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + + - + - + + - + - + + - + + + + + + - + - + - + - + - + - + - + - + - + - - - + + + + - + - + - + - + - + - + - + - + + - + - + - + - + - + - + - + - + - + - + - + - + +
        Modifier and TypeMethod and DescriptionMethodDescription
        static java.lang.StringbytesToDynamicSize(long bytes, - int decimalPlaces) +bytesToDynamicSize​(long bytes, +int decimalPlaces)
        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"
        static doublebytesToGigaBytes(long bytes, - int decimalPlaces) +bytesToGigaBytes​(long bytes, +int decimalPlaces)
        Converts size specified in bytes to size specified in giga bytes, rounding to specified number of decimal places.
        static java.lang.StringbytesToHex(byte[] bytes) +bytesToHex​(byte[] bytes)
        Convenience method for converting a byte array to a hex string.
        static doublebytesToKiloBytes(long bytes, - int decimalPlaces) +bytesToKiloBytes​(long bytes, +int decimalPlaces)
        Converts size specified in bytes to size specified in kilo bytes, rounding to specified number of decimal places.
        static doublebytesToMegaBytes(long bytes, - int decimalPlaces) +bytesToMegaBytes​(long bytes, +int decimalPlaces)
        Converts size specified in bytes to size specified in mega bytes, rounding to specified number of decimal places.
        java.lang.StringconvertToString(java.lang.Object value) +convertToString​(java.lang.Object value)
        Attempts to convert data types, which may be values of metadata properties or custom metadata, to a String.
        static java.lang.StringdebugString(java.lang.Exception exc) debugString​(java.lang.Exception exc) 
        static java.lang.StringdebugString(java.util.Map<java.lang.String,?> map) debugString​(java.util.Map<java.lang.String,​?> map) 
        static java.lang.StringformatAsTextualTable(java.util.List<java.util.List<java.lang.String>> rows) escapeTagForSearch​(java.lang.String tagName) 
        static java.lang.StringformatAsTextualTable​(java.util.List<java.util.List<java.lang.String>> rows) 
        java.lang.StringformatNumber(double number) +formatNumber​(double number)
        Convenience method for formatting numeric value using US locale.
        java.lang.StringformatNumber(int number) +formatNumber​(int number)
        Convenience method for formatting numeric value using US locale.
        java.lang.StringformatNumber(long number) +formatNumber​(long number)
        Convenience method for formatting numeric value using US locale.
        java.lang.StringgetFilenameTimestamp() +getFilenameTimestamp()
        Generates a time stamp string which is safe to use in a file or directory name.
        static java.lang.StringgetHtmlText(java.lang.String htmlSource) +getHtmlText​(java.lang.String htmlSource)
        Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.
        static FormatUtilitygetInstance() 
        static FormatUtilitygetInstance() 
        static doublegetUnitBase() +getUnitBase()
        Gets the unit base which will be used in size calculations.
        static booleangetUseSIUnits() +getUseSIUnits()
        Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
        static byte[]hexToBytes(java.lang.String hex) +hexToBytes​(java.lang.String hex)
        Convenience method for converting hex string to byte array.
        static java.io.FilemakeGuidPath(nuix.Item item, - java.io.File rootDirectory, - java.lang.String extension) makeGuidPath​(nuix.Item item, +java.io.File rootDirectory, +java.lang.String extension) 
        java.lang.StringresolvePlaceholders(java.lang.String template, - java.util.Map<java.lang.String,java.lang.Object> placeholderValues) +resolvePlaceholders​(java.lang.String template, +java.util.Map<java.lang.String,​java.lang.Object> placeholderValues)
        Simple method to replace place holders with values in a template string.
        static doubleround(double value, - int numberOfDigitsAfterDecimalPoint) +round​(double value, +int numberOfDigitsAfterDecimalPoint)
        Helper method for rounding a decimal value to a particular number of decimal places.
        java.lang.StringsecondsToElapsedString(java.lang.Double offsetSeconds) +secondsToElapsedString​(long offsetSeconds)
        Converts a value representing some number of seconds to an "elapsed" string.
        java.lang.StringsecondsToElapsedString(long offsetSeconds) +secondsToElapsedString​(java.lang.Double offsetSeconds)
        Converts a value representing some number of seconds to an "elapsed" string.
        static voidsetUseSIUnits(boolean useSIUnits) +setUseSIUnits​(boolean useSIUnits)
        Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
        static java.util.List<java.lang.String>tokenizeText(java.lang.String inputText) +tokenizeText​(java.lang.String inputText)
        Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.
        -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - -
        • -

          hexToBytes

          -
          public static byte[] hexToBytes(java.lang.String hex)
          +
          +

          hexToBytes

          +
          public static byte[] hexToBytes​(java.lang.String hex)
          Convenience method for converting hex string to byte array.
          Parameters:
          @@ -331,15 +342,12 @@

          hexToBytes

          Returns:
          Byte array equivalent.
          +
          • -
        - - - -
        • -

          bytesToHex

          -
          public static java.lang.String bytesToHex(byte[] bytes)
          +
          +

          bytesToHex

          +
          public static java.lang.String bytesToHex​(byte[] bytes)
          Convenience method for converting a byte array to a hex string.
          Parameters:
          @@ -347,15 +355,12 @@

          bytesToHex

          Returns:
          A string representation of the byte array as hexadecimal.
          +
          • -
        - - - -
        • -

          convertToString

          -
          public java.lang.String convertToString(java.lang.Object value)
          +
          +

          convertToString

          +
          public java.lang.String convertToString​(java.lang.Object value)
          Attempts to convert data types, which may be values of metadata properties or custom metadata, to a String. Data types supported: - String @@ -372,15 +377,12 @@

          convertToString

          Returns:
          A String value of the provided data.
          +
          • -
        - - - -
        • -

          secondsToElapsedString

          -
          public java.lang.String secondsToElapsedString(java.lang.Double offsetSeconds)
          +
          +

          secondsToElapsedString

          +
          public java.lang.String secondsToElapsedString​(java.lang.Double offsetSeconds)
          Converts a value representing some number of seconds to an "elapsed" string. For example a value of 75 seconds would be converted to the string "00:01:15". If the time span represents more than 24 hours you may get a value such as @@ -391,15 +393,12 @@

          secondsToElapsedString

          Returns:
          A String representing the elapsed time.
          +
          • -
        - - - -
        • -

          secondsToElapsedString

          -
          public java.lang.String secondsToElapsedString(long offsetSeconds)
          +
          +

          secondsToElapsedString

          +
          public java.lang.String secondsToElapsedString​(long offsetSeconds)
          Converts a value representing some number of seconds to an "elapsed" string. For example a value of 75 seconds would be converted to the string "00:01:15". If the time span represents more than 24 hours you may get a value such as @@ -410,15 +409,12 @@

          secondsToElapsedString

          Returns:
          A String representing the elapsed time.
          +
          • -
        - - - -
        • -

          formatNumber

          -
          public java.lang.String formatNumber(int number)
          +
          +

          formatNumber

          +
          public java.lang.String formatNumber​(int number)
          Convenience method for formatting numeric value using US locale.
          Parameters:
          @@ -426,15 +422,12 @@

          formatNumber

          Returns:
          Formatting String version of the number
          +
          • -
        - - - -
        • -

          formatNumber

          -
          public java.lang.String formatNumber(long number)
          +
          +

          formatNumber

          +
          public java.lang.String formatNumber​(long number)
          Convenience method for formatting numeric value using US locale.
          Parameters:
          @@ -442,15 +435,12 @@

          formatNumber

          Returns:
          Formatting String version of the number
          +
          • -
        - - - -
        • -

          formatNumber

          -
          public java.lang.String formatNumber(double number)
          +
          +

          formatNumber

          +
          public java.lang.String formatNumber​(double number)
          Convenience method for formatting numeric value using US locale.
          Parameters:
          @@ -458,16 +448,13 @@

          formatNumber

          Returns:
          Formatting String version of the number
          +
          • -
        - - - -
        • -

          resolvePlaceholders

          -
          public java.lang.String resolvePlaceholders(java.lang.String template,
-                                            java.util.Map<java.lang.String,java.lang.Object> placeholderValues)
          +
          +

          resolvePlaceholders

          +
          public java.lang.String resolvePlaceholders​(java.lang.String template, +java.util.Map<java.lang.String,​java.lang.Object> placeholderValues)
          Simple method to replace place holders with values in a template string. Placeholders are values starting with a '{', followed by a name, followed by '}'. For example "{name}".
          @@ -477,74 +464,59 @@

          resolvePlaceholders

          Returns:
          Template string with place holders replaced
          +
          • -
        - - - -
        • -

          getFilenameTimestamp

          -
          public java.lang.String getFilenameTimestamp()
          +
          +

          getFilenameTimestamp

          +
          public java.lang.String getFilenameTimestamp()
          Generates a time stamp string which is safe to use in a file or directory name.
          Returns:
          File/directory name safe time stamp string.
          +
          • -
        - - - -
        • -

          getUseSIUnits

          -
          public static boolean getUseSIUnits()
          +
          +

          getUseSIUnits

          +
          public static boolean getUseSIUnits()
          Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
          Returns:
          True if size methods use 1000 bytes, false if they will use 1024 bytes
          +
          • -
        - - - -
        • -

          setUseSIUnits

          -
          public static void setUseSIUnits(boolean useSIUnits)
          +
          +

          setUseSIUnits

          +
          public static void setUseSIUnits​(boolean useSIUnits)
          Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.
          Parameters:
          useSIUnits - True if size methods use 1000 bytes, false if they will use 1024 bytes
          +
          • -
        - - - -
        • -

          getUnitBase

          -
          public static double getUnitBase()
          +
          +

          getUnitBase

          +
          public static double getUnitBase()
          Gets the unit base which will be used in size calculations. Will return 1000 if - getUseSIUnits() returns true and 1024 if getUseSIUnits() + getUseSIUnits() returns true and 1024 if getUseSIUnits() returns false.
          Returns:
          Size base unit used in size calculations.
          +
          • -
        - - - -
        • -

          bytesToKiloBytes

          -
          public static double bytesToKiloBytes(long bytes,
-                                      int decimalPlaces)
          +
          +

          bytesToKiloBytes

          +
          public static double bytesToKiloBytes​(long bytes, +int decimalPlaces)
          Converts size specified in bytes to size specified in kilo bytes, rounding to specified number of decimal places.
          @@ -554,16 +526,13 @@

          bytesToKiloBytes

          Returns:
          Size in bytes converted to size in kilo bytes
          +
          • -
        - - - -
        • -

          bytesToMegaBytes

          -
          public static double bytesToMegaBytes(long bytes,
-                                      int decimalPlaces)
          +
          +

          bytesToMegaBytes

          +
          public static double bytesToMegaBytes​(long bytes, +int decimalPlaces)
          Converts size specified in bytes to size specified in mega bytes, rounding to specified number of decimal places.
          @@ -573,16 +542,13 @@

          bytesToMegaBytes

          Returns:
          Size in bytes converted to size in mega bytes
          +
          • -
        - - - -
        • -

          bytesToGigaBytes

          -
          public static double bytesToGigaBytes(long bytes,
-                                      int decimalPlaces)
          +
          +

          bytesToGigaBytes

          +
          public static double bytesToGigaBytes​(long bytes, +int decimalPlaces)
          Converts size specified in bytes to size specified in giga bytes, rounding to specified number of decimal places.
          @@ -592,16 +558,13 @@

          bytesToGigaBytes

          Returns:
          Size in bytes converted to size in giga bytes
          +
          • -
        - - - -
        • -

          bytesToDynamicSize

          -
          public static java.lang.String bytesToDynamicSize(long bytes,
-                                                  int decimalPlaces)
          +
          +

          bytesToDynamicSize

          +
          public static java.lang.String bytesToDynamicSize​(long bytes, +int decimalPlaces)
          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"
          @@ -611,16 +574,13 @@

          bytesToDynamicSize

          Returns:
          A String representing the size in appropriate format
          +
          • -
        - - - -
        • -

          round

          -
          public static double round(double value,
-                           int numberOfDigitsAfterDecimalPoint)
          +
          +

          round

          +
          public static double round​(double value, +int numberOfDigitsAfterDecimalPoint)
          Helper method for rounding a decimal value to a particular number of decimal places.
          Parameters:
          @@ -629,16 +589,13 @@

          round

          Returns:
          The given value rounded off to specified decimal places
          +
          • -
        - - - -
        • -

          tokenizeText

          -
          public static java.util.List<java.lang.String> tokenizeText(java.lang.String inputText)
-                                                     throws java.lang.Exception
          +
          +

          tokenizeText

          +
          public static java.util.List<java.lang.String> tokenizeText​(java.lang.String inputText) + throws java.lang.Exception
          Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.
          Parameters:
          @@ -648,15 +605,12 @@

          tokenizeText

          Throws:
          java.lang.Exception - Most likely thrown if Lucene tokenizer encounters a problem.
          +
          • -
        - - - -
        • -

          getHtmlText

          -
          public static java.lang.String getHtmlText(java.lang.String htmlSource)
          +
          +

          getHtmlText

          +
          public static java.lang.String getHtmlText​(java.lang.String htmlSource)
          Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.
          Parameters:
          @@ -664,63 +618,60 @@

          getHtmlText

          Returns:
          The "rendered text" of the provided HTML source code.
          +
          • -
        - - - -
        • -

          formatAsTextualTable

          -
          public static java.lang.String formatAsTextualTable(java.util.List<java.util.List<java.lang.String>> rows)
          +
          +

          formatAsTextualTable

          +
          public static java.lang.String formatAsTextualTable​(java.util.List<java.util.List<java.lang.String>> rows)
          +
          • -
        - - - -
        • -

          debugString

          -
          public static java.lang.String debugString(java.util.Map<java.lang.String,?> map)
          +
          +

          debugString

          +
          public static java.lang.String debugString​(java.util.Map<java.lang.String,​?> map)
          +
          • -
        - - - -
        • -

          debugString

          -
          public static java.lang.String debugString(java.lang.Exception exc)
          +
          +

          debugString

          +
          public static java.lang.String debugString​(java.lang.Exception exc)
          +
          • -
        - - - -
        • -

          makeGuidPath

          -
          public static java.io.File makeGuidPath(nuix.Item item,
-                                        java.io.File rootDirectory,
-                                        java.lang.String extension)
          +
          +

          makeGuidPath

          +
          public static java.io.File makeGuidPath​(nuix.Item item, +java.io.File rootDirectory, +java.lang.String extension)
          +
          • -
        +
      • +
        +

        escapeTagForSearch

        +
        public static java.lang.String escapeTagForSearch​(java.lang.String tagName)
        +
      +
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/FreeSpaceMonitor.html b/docs/com/nuix/superutilities/misc/FreeSpaceMonitor.html index 1124d9f..d0aaf96 100644 --- a/docs/com/nuix/superutilities/misc/FreeSpaceMonitor.html +++ b/docs/com/nuix/superutilities/misc/FreeSpaceMonitor.html @@ -1,42 +1,48 @@ - + FreeSpaceMonitor + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class FreeSpaceMonitor

    +
    Package com.nuix.superutilities.misc
    +

    Class FreeSpaceMonitor

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.FreeSpaceMonitor
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.FreeSpaceMonitor
      +
      +
      -
      public class FreeSpaceMonitor
 extends java.lang.Object
      Provides a way to monitor file system locations and act when available disk space drops @@ -116,219 +100,220 @@

      Class FreeSpaceMonitor

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            FreeSpaceMonitor

            -
            public FreeSpaceMonitor()
            +
            +

            FreeSpaceMonitor

            +
            public FreeSpaceMonitor()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          addMonitoredLocation

          -
          public void addMonitoredLocation(java.lang.String pathString,
-                                 double freeSpaceThresholdGb)
          +
          +

          addMonitoredLocation

          +
          public void addMonitoredLocation​(java.lang.String pathString, +double freeSpaceThresholdGb)
          Adds a location to be monitored
          Parameters:
          pathString - Path string to the location to be monitored
          freeSpaceThresholdGb - Free space threshold to begin reacting to
          +
          • -
        - - - - - - - -
        • -

          whenFreeSpaceIssueResolved

          -
          public void whenFreeSpaceIssueResolved(FreeSpaceMonitorEventCallback callback)
          +
          +

          whenFreeSpaceIssueResolved

          +
          public void whenFreeSpaceIssueResolved​(FreeSpaceMonitorEventCallback callback)
          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.
          Parameters:
          callback - The callback to be invoked
          +
          • -
        - - - - - - - -
        • -

          beginMonitoring

          -
          public void beginMonitoring()
          +
          +

          beginMonitoring

          +
          public void beginMonitoring()
          Begins monitoring locations by polling them at intervals. - Should later be followed by a call to shutdownMonitoring() once monitoring is + Should later be followed by a call to shutdownMonitoring() once monitoring is no longer needed.
          +
          • -
        - - - -
        • -

          shutdownMonitoring

          -
          public void shutdownMonitoring()
          +
          +

          shutdownMonitoring

          +
          public void shutdownMonitoring()
          Signals to polling thread that it should wind down and stop polling the monitored locations. - See method beginMonitoring() for how to begin monitoring.
          -
          • -
        + See method beginMonitoring() for how to begin monitoring.
    + + - + + + + + diff --git a/docs/com/nuix/superutilities/misc/FreeSpaceMonitorEventCallback.html b/docs/com/nuix/superutilities/misc/FreeSpaceMonitorEventCallback.html index 753d8ee..c70498f 100644 --- a/docs/com/nuix/superutilities/misc/FreeSpaceMonitorEventCallback.html +++ b/docs/com/nuix/superutilities/misc/FreeSpaceMonitorEventCallback.html @@ -1,42 +1,48 @@ - + FreeSpaceMonitorEventCallback + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Interface FreeSpaceMonitorEventCallback

    +
    Package com.nuix.superutilities.misc
    +

    Interface FreeSpaceMonitorEventCallback

    -
    -
      -
    • +
      -
      public interface FreeSpaceMonitorEventCallback
      -
      Interface for callback for free space monitoring offered by FreeSpaceMonitor.
      +
      Interface for callback for free space monitoring offered by FreeSpaceMonitor.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    +
    + - - -
    -
    + +
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/FuzzyTermInfo.html b/docs/com/nuix/superutilities/misc/FuzzyTermInfo.html index 21d39a4..b3e35da 100644 --- a/docs/com/nuix/superutilities/misc/FuzzyTermInfo.html +++ b/docs/com/nuix/superutilities/misc/FuzzyTermInfo.html @@ -1,42 +1,48 @@ - + FuzzyTermInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class FuzzyTermInfo

    +
    Package com.nuix.superutilities.misc
    +

    Class FuzzyTermInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.FuzzyTermInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.FuzzyTermInfo
      +
      +
      -
      public class FuzzyTermInfo
 extends java.lang.Object
      -
      Encapsulates information about a fuzzy term expression. Used by TermExpander.
      +
      Encapsulates information about a fuzzy term expression. Used by TermExpander.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        FuzzyTermInfo() FuzzyTermInfo() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            FuzzyTermInfo

            -
            public FuzzyTermInfo()
            +
            +

            FuzzyTermInfo

            +
            public FuzzyTermInfo()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          isFuzzyTerm

          -
          public static boolean isFuzzyTerm(java.lang.String term)
          +
          +

          isFuzzyTerm

          +
          public static boolean isFuzzyTerm​(java.lang.String term)
          +
          • -
        - - - -
        • -

          parseFuzzyTerm

          -
          public static FuzzyTermInfo parseFuzzyTerm(java.lang.String term)
          +
          +

          parseFuzzyTerm

          +
          public static FuzzyTermInfo parseFuzzyTerm​(java.lang.String term)
          Parses a fuzzy term string into component term and similarity score. When a similarity score is not present defaults to 0.5 (like Lucene).
          @@ -251,88 +248,70 @@

          parseFuzzyTerm

          Returns:
          A Fuzzy object containing term and similarity score.
          +
          • -
        - - - -
        • -

          calculateLuceneLevenshteinSimilarityTo

          -
          public float calculateLuceneLevenshteinSimilarityTo(java.lang.String otherTerm)
          +
          +

          calculateLuceneLevenshteinSimilarityTo

          +
          public float calculateLuceneLevenshteinSimilarityTo​(java.lang.String otherTerm)
          +
          • -
        - - - -
        • -

          calculateJaroWinklerSimilarityTo

          -
          public float calculateJaroWinklerSimilarityTo(java.lang.String otherTerm)
          +
          +

          calculateJaroWinklerSimilarityTo

          +
          public float calculateJaroWinklerSimilarityTo​(java.lang.String otherTerm)
          +
          • -
        - - - -
        • -

          calculateNGramSimilarityTo

          -
          public float calculateNGramSimilarityTo(java.lang.String otherTerm)
          +
          +

          calculateNGramSimilarityTo

          +
          public float calculateNGramSimilarityTo​(java.lang.String otherTerm)
          +
          • -
        - - - -
        • -

          getTerm

          -
          public java.lang.String getTerm()
          +
          +

          getTerm

          +
          public java.lang.String getTerm()
          +
          • -
        - - - -
        • -

          setTerm

          -
          public void setTerm(java.lang.String term)
          +
          +

          setTerm

          +
          public void setTerm​(java.lang.String term)
          +
          • -
        - - - -
        • -

          getTargetSimilarity

          -
          public float getTargetSimilarity()
          +
          +

          getTargetSimilarity

          +
          public float getTargetSimilarity()
          +
          • -
        - - - -
        • -

          setTargetSimilarity

          -
          public void setTargetSimilarity(float similarity)
          -
          • -
        +
        +

        setTargetSimilarity

        +
        public void setTargetSimilarity​(float similarity)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/LevenshteinDistance.html b/docs/com/nuix/superutilities/misc/LevenshteinDistance.html index f9b1c0e..6f397a8 100644 --- a/docs/com/nuix/superutilities/misc/LevenshteinDistance.html +++ b/docs/com/nuix/superutilities/misc/LevenshteinDistance.html @@ -1,42 +1,48 @@ - + LevenshteinDistance + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class LevenshteinDistance

    +
    Package com.nuix.superutilities.misc
    +

    Class LevenshteinDistance

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.LevenshteinDistance
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.LevenshteinDistance
      +
      +
      -
      public class LevenshteinDistance
 extends java.lang.Object
      -
      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static intcalculate(java.lang.String a, - java.lang.String b) calculate​(java.lang.String a, +java.lang.String b) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            LevenshteinDistance

            -
            public LevenshteinDistance()
            +
            +

            LevenshteinDistance

            +
            public LevenshteinDistance()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            calculate

            -
            public static int calculate(java.lang.String a,
-                            java.lang.String b)
            -
            • -
          +
          +

          calculate

          +
          public static int calculate​(java.lang.String a, +java.lang.String b)
          +
        +
      -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/NamedStringList.html b/docs/com/nuix/superutilities/misc/NamedStringList.html index bdccacd..336ec25 100644 --- a/docs/com/nuix/superutilities/misc/NamedStringList.html +++ b/docs/com/nuix/superutilities/misc/NamedStringList.html @@ -1,42 +1,48 @@ - + NamedStringList + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class NamedStringList

    +
    Package com.nuix.superutilities.misc
    +

    Class NamedStringList

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.NamedStringList
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.NamedStringList
      +
      +
      -
      public class NamedStringList
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        NamedStringList() NamedStringList() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + - + - + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidadd(int index, - java.lang.String element) add​(int index, +java.lang.String element) 
      booleanadd(java.lang.String e) add​(java.lang.String e) 
      booleanaddAll(java.util.Collection<? extends java.lang.String> c) addAll​(int index, +java.util.Collection<? extends java.lang.String> c) 
      booleanaddAll(int index, - java.util.Collection<? extends java.lang.String> c) addAll​(java.util.Collection<? extends java.lang.String> c) 
      voidclear() clear() 
      booleancontains(java.lang.Object o) contains​(java.lang.Object o) 
      booleancontainsAll(java.util.Collection<?> c) containsAll​(java.util.Collection<?> c) 
      booleanequals(java.lang.Object o) equals​(java.lang.Object o) 
      voidforEach(java.util.function.Consumer<? super java.lang.String> action) forEach​(java.util.function.Consumer<? super java.lang.String> action) 
      java.lang.Stringget(int index) get​(int index) 
      java.lang.StringgetName() getName() 
      inthashCode() hashCode() 
      intindexOf(java.lang.Object o) indexOf​(java.lang.Object o) 
      booleanisEmpty() isEmpty() 
      java.util.Iterator<java.lang.String>iterator() iterator() 
      intlastIndexOf(java.lang.Object o) lastIndexOf​(java.lang.Object o) 
      java.util.ListIterator<java.lang.String>listIterator() listIterator() 
      java.util.ListIterator<java.lang.String>listIterator(int index) listIterator​(int index) 
      java.util.stream.Stream<java.lang.String>parallelStream() parallelStream() 
      java.lang.Stringremove(int index) remove​(int index) 
      booleanremove(java.lang.Object o) remove​(java.lang.Object o) 
      booleanremoveAll(java.util.Collection<?> c) removeAll​(java.util.Collection<?> c) 
      booleanremoveIf(java.util.function.Predicate<? super java.lang.String> filter) removeIf​(java.util.function.Predicate<? super java.lang.String> filter) 
      voidreplaceAll(java.util.function.UnaryOperator<java.lang.String> operator) replaceAll​(java.util.function.UnaryOperator<java.lang.String> operator) 
      booleanretainAll(java.util.Collection<?> c) retainAll​(java.util.Collection<?> c) 
      java.lang.Stringset(int index, - java.lang.String element) set​(int index, +java.lang.String element) 
      voidsetName(java.lang.String name) setName​(java.lang.String name) 
      intsize() size() 
      voidsort(java.util.Comparator<? super java.lang.String> c) sort​(java.util.Comparator<? super java.lang.String> c) 
      java.util.Spliterator<java.lang.String>spliterator() spliterator() 
      java.util.stream.Stream<java.lang.String>stream() stream() 
      java.util.List<java.lang.String>subList(int fromIndex, - int toIndex) subList​(int fromIndex, +int toIndex) 
      java.lang.Object[]toArray() toArray() 
      <T> T[]toArray(T[] a) toArray​(T[] a) 
      -
    +
    +

    Methods inherited from class java.lang.Object

    -getClass, notify, notifyAll, toString, wait, wait, wait - - - + + +getClass, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            NamedStringList

            -
            public NamedStringList()
            +
            +

            NamedStringList

            +
            public NamedStringList()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - - - -
        • -

          getName

          -
          public java.lang.String getName()
          -
          • -
        - +
        +

        Method Details

        • -

          setName

          -
          public void setName(java.lang.String name)
          +
          +

          getName

          +
          public java.lang.String getName()
          +
          • -
        - - - -
        • -

          forEach

          -
          public void forEach(java.util.function.Consumer<? super java.lang.String> action)
          +
          +

          setName

          +
          public void setName​(java.lang.String name)
          +
          • -
        - - - -
        • -

          size

          -
          public int size()
          +
          +

          forEach

          +
          public void forEach​(java.util.function.Consumer<? super java.lang.String> action)
          +
          • -
        - - - -
        • -

          isEmpty

          -
          public boolean isEmpty()
          +
          +

          size

          +
          public int size()
          +
          • -
        - - - -
        • -

          contains

          -
          public boolean contains(java.lang.Object o)
          +
          +

          isEmpty

          +
          public boolean isEmpty()
          +
          • -
        - - - -
        • -

          iterator

          -
          public java.util.Iterator<java.lang.String> iterator()
          +
          +

          contains

          +
          public boolean contains​(java.lang.Object o)
          +
          • -
        - - - -
        • -

          toArray

          -
          public java.lang.Object[] toArray()
          +
          +

          iterator

          +
          public java.util.Iterator<java.lang.String> iterator()
          +
          • -
        - - - - - -
        • -

          toArray

          -
          public <T> T[] toArray(T[] a)
          +
          +

          toArray

          +
          public java.lang.Object[] toArray()
          +
          • -
        - +
      • +
        +

        - -

        +
        public <T> T[] toArray​(T[] a)
        +
        +
      • -

        add

        -
        public boolean add(java.lang.String e)
        +
        +

        add

        +
        public boolean add​(java.lang.String e)
        +
        • -
      - - - -
      • -

        remove

        -
        public boolean remove(java.lang.Object o)
        +
        +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        • -
      - - - -
      • -

        containsAll

        -
        public boolean containsAll(java.util.Collection<?> c)
        +
        +

        containsAll

        +
        public boolean containsAll​(java.util.Collection<?> c)
        +
        • -
      - - - -
      • -

        addAll

        -
        public boolean addAll(java.util.Collection<? extends java.lang.String> c)
        +
        +

        addAll

        +
        public boolean addAll​(java.util.Collection<? extends java.lang.String> c)
        +
        • -
      - - - -
      • -

        addAll

        -
        public boolean addAll(int index,
-                      java.util.Collection<? extends java.lang.String> c)
        +
        +

        addAll

        +
        public boolean addAll​(int index, +java.util.Collection<? extends java.lang.String> c)
        +
        • -
      - - - -
      • -

        removeAll

        -
        public boolean removeAll(java.util.Collection<?> c)
        +
        +

        removeAll

        +
        public boolean removeAll​(java.util.Collection<?> c)
        +
        • -
      - - - -
      • -

        retainAll

        -
        public boolean retainAll(java.util.Collection<?> c)
        +
        +

        retainAll

        +
        public boolean retainAll​(java.util.Collection<?> c)
        +
        • -
      - - - -
      • -

        replaceAll

        -
        public void replaceAll(java.util.function.UnaryOperator<java.lang.String> operator)
        +
        +

        replaceAll

        +
        public void replaceAll​(java.util.function.UnaryOperator<java.lang.String> operator)
        +
        • -
      - - - -
      • -

        removeIf

        -
        public boolean removeIf(java.util.function.Predicate<? super java.lang.String> filter)
        +
        +

        removeIf

        +
        public boolean removeIf​(java.util.function.Predicate<? super java.lang.String> filter)
        +
        • -
      - - - -
      • -

        sort

        -
        public void sort(java.util.Comparator<? super java.lang.String> c)
        +
        +

        sort

        +
        public void sort​(java.util.Comparator<? super java.lang.String> c)
        +
        • -
      - - - -
      • -

        clear

        -
        public void clear()
        +
        +

        clear

        +
        public void clear()
        +
        • -
      - - - -
      • -

        equals

        -
        public boolean equals(java.lang.Object o)
        +
        +

        equals

        +
        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
        +
        • -
      - - - -
      • -

        hashCode

        -
        public int hashCode()
        +
        +

        hashCode

        +
        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        +
        • -
      - - - -
      • -

        get

        -
        public java.lang.String get(int index)
        +
        +

        get

        +
        public java.lang.String get​(int index)
        +
        • -
      - - - -
      • -

        set

        -
        public java.lang.String set(int index,
-                            java.lang.String element)
        +
        +

        set

        +
        public java.lang.String set​(int index, +java.lang.String element)
        +
        • -
      - - - -
      • -

        add

        -
        public void add(int index,
-                java.lang.String element)
        +
        +

        add

        +
        public void add​(int index, +java.lang.String element)
        +
        • -
      - - - -
      • -

        stream

        -
        public java.util.stream.Stream<java.lang.String> stream()
        +
        +

        stream

        +
        public java.util.stream.Stream<java.lang.String> stream()
        +
        • -
      - - - -
      • -

        remove

        -
        public java.lang.String remove(int index)
        +
        +

        remove

        +
        public java.lang.String remove​(int index)
        +
        • -
      - - - -
      • -

        parallelStream

        -
        public java.util.stream.Stream<java.lang.String> parallelStream()
        +
        +

        parallelStream

        +
        public java.util.stream.Stream<java.lang.String> parallelStream()
        +
        • -
      - - - -
      • -

        indexOf

        -
        public int indexOf(java.lang.Object o)
        +
        +

        indexOf

        +
        public int indexOf​(java.lang.Object o)
        +
        • -
      - - - -
      • -

        lastIndexOf

        -
        public int lastIndexOf(java.lang.Object o)
        +
        +

        lastIndexOf

        +
        public int lastIndexOf​(java.lang.Object o)
        +
        • -
      - - - -
      • -

        listIterator

        -
        public java.util.ListIterator<java.lang.String> listIterator()
        +
        +

        listIterator

        +
        public java.util.ListIterator<java.lang.String> listIterator()
        +
        • -
      - - - -
      • -

        listIterator

        -
        public java.util.ListIterator<java.lang.String> listIterator(int index)
        +
        +

        listIterator

        +
        public java.util.ListIterator<java.lang.String> listIterator​(int index)
        +
        • -
      - - - -
      • -

        subList

        -
        public java.util.List<java.lang.String> subList(int fromIndex,
-                                                int toIndex)
        +
        +

        subList

        +
        public java.util.List<java.lang.String> subList​(int fromIndex, +int toIndex)
        +
        • -
      - - - -
      • -

        spliterator

        -
        public java.util.Spliterator<java.lang.String> spliterator()
        -
        • -
      +
      +

      spliterator

      +
      public java.util.Spliterator<java.lang.String> spliterator()
      +
    +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/NuixVersion.html b/docs/com/nuix/superutilities/misc/NuixVersion.html index 9cf7e93..35e3755 100644 --- a/docs/com/nuix/superutilities/misc/NuixVersion.html +++ b/docs/com/nuix/superutilities/misc/NuixVersion.html @@ -1,42 +1,48 @@ - + NuixVersion + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class NuixVersion

    +
    Package com.nuix.superutilities.misc
    +

    Class NuixVersion

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.NuixVersion
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.NuixVersion
      +
      +
      All Implemented Interfaces:
      -
      java.lang.Comparable<NuixVersion>
      +
      java.lang.Comparable<NuixVersion>
      -
      public class NuixVersion
 extends java.lang.Object
-implements java.lang.Comparable<NuixVersion>
      +implements java.lang.Comparable<NuixVersion>
      Assists in representing a Nuix version in object form to assist with comparing two versions. This allows for things such as only executing chunks of code if the version meets a requirement.
      Ruby example: @@ -131,260 +115,283 @@

      Class NuixVersion

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + - + - + - + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        NuixVersion() +NuixVersion()
        Creates a new instance defaulting to version 0.0.0
        NuixVersion(int majorVersion) +NuixVersion​(int majorVersion)
        Creates a new instance using the provided major version: major.0.0.0
        NuixVersion(int majorVersion, - int minorVersion) +NuixVersion​(int majorVersion, +int minorVersion)
        Creates a new instance using the provided major and minor versions: major.minor.0.0
        NuixVersion(int majorVersion, - int minorVersion, - int bugfixVersion) +NuixVersion​(int majorVersion, +int minorVersion, +int bugfixVersion)
        Creates a new instance using the provided major, minor and bugfix versions: major.minor.bugfix.0
        NuixVersion(int majorVersion, - int minorVersion, - int bugfixVersion, - int buildVersion) +NuixVersion​(int majorVersion, +int minorVersion, +int bugfixVersion, +int buildVersion)
        Creates a new instance using the provided major, minor, bugfix and build versions: major.minor.bugfix.build
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      intcompareTo(NuixVersion other) +compareTo​(NuixVersion other)
      Provides comparison logic when comparing two instances.
      intgetBugfix() +getBugfix()
      Gets the determined bugfix portion of this version instance (0.0.x.0)
      intgetBuild() +getBuild()
      Gets the determined build portion of this version instance (0.0.0.x)
      static NuixVersiongetCurrent() +
      static NuixVersiongetCurrent()
      Attempts to determine current Nuix version by inspecting Nuix packages.
      intgetMajor() +getMajor()
      Gets the determined major portion of this version instance (X.0.0.0)
      intgetMinor() +getMinor()
      Gets the determined minor portion of this version instance (0.X.0.0)
      booleanisAtLeast(NuixVersion other) +isAtLeast​(NuixVersion other)
      Determines whether another instance's version is greater than or equal to this instance
      booleanisAtLeast(java.lang.String other) +isAtLeast​(java.lang.String other)
      Determines whether another instance's version is greater than or equal to this instance
      booleanisEqualTo(NuixVersion other) +isEqualTo​(NuixVersion other)
      Determines whether another instance's version is equal to this instance
      booleanisEqualTo(java.lang.String other) +isEqualTo​(java.lang.String other)
      Determines whether another instance's version is equal to this instance
      booleanisGreaterThan(NuixVersion other) +isGreaterThan​(NuixVersion other)
      Determines whether another instance's version is greater than this instance
      booleanisGreaterThan(java.lang.String other) +isGreaterThan​(java.lang.String other)
      Determines whether another instance's version is greater than this instance
      booleanisLessThan(NuixVersion other) +isLessThan​(NuixVersion other)
      Determines whether another instance's version is less than this instance
      booleanisLessThan(java.lang.String other) +isLessThan​(java.lang.String other)
      Determines whether another instance's version is less than this instance
      static NuixVersionparse(java.lang.String versionString) +
      static NuixVersionparse​(java.lang.String versionString)
      Parses a version string into a NuixVersion instance.
      voidsetBugfix(int bugfix) +setBugfix​(int bugfix)
      Sets the determined bugfix portion of this version instance (0.0.x.0)
      voidsetBuild(int build) +setBuild​(int build)
      Sets the build portion of this version instance (0.0.0.x)
      voidsetMajor(int major) +setMajor​(int major)
      Sets the major portion of this version instance (X.0.0.0)
      voidsetMinor(int minor) +setMinor​(int minor)
      Sets the minor portion of this version instance (0.X.0.0)
      java.lang.StringtoString() +toString()
      Converts this instance back to a version string from its components, such as: "7.8.0.10"
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          NuixVersion

          -
          public NuixVersion()
          +
          +

          NuixVersion

          +
          public NuixVersion()
          Creates a new instance defaulting to version 0.0.0
          +
          • -
        - - - -
        • -

          NuixVersion

          -
          public NuixVersion(int majorVersion)
          +
          +

          NuixVersion

          +
          public NuixVersion​(int majorVersion)
          Creates a new instance using the provided major version: major.0.0.0
          Parameters:
          majorVersion - The major version number
          +
          • -
        - - - -
        • -

          NuixVersion

          -
          public NuixVersion(int majorVersion,
-                   int minorVersion)
          +
          +

          NuixVersion

          +
          public NuixVersion​(int majorVersion, +int minorVersion)
          Creates a new instance using the provided major and minor versions: major.minor.0.0
          Parameters:
          majorVersion - The major version number
          minorVersion - The minor version number
          +
          • -
        - - - -
        • -

          NuixVersion

          -
          public NuixVersion(int majorVersion,
-                   int minorVersion,
-                   int bugfixVersion)
          +
          +

          NuixVersion

          +
          public NuixVersion​(int majorVersion, +int minorVersion, +int bugfixVersion)
          Creates a new instance using the provided major, minor and bugfix versions: major.minor.bugfix.0
          Parameters:
          @@ -392,18 +399,15 @@

          NuixVersion

          minorVersion - The minor version number
          bugfixVersion - The bugfix version number
          +
          • -
        - - - -
        • -

          NuixVersion

          -
          public NuixVersion(int majorVersion,
-                   int minorVersion,
-                   int bugfixVersion,
-                   int buildVersion)
          +
          +

          NuixVersion

          +
          public NuixVersion​(int majorVersion, +int minorVersion, +int bugfixVersion, +int buildVersion)
          Creates a new instance using the provided major, minor, bugfix and build versions: major.minor.bugfix.build
          Parameters:
          @@ -412,23 +416,22 @@

          NuixVersion

          bugfixVersion - The bugfix version number
          buildVersion - The build version number
          +
        +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          parse

          -
          public static NuixVersion parse(java.lang.String versionString)
          +
          +

          parse

          +
          public static NuixVersion parse​(java.lang.String versionString)
          Parses a version string into a NuixVersion instance. Supports values such as: 6, 6.2, 6.2.0, 6.2.1-preview6, 7.8.0.10
          When providing a version string such as "6.2.1-preview6", "-preview6" will be trimmed off before parsing.
          @@ -438,142 +441,112 @@

          parse

          A NuixVersion instance representing the supplied version string, if there is an error parsing the provided value will return an instance representing 100.0.0
          +
          • -
        - - - -
        • -

          getMajor

          -
          public int getMajor()
          +
          +

          getMajor

          +
          public int getMajor()
          Gets the determined major portion of this version instance (X.0.0.0)
          Returns:
          The determined major portion of version
          +
          • -
        - - - -
        • -

          setMajor

          -
          public void setMajor(int major)
          +
          +

          setMajor

          +
          public void setMajor​(int major)
          Sets the major portion of this version instance (X.0.0.0)
          Parameters:
          major - The major version value
          +
          • -
        - - - -
        • -

          getMinor

          -
          public int getMinor()
          +
          +

          getMinor

          +
          public int getMinor()
          Gets the determined minor portion of this version instance (0.X.0.0)
          Returns:
          The determined minor portion of version
          +
          • -
        - - - -
        • -

          setMinor

          -
          public void setMinor(int minor)
          +
          +

          setMinor

          +
          public void setMinor​(int minor)
          Sets the minor portion of this version instance (0.X.0.0)
          Parameters:
          minor - The minor version value
          +
          • -
        - - - -
        • -

          getBugfix

          -
          public int getBugfix()
          +
          +

          getBugfix

          +
          public int getBugfix()
          Gets the determined bugfix portion of this version instance (0.0.x.0)
          Returns:
          The determined bugfix portion of version
          +
          • -
        - - - -
        • -

          setBugfix

          -
          public void setBugfix(int bugfix)
          +
          +

          setBugfix

          +
          public void setBugfix​(int bugfix)
          Sets the determined bugfix portion of this version instance (0.0.x.0)
          Parameters:
          bugfix - The determined bugfix portion of version
          +
          • -
        - - - -
        • -

          getBuild

          -
          public int getBuild()
          +
          +

          getBuild

          +
          public int getBuild()
          Gets the determined build portion of this version instance (0.0.0.x)
          Returns:
          The determined build portion of version
          +
          • -
        - - - -
        • -

          setBuild

          -
          public void setBuild(int build)
          +
          +

          setBuild

          +
          public void setBuild​(int build)
          Sets the build portion of this version instance (0.0.0.x)
          Parameters:
          build - The build version value
          +
          • -
        - - - -
        • -

          getCurrent

          -
          public static NuixVersion getCurrent()
          +
          +

          getCurrent

          +
          public static NuixVersion getCurrent()
          Attempts to determine current Nuix version by inspecting Nuix packages. It is preffered to instead use - parse(String) when version string is available, such as in Ruby using constant NUIX_VERSION.
          + parse(String) when version string is available, such as in Ruby using constant NUIX_VERSION.
    Returns:
    Best guess at current Nuix version based on package inspection.
    + - - - - -
    • -

      isLessThan

      -
      public boolean isLessThan(NuixVersion other)
      +
      +

      isLessThan

      +
      public boolean isLessThan​(NuixVersion other)
      Determines whether another instance's version is less than this instance
      Parameters:
      @@ -581,15 +554,12 @@

      isLessThan

      Returns:
      True if the other instance is a lower version, false otherwise
      +
      • -
    - - - -
    • -

      isAtLeast

      -
      public boolean isAtLeast(NuixVersion other)
      +
      +

      isAtLeast

      +
      public boolean isAtLeast​(NuixVersion other)
      Determines whether another instance's version is greater than or equal to this instance
      Parameters:
      @@ -597,15 +567,12 @@

      isAtLeast

      Returns:
      True if the other instance is greater than or equal to this instance, false otherwise
      +
      • -
    - - - -
    • -

      isGreaterThan

      -
      public boolean isGreaterThan(NuixVersion other)
      +
      +

      isGreaterThan

      +
      public boolean isGreaterThan​(NuixVersion other)
      Determines whether another instance's version is greater than this instance
      Parameters:
      @@ -613,15 +580,12 @@

      isGreaterThan

      Returns:
      True if the other instance is greater than this instance, false otherwise
      +
      • -
    - - - -
    • -

      isGreaterThan

      -
      public boolean isGreaterThan(java.lang.String other)
      +
      +

      isGreaterThan

      +
      public boolean isGreaterThan​(java.lang.String other)
      Determines whether another instance's version is greater than this instance
      Parameters:
      @@ -629,15 +593,12 @@

      isGreaterThan

      Returns:
      True if the other instance is greater than this instance, false otherwise
      +
      • -
    - - - -
    • -

      isEqualTo

      -
      public boolean isEqualTo(NuixVersion other)
      +
      +

      isEqualTo

      +
      public boolean isEqualTo​(NuixVersion other)
      Determines whether another instance's version is equal to this instance
      Parameters:
      @@ -645,15 +606,12 @@

      isEqualTo

      Returns:
      True if the other instance is greater than this instance, false otherwise
      +
      • -
    - - - -
    • -

      isEqualTo

      -
      public boolean isEqualTo(java.lang.String other)
      +
      +

      isEqualTo

      +
      public boolean isEqualTo​(java.lang.String other)
      Determines whether another instance's version is equal to this instance
      Parameters:
      @@ -661,15 +619,12 @@

      isEqualTo

      Returns:
      True if the other instance is equal to this instance (major, minor and release are the same), false otherwise
      +
      • -
    - - - -
    • -

      isLessThan

      -
      public boolean isLessThan(java.lang.String other)
      +
      +

      isLessThan

      +
      public boolean isLessThan​(java.lang.String other)
      Determines whether another instance's version is less than this instance
      Parameters:
      @@ -677,15 +632,12 @@

      isLessThan

      Returns:
      True if the other instance is a lower version, false otherwise
      +
      • -
    - - - -
    • -

      isAtLeast

      -
      public boolean isAtLeast(java.lang.String other)
      +
      +

      isAtLeast

      +
      public boolean isAtLeast​(java.lang.String other)
      Determines whether another instance's version is greater than or equal to this instance
      Parameters:
      @@ -693,53 +645,50 @@

      isAtLeast

      Returns:
      True if the other instance is greater than or equal to this instance, false otherwise
      +
      • -
    - - - -
    • -

      compareTo

      -
      public int compareTo(NuixVersion other)
      +
      +

      compareTo

      +
      public int compareTo​(NuixVersion other)
      Provides comparison logic when comparing two instances.
      Specified by:
      -
      compareTo in interface java.lang.Comparable<NuixVersion>
      +
      compareTo in interface java.lang.Comparable<NuixVersion>
      +
      • -
    - - - -
    • -

      toString

      -
      public java.lang.String toString()
      +
      +

      toString

      +
      public java.lang.String toString()
      Converts this instance back to a version string from its components, such as: "7.8.0.10"
      Overrides:
      toString in class java.lang.Object
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/PdfUtility.html b/docs/com/nuix/superutilities/misc/PdfUtility.html index 8ac44b7..c68ff71 100644 --- a/docs/com/nuix/superutilities/misc/PdfUtility.html +++ b/docs/com/nuix/superutilities/misc/PdfUtility.html @@ -1,42 +1,48 @@ - + PdfUtility + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class PdfUtility

    +
    Package com.nuix.superutilities.misc
    +

    Class PdfUtility

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.PdfUtility
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.PdfUtility
      +
      +
      -
      public class PdfUtility
 extends java.lang.Object
      A class containing some helper methods for PDFs.
      @@ -115,155 +99,168 @@

      Class PdfUtility

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        PdfUtility() PdfUtility() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidcreateWaterMarkedPdf(java.io.File inputFile, - java.io.File outputFile, - java.lang.String phrase, - int fontSize, - float opacity, - float rotation) +createWaterMarkedPdf​(java.io.File inputFile, +java.io.File outputFile, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation)
      Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
      static voidcreateWaterMarkedPdf(java.lang.String inputFile, - java.lang.String outputFile, - java.lang.String phrase, - int fontSize, - float opacity, - float rotation) +createWaterMarkedPdf​(java.lang.String inputFile, +java.lang.String outputFile, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation)
      Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
      static voidmergePdfFiles(java.io.File outputFile, - java.util.List<java.io.File> inputFiles, - boolean createBookmarks, - java.util.List<java.lang.String> bookmarkTitles) +mergePdfFiles​(java.io.File outputFile, +java.util.List<java.io.File> inputFiles, +boolean createBookmarks, +java.util.List<java.lang.String> bookmarkTitles)
      Merges multiple PDF files into a single PDF file.
      static voidmergePdfFiles(java.lang.String outputFile, - java.util.List<java.lang.String> inputFiles, - boolean createBookmarks, - java.util.List<java.lang.String> bookmarkTitles) +mergePdfFiles​(java.lang.String outputFile, +java.util.List<java.lang.String> inputFiles, +boolean createBookmarks, +java.util.List<java.lang.String> bookmarkTitles)
      Merges multiple PDF files into a single PDF file.
      static voidwaterMarkPrintedImages(java.io.File tempDirectory, - java.util.Collection<nuix.Item> items, - java.lang.String phrase, - int fontSize, - float opacity, - float rotation, - java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> progressCallback) +waterMarkPrintedImages​(java.io.File tempDirectory, +java.util.Collection<nuix.Item> items, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation, +java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> progressCallback)
      This method applies water marks to printed images of items.
      static voidwaterMarkPrintedImages(java.lang.String tempDirectory, - java.util.Collection<nuix.Item> items, - java.lang.String phrase, - int fontSize, - float opacity, - float rotation, - java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> progressCallback) +waterMarkPrintedImages​(java.lang.String tempDirectory, +java.util.Collection<nuix.Item> items, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation, +java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> progressCallback)
      This method applies water marks to printed images of items.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            PdfUtility

            -
            public PdfUtility()
            +
            +

            PdfUtility

            +
            public PdfUtility()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          mergePdfFiles

          -
          public static void mergePdfFiles(java.io.File outputFile,
-                                 java.util.List<java.io.File> inputFiles,
-                                 boolean createBookmarks,
-                                 java.util.List<java.lang.String> bookmarkTitles)
-                          throws java.lang.Exception
          +
          +

          mergePdfFiles

          +
          public static void mergePdfFiles​(java.io.File outputFile, +java.util.List<java.io.File> inputFiles, +boolean createBookmarks, +java.util.List<java.lang.String> bookmarkTitles) + throws java.lang.Exception
          Merges multiple PDF files into a single PDF file. Optionally can create book marks corresponding to the beginning page of each constituent PDFs.
          @@ -275,19 +272,16 @@

          mergePdfFiles

          Throws:
          java.lang.Exception - Thrown if an error occurs
          +
          • -
        - - - -
        • -

          mergePdfFiles

          -
          public static void mergePdfFiles(java.lang.String outputFile,
-                                 java.util.List<java.lang.String> inputFiles,
-                                 boolean createBookmarks,
-                                 java.util.List<java.lang.String> bookmarkTitles)
-                          throws java.lang.Exception
          +
          +

          mergePdfFiles

          +
          public static void mergePdfFiles​(java.lang.String outputFile, +java.util.List<java.lang.String> inputFiles, +boolean createBookmarks, +java.util.List<java.lang.String> bookmarkTitles) + throws java.lang.Exception
          Merges multiple PDF files into a single PDF file. Optionally can create book marks corresponding to the beginning page of each constituent PDFs.
          @@ -299,21 +293,18 @@

          mergePdfFiles

          Throws:
          java.lang.Exception - Thrown if an error occurs
          +
          • -
        - - - -
        • -

          createWaterMarkedPdf

          -
          public static void createWaterMarkedPdf(java.lang.String inputFile,
-                                        java.lang.String outputFile,
-                                        java.lang.String phrase,
-                                        int fontSize,
-                                        float opacity,
-                                        float rotation)
-                                 throws java.lang.Exception
          +
          +

          createWaterMarkedPdf

          +
          public static void createWaterMarkedPdf​(java.lang.String inputFile, +java.lang.String outputFile, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation) + throws java.lang.Exception
          Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
          Parameters:
          @@ -326,21 +317,18 @@

          createWaterMarkedPdf

          Throws:
          java.lang.Exception - Thrown if: Input file does not exist, error creating stream to output file, error creating PDFReader or PDFStamper.
          +
          • -
        - - - -
        • -

          createWaterMarkedPdf

          -
          public static void createWaterMarkedPdf(java.io.File inputFile,
-                                        java.io.File outputFile,
-                                        java.lang.String phrase,
-                                        int fontSize,
-                                        float opacity,
-                                        float rotation)
-                                 throws java.lang.Exception
          +
          +

          createWaterMarkedPdf

          +
          public static void createWaterMarkedPdf​(java.io.File inputFile, +java.io.File outputFile, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation) + throws java.lang.Exception
          Takes a given source PDF file, creates a copy output PDF file in which a watermark has been applied.
          Parameters:
          @@ -353,22 +341,19 @@

          createWaterMarkedPdf

          Throws:
          java.lang.Exception - Thrown if: Input file does not exist, error creating stream to output file, error creating PDFReader or PDFStamper.
          +
          • -
        - - - -
        • -

          waterMarkPrintedImages

          -
          public static void waterMarkPrintedImages(java.lang.String tempDirectory,
-                                          java.util.Collection<nuix.Item> items,
-                                          java.lang.String phrase,
-                                          int fontSize,
-                                          float opacity,
-                                          float rotation,
-                                          java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> progressCallback)
-                                   throws java.lang.Exception
          +
          +

          waterMarkPrintedImages

          +
          public static void waterMarkPrintedImages​(java.lang.String tempDirectory, +java.util.Collection<nuix.Item> items, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation, +java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> progressCallback) + throws java.lang.Exception
          This method applies water marks to printed images of items. Each item has a PDF exported, from which a water marked copy is generated. The water marked copy is then imported back in to Nuix as the new printed image of the given item.
          @@ -385,22 +370,19 @@

          waterMarkPrintedImages

          Throws:
          java.lang.Exception - Thrown if something goes wrong.
          +
          • -
        - - - -
        • -

          waterMarkPrintedImages

          -
          public static void waterMarkPrintedImages(java.io.File tempDirectory,
-                                          java.util.Collection<nuix.Item> items,
-                                          java.lang.String phrase,
-                                          int fontSize,
-                                          float opacity,
-                                          float rotation,
-                                          java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> progressCallback)
-                                   throws java.lang.Exception
          +
          +

          waterMarkPrintedImages

          +
          public static void waterMarkPrintedImages​(java.io.File tempDirectory, +java.util.Collection<nuix.Item> items, +java.lang.String phrase, +int fontSize, +float opacity, +float rotation, +java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> progressCallback) + throws java.lang.Exception
          This method applies water marks to printed images of items. Each item has a PDF exported, from which a water marked copy is generated. The water marked copy is then imported back in to Nuix as the new printed image of the given item.
          @@ -417,25 +399,28 @@

          waterMarkPrintedImages

          Throws:
          java.lang.Exception - Thrown if something goes wrong.
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/PlaceholderResolver.html b/docs/com/nuix/superutilities/misc/PlaceholderResolver.html index afcd126..acc1600 100644 --- a/docs/com/nuix/superutilities/misc/PlaceholderResolver.html +++ b/docs/com/nuix/superutilities/misc/PlaceholderResolver.html @@ -1,42 +1,48 @@ - + PlaceholderResolver + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class PlaceholderResolver

    +
    Package com.nuix.superutilities.misc
    +

    Class PlaceholderResolver

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.PlaceholderResolver
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.PlaceholderResolver
      +
      +
      -
      public class PlaceholderResolver
 extends java.lang.Object
      This class provides a way to allow user input to make use of place holder values which will be @@ -116,157 +100,175 @@

      Class PlaceholderResolverAuthor:
      Jason Wells
      -

      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static java.lang.StringcleanPathString(java.lang.String input) +cleanPathString​(java.lang.String input)
      Helper method to strip common illegal path characters from a string
      voidclear() +clear()
      Clears all currently associated place holders (keys and values)
      java.lang.Stringget(java.lang.String key) +get​(java.lang.String key)
      Get the value currently associated for a given placeholder
      java.util.Map<java.lang.String,java.lang.String>getPlaceholderData() +
      java.util.Map<java.lang.String,​java.lang.String>getPlaceholderData()
      Gets the Map containing all the current place holder data
      java.lang.StringresolveTemplate(java.lang.String template) +resolveTemplate​(java.lang.String template)
      Resolves place holders into a string based on the currently associated values
      java.util.Set<java.lang.String>resolveTemplateMultiValues(java.lang.String template, - java.util.List<NamedStringList> multiValuePlaceholders) +resolveTemplateMultiValues​(java.lang.String template, +java.util.List<NamedStringList> multiValuePlaceholders)
      Resolves place holders into a string based on the currently associated values and the multi-value place holders provided.
      java.lang.StringresolveTemplatePath(java.lang.String template) +resolveTemplatePath​(java.lang.String template)
      Resolves place holders into a path string based on the currently associated values.
      java.util.Set<java.lang.String>resolveTemplatePathMultiValues(java.lang.String template, - java.util.List<NamedStringList> multiValuePlaceholders) +resolveTemplatePathMultiValues​(java.lang.String template, +java.util.List<NamedStringList> multiValuePlaceholders)
      Resolves place holders into a string based on the currently associated values and the multi-value place holders provided.
      voidset(java.lang.String key, - java.lang.String value) +set​(java.lang.String key, +java.lang.String value)
      Set they value for a given placeholder
      voidsetFromItem(nuix.Item item) +setFromItem​(nuix.Item item)
      Automatically sets various place holders based on the provided item.
      voidsetPath(java.lang.String key, - java.lang.String value) -
      Similar to the set(java.lang.String, java.lang.String) method except this has logic to appropriately handle file paths.
      +      		setPath​(java.lang.String key, +java.lang.String value) +
      Similar to the set(java.lang.String, java.lang.String) method except this has logic to appropriately handle file paths.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            PlaceholderResolver

            -
            public PlaceholderResolver()
            +
            +

            PlaceholderResolver

            +
            public PlaceholderResolver()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          setFromItem

          -
          public void setFromItem(nuix.Item item)
          +
          +

          setFromItem

          +
          public void setFromItem​(nuix.Item item)
          Automatically sets various place holders based on the provided item. Place holders set:

          {guid} - The item's GUID.
          {guid_prefix} Characters 0-2 of the item's GUID. Useful for creating sub-directories based on GUID.
          @@ -292,47 +294,38 @@

          setFromItem

          Parameters:
          item - The item used to set all of the item based placeholder values.
          +
          • -
        - - - -
        • -

          set

          -
          public void set(java.lang.String key,
-                java.lang.String value)
          +
          +

          set

          +
          public void set​(java.lang.String key, +java.lang.String value)
          Set they value for a given placeholder
          Parameters:
          key - The placeholder name without '{' or '}'
          value - The value to associate
          +
          • -
        - - - -
        • -

          setPath

          -
          public void setPath(java.lang.String key,
-                    java.lang.String value)
          -
          Similar to the set(java.lang.String, java.lang.String) method except this has logic to appropriately handle file paths.
          +
          +

          setPath

          +
          public void setPath​(java.lang.String key, +java.lang.String value)
          +
          Similar to the set(java.lang.String, java.lang.String) method except this has logic to appropriately handle file paths.
          Parameters:
          key - The placeholder name without '{' or '}'
          value - The file/directory path value to associate
          +
          • -
        - - - -
        • -

          get

          -
          public java.lang.String get(java.lang.String key)
          +
          +

          get

          +
          public java.lang.String get​(java.lang.String key)
          Get the value currently associated for a given placeholder
          Parameters:
          @@ -340,39 +333,30 @@

          get

          Returns:
          The currently associated placeholder value
          +
          • -
        - - - -
        • -

          clear

          -
          public void clear()
          +
          +

          clear

          +
          public void clear()
          Clears all currently associated place holders (keys and values)
          +
          • -
        - - - -
        • -

          getPlaceholderData

          -
          public java.util.Map<java.lang.String,java.lang.String> getPlaceholderData()
          +
          +

          getPlaceholderData

          +
          public java.util.Map<java.lang.String,​java.lang.String> getPlaceholderData()
          Gets the Map containing all the current place holder data
          Returns:
          A Map containing all the current place holder data
          +
          • -
        - - - -
        • -

          resolveTemplate

          -
          public java.lang.String resolveTemplate(java.lang.String template)
          +
          +

          resolveTemplate

          +
          public java.lang.String resolveTemplate​(java.lang.String template)
          Resolves place holders into a string based on the currently associated values
          Parameters:
          @@ -380,19 +364,16 @@

          resolveTemplate

          Returns:
          The input string in which place holders have been replaced with associated values
          +
          • -
        - - - -
        • -

          resolveTemplateMultiValues

          -
          public java.util.Set<java.lang.String> resolveTemplateMultiValues(java.lang.String template,
-                                                                  java.util.List<NamedStringList> multiValuePlaceholders)
          +
          +

          resolveTemplateMultiValues

          +
          public java.util.Set<java.lang.String> resolveTemplateMultiValues​(java.lang.String template, +java.util.List<NamedStringList> multiValuePlaceholders)
          Resolves place holders into a string based on the currently associated values and the multi-value place holders provided. For example imagine you wish to render the template 1 time for each tag associated to an item that has 3 tags assigned. You can call this method, - providing a NamedStringList with a name of tags and those 3 tags as values. This method will then return 3 resolutions + providing a NamedStringList with a name of tags and those 3 tags as values. This method will then return 3 resolutions of a template containing the placeholder {tags}. Each returned result containing 1 of the 3 tags substituted. This method allows you to provide multiple multi-value place holders like this, but it is important to note the number of resulting values is multiplied. So if I provide a placeholder animals with 3 values, a placeholder colors with 5 values and a placeholder names with 4 values, the number @@ -404,15 +385,12 @@

          resolveTemplateMultiValues

          Returns:
          The various resulting values generated from all the combinations.
          +
          • -
        - - - -
        • -

          resolveTemplatePath

          -
          public java.lang.String resolveTemplatePath(java.lang.String template)
          +
          +

          resolveTemplatePath

          +
          public java.lang.String resolveTemplatePath​(java.lang.String template)
          Resolves place holders into a path string based on the currently associated values. Contains logic to sterilize the resulting path string so that it does not contain common illegal path characters.
          @@ -421,25 +399,22 @@

          resolveTemplatePath

          Returns:
          The input string in which place holders have been replaced with associated values
          +
          • -
        - - - -
        • -

          resolveTemplatePathMultiValues

          -
          public java.util.Set<java.lang.String> resolveTemplatePathMultiValues(java.lang.String template,
-                                                                      java.util.List<NamedStringList> multiValuePlaceholders)
          +
          +

          resolveTemplatePathMultiValues

          +
          public java.util.Set<java.lang.String> resolveTemplatePathMultiValues​(java.lang.String template, +java.util.List<NamedStringList> multiValuePlaceholders)
          Resolves place holders into a string based on the currently associated values and the multi-value place holders provided. For example imagine you wish to render the template 1 time for each tag associated to an item that has 3 tags assigned. You can call this method, - providing a NamedStringList with a name of tags and those 3 tags as values. This method will then return 3 resolutions + providing a NamedStringList with a name of tags and those 3 tags as values. This method will then return 3 resolutions of a template containing the placeholder {tags}. Each returned result containing 1 of the 3 tags substituted. This method allows you to provide multiple multi-value place holders like this, but it is important to note the number of resulting values is multiplied. So if I provide a placeholder animals with 3 values, a placeholder colors with 5 values and a placeholder names with 4 values, the number of possible resulting values is 3*5*4=60. - This method is similar to {resolveTemplateMultiValues(String, List) except the template is resolved using {resolveTemplatePath(String) instead - of the method {resolveTemplate(String) which is used by {resolveTemplateMultiValues(String, List).
          + This method is similar to {resolveTemplateMultiValues(String, List) except the template is resolved using {resolveTemplatePath(String) instead + of the method {resolveTemplate(String) which is used by {resolveTemplateMultiValues(String, List).
    Parameters:
    template - The template to resolve
    @@ -447,15 +422,12 @@

    resolveTemplatePathMultiValues

    Returns:
    The various resulting values generated from all the combinations.
    + - - - - -
    • -

      cleanPathString

      -
      public static java.lang.String cleanPathString(java.lang.String input)
      +
      +

      cleanPathString

      +
      public static java.lang.String cleanPathString​(java.lang.String input)
      Helper method to strip common illegal path characters from a string
      Parameters:
      @@ -463,25 +435,28 @@

      cleanPathString

      Returns:
      The string with illegal path characters replaced with '_'
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/ProfileDigester.html b/docs/com/nuix/superutilities/misc/ProfileDigester.html index af72281..0393f18 100644 --- a/docs/com/nuix/superutilities/misc/ProfileDigester.html +++ b/docs/com/nuix/superutilities/misc/ProfileDigester.html @@ -1,42 +1,48 @@ - + ProfileDigester + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class ProfileDigester

    +
    Package com.nuix.superutilities.misc
    +

    Class ProfileDigester

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.ProfileDigester
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.ProfileDigester
      +
      +
      -
      public class ProfileDigester
 extends java.lang.Object
      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.
      @@ -115,235 +99,259 @@

      Class ProfileDigester

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          ProfileDigester

          -
          public ProfileDigester()
          +
          +

          ProfileDigester

          +
          public ProfileDigester()
          +
          • -
        - - - -
        • -

          ProfileDigester

          -
          public ProfileDigester(nuix.MetadataProfile metadataProfile)
          +
          +

          ProfileDigester

          +
          public ProfileDigester​(nuix.MetadataProfile metadataProfile)
          +
        +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          whenProgressUpdated

          -
          public void whenProgressUpdated(java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> callback)
          -
          Invoked when progress is updated in addItemsToItemSet(Case, String, String, Collection). Provides 2 integers, the first is current progress and the second is total progress.
          +
          +

          whenProgressUpdated

          +
          public void whenProgressUpdated​(java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> callback)
          +
          Invoked when progress is updated in addItemsToItemSet(Case, String, String, Collection). Provides 2 integers, the first is current progress and the second is total progress.
          Parameters:
          callback - Callback to be invoked when progress is updated.
          +
          • -
        - - - - - - - -
        • -

          whenErrorLogged

          -
          public void whenErrorLogged(java.util.function.BiConsumer<java.lang.String,nuix.Item> callback)
          -
          Invoked when an error occurs in addItemsToItemSet(Case, String, String, Collection). Provides a message String and the item being processed when +
          +

          whenErrorLogged

          +
          public void whenErrorLogged​(java.util.function.BiConsumer<java.lang.String,​nuix.Item> callback)
          +
          Invoked when an error occurs in addItemsToItemSet(Case, String, String, Collection). Provides a message String and the item being processed when the error occurred. If callback is not provided, message will instead be sent to Nuix log.
          Parameters:
          callback - Callback invoked when an error occurs. If a callback is not provided, message is instead sent to Nuix log as an error.
          +
          • -
        - - - -
        • -

          addItemsToItemSet

          -
          public nuix.ItemSet addItemsToItemSet(nuix.Case nuixCase,
-                                      java.lang.String itemSetName,
-                                      java.lang.String deduplicateBy,
-                                      java.util.Collection<nuix.Item> items)
          +
          +

          addItemsToItemSet

          +
          public nuix.ItemSet addItemsToItemSet​(nuix.Case nuixCase, +java.lang.String itemSetName, +java.lang.String deduplicateBy, +java.util.Collection<nuix.Item> items)
          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. Additionally can include an items content text in the concatenated values. Effectively this allows you to create an item set where rather than deduplicating by the MD5 Nuix calculated for a given item during @@ -359,16 +367,13 @@

          addItemsToItemSet

          Returns:
          The item set the items were added to.
          +
          • -
        - - - -
        • -

          generateMd5Bytes

          -
          public byte[] generateMd5Bytes(nuix.Item item)
-                        throws java.lang.Exception
          +
          +

          generateMd5Bytes

          +
          public byte[] generateMd5Bytes​(nuix.Item item) + throws java.lang.Exception
          Generates MD5 digest byte array for a given item. Digest is generated by digesting concatenation of values yielded by the metadata profile associated with this instance for the given item and optionally including the item's content text. Note that method is synchronized due to: @@ -382,19 +387,16 @@

          generateMd5Bytes

          Throws:
          java.lang.Exception - Most likely if metadata profile has not yet been set for this instance.
          +
          • -
        - - - -
        • -

          generateMd5String

          -
          public java.lang.String generateMd5String(nuix.Item item)
-                                   throws java.lang.Exception
          +
          +

          generateMd5String

          +
          public java.lang.String generateMd5String​(nuix.Item item) + throws java.lang.Exception
          Generates MD5 digest hex string for a given item. Digest is generated by digesting values concatenation of values yielded by the metadata profile associated with this instance for the given item and optionally including the item's content text. - Internally this method first calls generateMd5Bytes(Item) then converts the result of that method + Internally this method first calls generateMd5Bytes(Item) then converts the result of that method into a hexadecimal string.
          Parameters:
          @@ -404,139 +406,144 @@

          generateMd5String

          Throws:
          java.lang.Exception - Most likely if metadata profile has not yet been set for this instance.
          +
          • -
        - - - -
        • -

          getIncludeItemText

          -
          public boolean getIncludeItemText()
          +
          +

          getIncludeItemText

          +
          public boolean getIncludeItemText()
          Gets whether this instance should include the item's content text when calculating a digest.
          Returns:
          Whether this instance should include the item's content text when calculating a digest.
          +
          • -
        - - - -
        • -

          setIncludeItemText

          -
          public void setIncludeItemText(boolean includeItemText)
          +
          +

          setIncludeItemText

          +
          public void setIncludeItemText​(boolean includeItemText)
          Sets whether this instance should include the item's content text when calculating a digest.
          Parameters:
          includeItemText - Whether this instance should include the item's content text when calculating a digest.
          +
          • -
        - - - -
        • -

          getProfile

          -
          public nuix.MetadataProfile getProfile()
          +
          +

          getProfile

          +
          public nuix.MetadataProfile getProfile()
          Gets the metadata profile used to obtain the values provided to the hash computation.
          Returns:
          The metadata profile used to obtain the values provided to the hash computation.
          +
          • -
        - - - -
        • -

          setProfile

          -
          public void setProfile(nuix.MetadataProfile profile)
          +
          +

          setProfile

          +
          public void setProfile​(nuix.MetadataProfile profile)
          Sets the metadata profile used to obtain the values provided to the hash computation.
          Parameters:
          profile - The metadata profile used to obtain the values provided to the hash computation.
          +
          • -
        - - - -
        • -

          getRecordDigest

          -
          public boolean getRecordDigest()
          +
          +

          getRecordDigest

          +
          public boolean getRecordDigest()
          Gets whether this instance will record the digest used.
          Returns:
          Whether this instance will record the digest used.
          +
          • -
        - - - -
        • -

          setRecordDigest

          -
          public void setRecordDigest(boolean recordDigest)
          +
          +

          setRecordDigest

          +
          public void setRecordDigest​(boolean recordDigest)
          Sets whether this instance will record the digest used.
          Parameters:
          recordDigest - Whether this instance will record the digest used.
          +
          • -
        - - - -
        • -

          getDigestCustomField

          -
          public java.lang.String getDigestCustomField()
          +
          +

          getDigestCustomField

          +
          public java.lang.String getDigestCustomField()
          Gets the name of the custom metadata field used to record custom digest when - getRecordDigest() returns true.
          + getRecordDigest() returns true.
    Returns:
    Name of the custom metadata field used to record custom digest.
    + - - - - -
    • -

      setDigestCustomField

      -
      public void setDigestCustomField(java.lang.String digestCustomField)
      +
      +

      setDigestCustomField

      +
      public void setDigestCustomField​(java.lang.String digestCustomField)
      Sets the name of the custom metadata field used to record custom digest when - getRecordDigest() returns true.
      + getRecordDigest() returns true.
      Parameters:
      digestCustomField - Name of the custom metadata field used to record custom digest.
      +
      • -
    +
  • +
    +

    getUseExistingValueWhenPresent

    +
    public boolean getUseExistingValueWhenPresent()
    +
    Gets whether an existing value in the specified custom metadata field should be used if present. When true, + if an item has the custom field specified by calling setDigestCustomField(String) and it has a value, that value will + be used rather than calculating a value. If false the value will always be calculated fresh.
    +
    +
    Returns:
    +
    Whether an existing value in the specified custom metadata field should be used when present
    +
    +
    +
    • +
  • +
    +

    setUseExistingValueWhenPresent

    +
    public void setUseExistingValueWhenPresent​(boolean useExistingValueWhenPresent)
    +
    Sets whether an existing value in the specified custom metadata field should be used if present. When true, + if an item has the custom field specified by calling setDigestCustomField(String) and it has a value, that value will + be used rather than calculating a value. If false the value will always be calculated fresh.
    +
    +
    Parameters:
    +
    useExistingValueWhenPresent - whether an existing value in the specified custom metadata field should be used if present
    +
    +
    • + - + + + + + diff --git a/docs/com/nuix/superutilities/misc/SQLiteBacked.html b/docs/com/nuix/superutilities/misc/SQLiteBacked.html index d64a5b3..41c9110 100644 --- a/docs/com/nuix/superutilities/misc/SQLiteBacked.html +++ b/docs/com/nuix/superutilities/misc/SQLiteBacked.html @@ -1,42 +1,48 @@ - + SQLiteBacked + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class SQLiteBacked

    +
    Package com.nuix.superutilities.misc
    +

    Class SQLiteBacked

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.SQLiteBacked
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.SQLiteBacked
      +
      +
      All Implemented Interfaces:
      -
      java.io.Closeable, java.lang.AutoCloseable
      +
      java.io.Closeable, java.lang.AutoCloseable
      Direct Known Subclasses:
      -
      AnnotationRepository
      +
      AnnotationRepository
      -
      public class SQLiteBacked
 extends java.lang.Object
 implements java.io.Closeable
      @@ -125,180 +109,201 @@

      Class SQLiteBacked

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        SQLiteBacked(java.io.File databaseFile) SQLiteBacked​(java.io.File databaseFile) 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + - + - + - + - + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidclose() close() 
      voidexecuteInsert(java.lang.String sql, - java.util.List<java.lang.Object> data) +executeInsert​(java.lang.String sql, +java.lang.Object... data)
      Executes an insert query against the SQLite database file
      voidexecuteInsert(java.lang.String sql, - java.lang.Object... data) +executeInsert​(java.lang.String sql, +java.util.List<java.lang.Object> data)
      Executes an insert query against the SQLite database file
      java.lang.LongexecuteLongScalar(java.lang.String sql) +executeLongScalar​(java.lang.String sql)
      Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
      java.lang.LongexecuteLongScalar(java.lang.String sql, - java.util.List<java.lang.Object> data) +executeLongScalar​(java.lang.String sql, +java.lang.Object... data)
      Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
      java.lang.LongexecuteLongScalar(java.lang.String sql, - java.lang.Object... data) +executeLongScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data)
      Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
      voidexecuteQuery(java.lang.String sql, - java.util.List<java.lang.Object> data, - java.util.function.Consumer<java.sql.ResultSet> resultConsumer) +executeQuery​(java.lang.String sql, +java.util.List<java.lang.Object> data, +java.util.function.Consumer<java.sql.ResultSet> resultConsumer)
      Executes a query which is expected to return row data, providing the result set to the provided callback.
      <T> TexecuteScalar(java.lang.String sql, - java.lang.Object... data) executeScalar​(java.lang.String sql, +java.lang.Object... data) 
      java.lang.StringexecuteStringScalar(java.lang.String sql) +executeStringScalar​(java.lang.String sql)
      Executes SQL which is expected to return a single string value.
      java.lang.StringexecuteStringScalar(java.lang.String sql, - java.util.List<java.lang.Object> data) +executeStringScalar​(java.lang.String sql, +java.lang.Object... data)
      Executes SQL which is expected to return a single string value.
      java.lang.StringexecuteStringScalar(java.lang.String sql, - java.lang.Object... data) +executeStringScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data)
      Executes SQL which is expected to return a single string value.
      intexecuteUpdate(java.lang.String sql) +executeUpdate​(java.lang.String sql)
      Executes an update query against the SQLite database file
      intexecuteUpdate(java.lang.String sql, - java.util.List<java.lang.Object> data) +executeUpdate​(java.lang.String sql, +java.lang.Object... data)
      Executes an update query against the SQLite database file
      intexecuteUpdate(java.lang.String sql, - java.lang.Object... data) +executeUpdate​(java.lang.String sql, +java.util.List<java.lang.Object> data)
      Executes an update query against the SQLite database file
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            SQLiteBacked

            -
            public SQLiteBacked(java.io.File databaseFile)
            +
            +

            SQLiteBacked

            +
            public SQLiteBacked​(java.io.File databaseFile)
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          executeUpdate

          -
          public int executeUpdate(java.lang.String sql,
-                         java.util.List<java.lang.Object> data)
-                  throws java.sql.SQLException
          +
          +

          executeUpdate

          +
          public int executeUpdate​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
          Executes an update query against the SQLite database file
          Parameters:
          @@ -309,17 +314,14 @@

          executeUpdate

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeUpdate

          -
          public int executeUpdate(java.lang.String sql,
-                         java.lang.Object... data)
-                  throws java.sql.SQLException
          +
          +

          executeUpdate

          +
          public int executeUpdate​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
          Executes an update query against the SQLite database file
          Parameters:
          @@ -330,16 +332,13 @@

          executeUpdate

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeUpdate

          -
          public int executeUpdate(java.lang.String sql)
-                  throws java.sql.SQLException
          +
          +

          executeUpdate

          +
          public int executeUpdate​(java.lang.String sql) + throws java.sql.SQLException
          Executes an update query against the SQLite database file
          Parameters:
          @@ -349,17 +348,14 @@

          executeUpdate

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeInsert

          -
          public void executeInsert(java.lang.String sql,
-                          java.util.List<java.lang.Object> data)
-                   throws java.sql.SQLException
          +
          +

          executeInsert

          +
          public void executeInsert​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
          Executes an insert query against the SQLite database file
          Parameters:
          @@ -368,17 +364,14 @@

          executeInsert

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeInsert

          -
          public void executeInsert(java.lang.String sql,
-                          java.lang.Object... data)
-                   throws java.sql.SQLException
          +
          +

          executeInsert

          +
          public void executeInsert​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
          Executes an insert query against the SQLite database file
          Parameters:
          @@ -387,17 +380,14 @@

          executeInsert

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeLongScalar

          -
          public java.lang.Long executeLongScalar(java.lang.String sql,
-                                        java.lang.Object... data)
-                                 throws java.sql.SQLException
          +
          +

          executeLongScalar

          +
          public java.lang.Long executeLongScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
          Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
          Parameters:
          @@ -408,17 +398,14 @@

          executeLongScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeLongScalar

          -
          public java.lang.Long executeLongScalar(java.lang.String sql,
-                                        java.util.List<java.lang.Object> data)
-                                 throws java.sql.SQLException
          +
          +

          executeLongScalar

          +
          public java.lang.Long executeLongScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
          Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
          Parameters:
          @@ -429,16 +416,13 @@

          executeLongScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeLongScalar

          -
          public java.lang.Long executeLongScalar(java.lang.String sql)
-                                 throws java.sql.SQLException
          +
          +

          executeLongScalar

          +
          public java.lang.Long executeLongScalar​(java.lang.String sql) + throws java.sql.SQLException
          Executes SQL which is expected to return a single long/int value, such as a COUNT statement would.
          Parameters:
          @@ -448,17 +432,14 @@

          executeLongScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeStringScalar

          -
          public java.lang.String executeStringScalar(java.lang.String sql,
-                                            java.lang.Object... data)
-                                     throws java.sql.SQLException
          +
          +

          executeStringScalar

          +
          public java.lang.String executeStringScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
          Executes SQL which is expected to return a single string value.
          Parameters:
          @@ -469,17 +450,14 @@

          executeStringScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeStringScalar

          -
          public java.lang.String executeStringScalar(java.lang.String sql,
-                                            java.util.List<java.lang.Object> data)
-                                     throws java.sql.SQLException
          +
          +

          executeStringScalar

          +
          public java.lang.String executeStringScalar​(java.lang.String sql, +java.util.List<java.lang.Object> data) + throws java.sql.SQLException
          Executes SQL which is expected to return a single string value.
          Parameters:
          @@ -490,16 +468,13 @@

          executeStringScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeStringScalar

          -
          public java.lang.String executeStringScalar(java.lang.String sql)
-                                     throws java.sql.SQLException
          +
          +

          executeStringScalar

          +
          public java.lang.String executeStringScalar​(java.lang.String sql) + throws java.sql.SQLException
          Executes SQL which is expected to return a single string value.
          Parameters:
          @@ -509,33 +484,27 @@

          executeStringScalar

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          executeScalar

          -
          public <T> T executeScalar(java.lang.String sql,
-                           java.lang.Object... data)
-                    throws java.sql.SQLException
          +
          +

          executeScalar

          +
          public <T> T executeScalar​(java.lang.String sql, +java.lang.Object... data) + throws java.sql.SQLException
          Throws:
          java.sql.SQLException
          +
          • -
        - - - -
        • -

          executeQuery

          -
          public void executeQuery(java.lang.String sql,
-                         java.util.List<java.lang.Object> data,
-                         java.util.function.Consumer<java.sql.ResultSet> resultConsumer)
-                  throws java.sql.SQLException
          +
          +

          executeQuery

          +
          public void executeQuery​(java.lang.String sql, +java.util.List<java.lang.Object> data, +java.util.function.Consumer<java.sql.ResultSet> resultConsumer) + throws java.sql.SQLException
          Executes a query which is expected to return row data, providing the result set to the provided callback.
          Parameters:
          @@ -545,43 +514,43 @@

          executeQuery

          Throws:
          java.sql.SQLException - If the SQL bits throw an error
          +
          • -
        - - - -
        • -

          close

          -
          public void close()
-           throws java.io.IOException
          +
          +

          close

          +
          public void close() + throws java.io.IOException
          Specified by:
          -
          close in interface java.io.Closeable
          -
          Specified by:
          close in interface java.lang.AutoCloseable
          +
          Specified by:
          +
          close in interface java.io.Closeable
          Throws:
          java.io.IOException
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/SimilarityCalculation.html b/docs/com/nuix/superutilities/misc/SimilarityCalculation.html index 4ab158a..0ed9bd5 100644 --- a/docs/com/nuix/superutilities/misc/SimilarityCalculation.html +++ b/docs/com/nuix/superutilities/misc/SimilarityCalculation.html @@ -1,42 +1,48 @@ - + SimilarityCalculation + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Enum SimilarityCalculation

    +
    Package com.nuix.superutilities.misc
    +

    Enum SimilarityCalculation

    -
      -
    • java.lang.Object
      • -
    • - -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      java.lang.Enum<SimilarityCalculation> +
      com.nuix.superutilities.misc.SimilarityCalculation
      +
      +
      +
      All Implemented Interfaces:
      -
      java.io.Serializable, java.lang.Comparable<SimilarityCalculation>
      +
      java.io.Serializable, java.lang.Comparable<SimilarityCalculation>, java.lang.constant.Constable
      -
      public enum SimilarityCalculation
-extends java.lang.Enum<SimilarityCalculation>
      -
      Used by TermExpander to determine how fuzzy similarity should be +extends java.lang.Enum<SimilarityCalculation> +
      Used by TermExpander to determine how fuzzy similarity should be calculated to expand a given fuzzy term into matched terms.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Enum

    -compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf - -
      -
    • + - +compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +

    Methods inherited from class java.lang.Object

    -getClass, notify, notifyAll, wait, wait, wait - - - + + +getClass, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    + - - - - -
    • -

      valueOf

      -
      public static SimilarityCalculation valueOf(java.lang.String name)
      +
      +

      valueOf

      +
      public static SimilarityCalculation valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are @@ -295,25 +282,28 @@

      valueOf

      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/TermExpander.html b/docs/com/nuix/superutilities/misc/TermExpander.html index 272f158..bf9e013 100644 --- a/docs/com/nuix/superutilities/misc/TermExpander.html +++ b/docs/com/nuix/superutilities/misc/TermExpander.html @@ -1,42 +1,48 @@ - + TermExpander + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class TermExpander

    +
    Package com.nuix.superutilities.misc
    +

    Class TermExpander

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.TermExpander
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.TermExpander
      +
      +
      -
      public class TermExpander
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        TermExpander() TermExpander() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            TermExpander

            -
            public TermExpander()
            +
            +

            TermExpander

            +
            public TermExpander()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - -
        • -

          setFuzzyResolutionAlgorithm

          -
          public void setFuzzyResolutionAlgorithm(SimilarityCalculation resolutionAlgorithm)
          +
          +

          setFuzzyResolutionAlgorithm

          +
          public void setFuzzyResolutionAlgorithm​(SimilarityCalculation resolutionAlgorithm)
          Sets which method this instance will use to resolve fuzzy terms.
          Parameters:
          resolutionAlgorithm - The fuzzy term resolution method
          +
          • -
        - - - -
        • -

          whenProgressUpdated

          -
          public void whenProgressUpdated(java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> callback)
          -
          Allows you to provide a callback which will be invoked when expandTerm(Case, boolean, boolean, String, String) (or similar overloads) +
          +

          whenProgressUpdated

          +
          public void whenProgressUpdated​(java.util.function.BiConsumer<java.lang.Integer,​java.lang.Integer> callback)
          +
          Allows you to provide a callback which will be invoked when expandTerm(Case, boolean, boolean, String, String) (or similar overloads) make progress resolving a given term to matched terms.
          Parameters:
          callback - A BiConsumer that accepts 2 Integers, the first being current progress. The second being total progress.
          +
          • -
        - - - -
        • -

          expandTerm

          -
          public java.util.List<ExpandedTermInfo> expandTerm(nuix.Case nuixCase,
-                                                   java.lang.String term)
-                                            throws java.lang.Exception
          +
          +

          expandTerm

          +
          public java.util.List<ExpandedTermInfo> expandTerm​(nuix.Case nuixCase, +java.lang.String term) + throws java.lang.Exception
          This method "expands" a term to related terms in the specified case. The intent being to get an idea of what a wild card or fuzzy term may be expanding into were it to be used in a query. Its should only be provided single word terms, anything else will likely yield no or undefined results. Term provided may contain wild card matching characters or be a fuzzy term.

          @@ -290,30 +278,27 @@

          expandTerm

          c?n - Example terms: con, can, cnn

          A fuzzy term may also be provided. A fuzzy term is a term, followed by a tilde and optionally a similarity score. For example:
          jason~0.5 - Example terms: json, jevon, jasen, mason, juston, jayson, etc
          - This version of the method internally calls expandTerm(Case, boolean, boolean, String, String) providing true for arguments "content" and "properties" + This version of the method internally calls expandTerm(Case, boolean, boolean, String, String) providing true for arguments "content" and "properties" and a null scope query.
          Parameters:
          nuixCase - The Nuix case, needed to access case term statistics
          term - The term to expand upon examples: ca*, *th, c?n, jason~0.5
          Returns:
          -
          A list of ExpandedTermInfo objects, each containing information about a matched term.
          +
          A list of ExpandedTermInfo objects, each containing information about a matched term.
          Throws:
          java.lang.Exception - If something goes wrong
          +
          • -
        - - - -
        • -

          expandTerm

          -
          public java.util.List<ExpandedTermInfo> expandTerm(nuix.Case nuixCase,
-                                                   boolean content,
-                                                   boolean properties,
-                                                   java.lang.String term)
-                                            throws java.lang.Exception
          +
          +

          expandTerm

          +
          public java.util.List<ExpandedTermInfo> expandTerm​(nuix.Case nuixCase, +boolean content, +boolean properties, +java.lang.String term) + throws java.lang.Exception
          This method "expands" a term to related terms in the specified case. The intent being to get an idea of what a wild card or fuzzy term may be expanding into were it to be used in a query. Its should only be provided single word terms, anything else will likely yield no or undefined results. Term provided may contain wild card matching characters or be a fuzzy term.

          @@ -323,7 +308,7 @@

          expandTerm

          c?n - Example terms: con, can, cnn

          A fuzzy term may also be provided. A fuzzy term is a term, followed by a tilde and optionally a similarity score. For example:
          jason~0.5 - Example terms: json, jevon, jasen, mason, juston, jayson, etc
          - This version of the method internally calls expandTerm(Case, boolean, boolean, String, String) providing a null for scope query.
          + This version of the method internally calls expandTerm(Case, boolean, boolean, String, String) providing a null for scope query.
    Parameters:
    nuixCase - The Nuix case, needed to access case term statistics
    @@ -331,24 +316,21 @@

    expandTerm

    properties - Whether to include terms from item metadata properties
    term - The term to expand upon examples: ca*, *th, c?n, jason~0.5
    Returns:
    -
    A list of ExpandedTermInfo objects, each containing information about a matched term.
    +
    A list of ExpandedTermInfo objects, each containing information about a matched term.
    Throws:
    java.lang.Exception - If something goes wrong
    + - - - - -
    • -

      expandTerm

      -
      public java.util.List<ExpandedTermInfo> expandTerm(nuix.Case nuixCase,
-                                                   boolean content,
-                                                   boolean properties,
-                                                   java.lang.String term,
-                                                   java.lang.String scopeQuery)
-                                            throws java.lang.Exception
      +
      +

      expandTerm

      +
      public java.util.List<ExpandedTermInfo> expandTerm​(nuix.Case nuixCase, +boolean content, +boolean properties, +java.lang.String term, +java.lang.String scopeQuery) + throws java.lang.Exception
      This method "expands" a term to related terms in the specified case. The intent being to get an idea of what a wild card or fuzzy term may be expanding into were it to be used in a query. Its should only be provided single word terms, anything else will likely yield no or undefined results. Term provided may contain wild card matching characters or be a fuzzy term.

      @@ -366,29 +348,32 @@

      expandTerm

      term - The term to expand upon examples: ca*, *th, c?n, jason~0.5
      scopeQuery - A Nuix query which can be used to limit which items' terms are considered. An empty string or null will be all items in the case.
      Returns:
      -
      A list of ExpandedTermInfo objects, each containing information about a matched term.
      +
      A list of ExpandedTermInfo objects, each containing information about a matched term.
      Throws:
      java.lang.Exception - If something goes wrong
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/ZipHelper.html b/docs/com/nuix/superutilities/misc/ZipHelper.html index f7216d8..a5467ca 100644 --- a/docs/com/nuix/superutilities/misc/ZipHelper.html +++ b/docs/com/nuix/superutilities/misc/ZipHelper.html @@ -1,42 +1,48 @@ - + ZipHelper + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.misc
    -

    Class ZipHelper

    +
    Package com.nuix.superutilities.misc
    +

    Class ZipHelper

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.misc.ZipHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.misc.ZipHelper
      +
      +
      -
      public class ZipHelper
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        ZipHelper() ZipHelper() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + + + + + + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidcompressDirectoryToZipFile(java.lang.String directory, - java.lang.String zipFile, - int compressionLevel) +compressDirectoryToSevenZipFile​(java.lang.String directory, +java.lang.String sevenZipFile) 
      static voidcompressDirectoryToZipFile​(java.lang.String directory, +java.lang.String zipFile, +int compressionLevel)
      Compresses the contents of the given directory (files and sub-directories) in to a Zip file.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ZipHelper

            -
            public ZipHelper()
            +
            +

            ZipHelper

            +
            public ZipHelper()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            compressDirectoryToZipFile

            -
            public static void compressDirectoryToZipFile(java.lang.String directory,
-                                              java.lang.String zipFile,
-                                              int compressionLevel)
-                                       throws java.io.IOException,
-                                              java.io.FileNotFoundException
            +
            +

            compressDirectoryToSevenZipFile

            +
            public static void compressDirectoryToSevenZipFile​(java.lang.String directory, +java.lang.String sevenZipFile) + throws java.io.IOException
            +
            +
            Throws:
            +
            java.io.IOException
            +
            +
            +
            • +
          • +
            +

            compressDirectoryToZipFile

            +
            public static void compressDirectoryToZipFile​(java.lang.String directory, +java.lang.String zipFile, +int compressionLevel) + throws java.io.IOException, +java.io.FileNotFoundException
            Compresses the contents of the given directory (files and sub-directories) in to a Zip file.
            Parameters:
            @@ -213,25 +223,28 @@

            compressDirectoryToZipFile

            java.io.IOException - Thrown if there are issues with IO
            java.io.FileNotFoundException - Thrown if file is not found
            +
          +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/DigestList.html b/docs/com/nuix/superutilities/misc/class-use/DigestList.html index 20917d0..ff7c443 100644 --- a/docs/com/nuix/superutilities/misc/class-use/DigestList.html +++ b/docs/com/nuix/superutilities/misc/class-use/DigestList.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.DigestList + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.DigestList

    +

    Uses of Class
    com.nuix.superutilities.misc.DigestList

    No usage of com.nuix.superutilities.misc.DigestList
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/DriveSpaceInfo.html b/docs/com/nuix/superutilities/misc/class-use/DriveSpaceInfo.html index b67d63e..6e23fd7 100644 --- a/docs/com/nuix/superutilities/misc/class-use/DriveSpaceInfo.html +++ b/docs/com/nuix/superutilities/misc/class-use/DriveSpaceInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.DriveSpaceInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.DriveSpaceInfo

    +

    Uses of Class
    com.nuix.superutilities.misc.DriveSpaceInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/ExpandedTermInfo.html b/docs/com/nuix/superutilities/misc/class-use/ExpandedTermInfo.html index 6a5623d..cb4926b 100644 --- a/docs/com/nuix/superutilities/misc/class-use/ExpandedTermInfo.html +++ b/docs/com/nuix/superutilities/misc/class-use/ExpandedTermInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.ExpandedTermInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.ExpandedTermInfo

    +

    Uses of Class
    com.nuix.superutilities.misc.ExpandedTermInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/FormatUtility.html b/docs/com/nuix/superutilities/misc/class-use/FormatUtility.html index d0d5cd3..227b91c 100644 --- a/docs/com/nuix/superutilities/misc/class-use/FormatUtility.html +++ b/docs/com/nuix/superutilities/misc/class-use/FormatUtility.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.FormatUtility + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.FormatUtility

    +

    Uses of Class
    com.nuix.superutilities.misc.FormatUtility

    -
    +
    + -
  • +
  • +
    -

    Uses of FormatUtility in com.nuix.superutilities.misc

    - - +

    Uses of FormatUtility in com.nuix.superutilities.misc

    +
    +
    Methods in com.nuix.superutilities.misc that return FormatUtility 
    + + - + + + - - + + +
    Methods in com.nuix.superutilities.misc that return FormatUtility 
    Modifier and TypeMethod and DescriptionMethodDescription
    static FormatUtilityFormatUtility.getInstance() static FormatUtilityFormatUtility.getInstance() 
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitor.html b/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitor.html index c86ce97..e4ab20d 100644 --- a/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitor.html +++ b/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitor.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.FreeSpaceMonitor + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.FreeSpaceMonitor

    +

    Uses of Class
    com.nuix.superutilities.misc.FreeSpaceMonitor

    -
    +
    + -
  • +
  • +
    -

    Uses of FreeSpaceMonitor in com.nuix.superutilities.misc

    - - +

    Uses of FreeSpaceMonitor in com.nuix.superutilities.misc

    +
    +
    Methods in com.nuix.superutilities.misc with parameters of type FreeSpaceMonitor 
    + + - + + + - + +
    Methods in com.nuix.superutilities.misc with parameters of type FreeSpaceMonitor 
    Modifier and TypeMethod and DescriptionMethodDescription
    voidFreeSpaceMonitorEventCallback.monitorEventOccurred(FreeSpaceMonitor monitor, - DriveSpaceInfo driveInfo) FreeSpaceMonitorEventCallback.monitorEventOccurred​(FreeSpaceMonitor monitor, +DriveSpaceInfo driveInfo) 
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitorEventCallback.html b/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitorEventCallback.html index 46af123..39a3890 100644 --- a/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitorEventCallback.html +++ b/docs/com/nuix/superutilities/misc/class-use/FreeSpaceMonitorEventCallback.html @@ -1,38 +1,44 @@ - + Uses of Interface com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback

    +

    Uses of Interface
    com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/FuzzyTermInfo.html b/docs/com/nuix/superutilities/misc/class-use/FuzzyTermInfo.html index 527e2b1..e369a7a 100644 --- a/docs/com/nuix/superutilities/misc/class-use/FuzzyTermInfo.html +++ b/docs/com/nuix/superutilities/misc/class-use/FuzzyTermInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.FuzzyTermInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.FuzzyTermInfo

    +

    Uses of Class
    com.nuix.superutilities.misc.FuzzyTermInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/LevenshteinDistance.html b/docs/com/nuix/superutilities/misc/class-use/LevenshteinDistance.html index 20a2609..17ced5b 100644 --- a/docs/com/nuix/superutilities/misc/class-use/LevenshteinDistance.html +++ b/docs/com/nuix/superutilities/misc/class-use/LevenshteinDistance.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.LevenshteinDistance + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.LevenshteinDistance

    +

    Uses of Class
    com.nuix.superutilities.misc.LevenshteinDistance

    No usage of com.nuix.superutilities.misc.LevenshteinDistance
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/NamedStringList.html b/docs/com/nuix/superutilities/misc/class-use/NamedStringList.html index 737a2d7..eef86ec 100644 --- a/docs/com/nuix/superutilities/misc/class-use/NamedStringList.html +++ b/docs/com/nuix/superutilities/misc/class-use/NamedStringList.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.NamedStringList + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.NamedStringList

    +

    Uses of Class
    com.nuix.superutilities.misc.NamedStringList

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/NuixVersion.html b/docs/com/nuix/superutilities/misc/class-use/NuixVersion.html index 64531e6..71d116b 100644 --- a/docs/com/nuix/superutilities/misc/class-use/NuixVersion.html +++ b/docs/com/nuix/superutilities/misc/class-use/NuixVersion.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.NuixVersion + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.NuixVersion

    +

    Uses of Class
    com.nuix.superutilities.misc.NuixVersion

    -
    +
    + -
  • +
  • +
    -

    Uses of NuixVersion in com.nuix.superutilities.misc

    - - +

    Uses of NuixVersion in com.nuix.superutilities.misc

    +
    +
    Methods in com.nuix.superutilities.misc that return NuixVersion 
    + + - + + + - - + + - - + +
    Methods in com.nuix.superutilities.misc that return NuixVersion 
    Modifier and TypeMethod and DescriptionMethodDescription
    static NuixVersionNuixVersion.getCurrent() +static NuixVersionNuixVersion.getCurrent()
    Attempts to determine current Nuix version by inspecting Nuix packages.
    static NuixVersionNuixVersion.parse(java.lang.String versionString) +static NuixVersionNuixVersion.parse​(java.lang.String versionString)
    Parses a version string into a NuixVersion instance.
    - - + +
    +
    Methods in com.nuix.superutilities.misc with parameters of type NuixVersion 
    + + - + + + - + - + - + - + - +
    Methods in com.nuix.superutilities.misc with parameters of type NuixVersion 
    Modifier and TypeMethod and DescriptionMethodDescription
    intNuixVersion.compareTo(NuixVersion other) +NuixVersion.compareTo​(NuixVersion other)
    Provides comparison logic when comparing two instances.
    booleanNuixVersion.isAtLeast(NuixVersion other) +NuixVersion.isAtLeast​(NuixVersion other)
    Determines whether another instance's version is greater than or equal to this instance
    booleanNuixVersion.isEqualTo(NuixVersion other) +NuixVersion.isEqualTo​(NuixVersion other)
    Determines whether another instance's version is equal to this instance
    booleanNuixVersion.isGreaterThan(NuixVersion other) +NuixVersion.isGreaterThan​(NuixVersion other)
    Determines whether another instance's version is greater than this instance
    booleanNuixVersion.isLessThan(NuixVersion other) +NuixVersion.isLessThan​(NuixVersion other)
    Determines whether another instance's version is less than this instance
    +
    • + - - + + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/PdfUtility.html b/docs/com/nuix/superutilities/misc/class-use/PdfUtility.html index 3c0bee9..c94c067 100644 --- a/docs/com/nuix/superutilities/misc/class-use/PdfUtility.html +++ b/docs/com/nuix/superutilities/misc/class-use/PdfUtility.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.PdfUtility + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.PdfUtility

    +

    Uses of Class
    com.nuix.superutilities.misc.PdfUtility

    No usage of com.nuix.superutilities.misc.PdfUtility
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/PlaceholderResolver.html b/docs/com/nuix/superutilities/misc/class-use/PlaceholderResolver.html index 999d5e6..74baf98 100644 --- a/docs/com/nuix/superutilities/misc/class-use/PlaceholderResolver.html +++ b/docs/com/nuix/superutilities/misc/class-use/PlaceholderResolver.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.PlaceholderResolver + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.PlaceholderResolver

    +

    Uses of Class
    com.nuix.superutilities.misc.PlaceholderResolver

    No usage of com.nuix.superutilities.misc.PlaceholderResolver
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/ProfileDigester.html b/docs/com/nuix/superutilities/misc/class-use/ProfileDigester.html index c5b1620..fa3eaa3 100644 --- a/docs/com/nuix/superutilities/misc/class-use/ProfileDigester.html +++ b/docs/com/nuix/superutilities/misc/class-use/ProfileDigester.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.ProfileDigester + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.ProfileDigester

    +

    Uses of Class
    com.nuix.superutilities.misc.ProfileDigester

    No usage of com.nuix.superutilities.misc.ProfileDigester
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/SQLiteBacked.html b/docs/com/nuix/superutilities/misc/class-use/SQLiteBacked.html index c5a193f..19321b7 100644 --- a/docs/com/nuix/superutilities/misc/class-use/SQLiteBacked.html +++ b/docs/com/nuix/superutilities/misc/class-use/SQLiteBacked.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.SQLiteBacked + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.SQLiteBacked

    +

    Uses of Class
    com.nuix.superutilities.misc.SQLiteBacked

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/SimilarityCalculation.html b/docs/com/nuix/superutilities/misc/class-use/SimilarityCalculation.html index ba79839..3d7087e 100644 --- a/docs/com/nuix/superutilities/misc/class-use/SimilarityCalculation.html +++ b/docs/com/nuix/superutilities/misc/class-use/SimilarityCalculation.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.SimilarityCalculation + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.SimilarityCalculation

    +

    Uses of Class
    com.nuix.superutilities.misc.SimilarityCalculation

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/misc/class-use/TermExpander.html b/docs/com/nuix/superutilities/misc/class-use/TermExpander.html index 7698680..4e5cf53 100644 --- a/docs/com/nuix/superutilities/misc/class-use/TermExpander.html +++ b/docs/com/nuix/superutilities/misc/class-use/TermExpander.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.TermExpander + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.TermExpander

    +

    Uses of Class
    com.nuix.superutilities.misc.TermExpander

    No usage of com.nuix.superutilities.misc.TermExpander
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/class-use/ZipHelper.html b/docs/com/nuix/superutilities/misc/class-use/ZipHelper.html index 34d5f75..9b6f5cc 100644 --- a/docs/com/nuix/superutilities/misc/class-use/ZipHelper.html +++ b/docs/com/nuix/superutilities/misc/class-use/ZipHelper.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.misc.ZipHelper + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.misc.ZipHelper

    +

    Uses of Class
    com.nuix.superutilities.misc.ZipHelper

    No usage of com.nuix.superutilities.misc.ZipHelper
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/package-summary.html b/docs/com/nuix/superutilities/misc/package-summary.html index 5de2d97..6c46ab6 100644 --- a/docs/com/nuix/superutilities/misc/package-summary.html +++ b/docs/com/nuix/superutilities/misc/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.misc + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.misc

    +
  • - +
    +
    + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
    Class Summary 
    Class Description
    DigestListDigestList
    This class provides an in-memory representation of a Nuix binary digest list.
    DriveSpaceInfoDriveSpaceInfo
    Encapsulates drive space information to callback responding to events fired - by FreeSpaceMonitor.
    + by FreeSpaceMonitor.
    ExpandedTermInfoExpandedTermInfo -
    Encapsulates information about a term designated as a match result generated by TermExpander.
    +
    Encapsulates information about a term designated as a match result generated by TermExpander.
    FormatUtilityFormatUtility
    Class which offers methods for formatting values.
    FreeSpaceMonitorFreeSpaceMonitor
    Provides a way to monitor file system locations and act when available disk space drops below a specified threshold.
    FuzzyTermInfoFuzzyTermInfo
    Encapsulates information about a fuzzy term expression.
    LevenshteinDistanceLevenshteinDistance  
    NamedStringListNamedStringList  
    NuixVersionNuixVersion
    Assists in representing a Nuix version in object form to assist with comparing two versions.
    PdfUtilityPdfUtility
    A class containing some helper methods for PDFs.
    PlaceholderResolverPlaceholderResolver
    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.
    ProfileDigesterProfileDigester
    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.
    SQLiteBackedSQLiteBacked
    Provides a wrapper around a SQLite database.
    TermExpanderTermExpander  
    ZipHelperZipHelper  
    +
  • - +
    +
    + + - +
    Enum Summary 
    Enum Description
    SimilarityCalculationSimilarityCalculation -
    Used by TermExpander to determine how fuzzy similarity should be +
    Used by TermExpander to determine how fuzzy similarity should be calculated to expand a given fuzzy term into matched terms.
    +
    • + + + + + diff --git a/docs/com/nuix/superutilities/misc/package-tree.html b/docs/com/nuix/superutilities/misc/package-tree.html index e88ae79..f41eea1 100644 --- a/docs/com/nuix/superutilities/misc/package-tree.html +++ b/docs/com/nuix/superutilities/misc/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.misc Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.misc

    Package Hierarchies: @@ -76,55 +68,64 @@

    Hierarchy For Package com.nuix.superutilities.misc

    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

    +
    +

    Enum Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable)
    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/misc/package-use.html b/docs/com/nuix/superutilities/misc/package-use.html index 493de0f..07b0a78 100644 --- a/docs/com/nuix/superutilities/misc/package-use.html +++ b/docs/com/nuix/superutilities/misc/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.misc + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.misc

    -
    +
    +
    + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.misc used by com.nuix.superutilities.annotations 
    + + - + + + - +
    Classes in com.nuix.superutilities.misc used by com.nuix.superutilities.annotations 
    Class and DescriptionClassDescription
    SQLiteBacked +SQLiteBacked
    Provides a wrapper around a SQLite database.
    +
    • + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.misc used by com.nuix.superutilities.misc 
    + + - + + + - + - + - + - + - + - + - + + - + - +
    Classes in com.nuix.superutilities.misc used by com.nuix.superutilities.misc 
    Class and DescriptionClassDescription
    DriveSpaceInfo +DriveSpaceInfo
    Encapsulates drive space information to callback responding to events fired - by FreeSpaceMonitor.
    + by FreeSpaceMonitor.
    ExpandedTermInfo -
    Encapsulates information about a term designated as a match result generated by TermExpander.
    +    		ExpandedTermInfo +
    Encapsulates information about a term designated as a match result generated by TermExpander.
    FormatUtility +FormatUtility
    Class which offers methods for formatting values.
    FreeSpaceMonitor +FreeSpaceMonitor
    Provides a way to monitor file system locations and act when available disk space drops below a specified threshold.
    FreeSpaceMonitorEventCallback -
    Interface for callback for free space monitoring offered by FreeSpaceMonitor.
    +    		FreeSpaceMonitorEventCallback +
    Interface for callback for free space monitoring offered by FreeSpaceMonitor.
    FuzzyTermInfo +FuzzyTermInfo
    Encapsulates information about a fuzzy term expression.
    NamedStringList NamedStringList 
    NuixVersion +NuixVersion
    Assists in representing a Nuix version in object form to assist with comparing two versions.
    SimilarityCalculation -
    Used by TermExpander to determine how fuzzy similarity should be +
    		SimilarityCalculation +
    Used by TermExpander to determine how fuzzy similarity should be calculated to expand a given fuzzy term into matched terms.
    + +
    • + + + + + diff --git a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.html b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.html index a9b44a6..fd8ff1b 100644 --- a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.html +++ b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.html @@ -1,42 +1,48 @@ - + NamedEntityRedactionProgressCallback + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.namedentities
    -

    Interface NamedEntityRedactionProgressCallback

    +
    Package com.nuix.superutilities.namedentities
    +

    Interface NamedEntityRedactionProgressCallback

    -
    -
      -
    • +
      -
      public interface NamedEntityRedactionProgressCallback
      -
      Provides progress status callback functionality for NamedEntityUtility.
      +
      Provides progress status callback functionality for NamedEntityUtility.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    +
    + - - -
    -
    + +
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.html b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.html index 9e6c047..0301db2 100644 --- a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.html +++ b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.html @@ -1,42 +1,48 @@ - + NamedEntityRedactionResults + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.namedentities
    -

    Class NamedEntityRedactionResults

    +
    Package com.nuix.superutilities.namedentities
    +

    Class NamedEntityRedactionResults

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.namedentities.NamedEntityRedactionResults
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.namedentities.NamedEntityRedactionResults
      +
      +
      -
      public class NamedEntityRedactionResults
 extends java.lang.Object
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            NamedEntityRedactionResults

            -
            public NamedEntityRedactionResults()
            +
            +

            NamedEntityRedactionResults

            +
            public NamedEntityRedactionResults()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        - - - - - - - -
        • -

          tallyUpdatedProperty

          -
          public void tallyUpdatedProperty(java.lang.String propertyName)
          +
          +

          tallyUpdatedProperty

          +
          public void tallyUpdatedProperty​(java.lang.String propertyName)
          Records that a particular property was recorded and adds 1 to count of times that property was updated. Count of updated properties - can later be obtained by calling getUpdatedProperties(). If you are just looking for list of poperty names which were updated - you can call getUpdatedPropertyNames().
          + can later be obtained by calling getUpdatedProperties(). If you are just looking for list of poperty names which were updated + you can call getUpdatedPropertyNames().
    Parameters:
    propertyName - The property name to increment the tally for
    + - - - - -
    • -

      getUpdatedItemCount

      -
      public int getUpdatedItemCount()
      +
      +

      getUpdatedItemCount

      +
      public int getUpdatedItemCount()
      Gets the number of items which had at least one redaction recorded to a custom metadata field.
      Returns:
      The number of items which had at least one redaction recorded to a custom metadata field.
      +
      • -
    - - - -
    • -

      getUpdatedProperties

      -
      public java.util.Map<java.lang.String,java.lang.Integer> getUpdatedProperties()
      +
      +

      getUpdatedProperties

      +
      public java.util.Map<java.lang.String,​java.lang.Integer> getUpdatedProperties()
      Gets a map of properties by name and how many times each property had a redacted custom metadata field recorded for it.
      Returns:
      A map of properties by name and how many times each property had a redacted custom metadata field recorded for it.
      +
      • -
    - - - -
    • -

      getUpdatedPropertyNames

      -
      public java.util.Set<java.lang.String> getUpdatedPropertyNames()
      +
      +

      getUpdatedPropertyNames

      +
      public java.util.Set<java.lang.String> getUpdatedPropertyNames()
      Gets a listing of metadata properties that had a redacted custom metadat field recorded for them at least once.
      Returns:
      A listing of metadata properties that had a redacted custom metadat field recorded for them at least once.
      +
      • -
    - - - -
    • -

      getContentTextUpdatedCount

      -
      public int getContentTextUpdatedCount()
      +
      +

      getContentTextUpdatedCount

      +
      public int getContentTextUpdatedCount()
      Gets a count of items which had a redacted custom metadata field recorded for the item's content text.
      Returns:
      A count of items which had a redacted custom metadata field recorded for the item's content text.
      +
      • -
    - - - - - - - -
    • -

      toString

      -
      public java.lang.String toString()
      +
      +

      toString

      +
      public java.lang.String toString()
      Generates a string with a handy summary of the results represented by this instance.
      Overrides:
      toString in class java.lang.Object
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.html b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.html index 856c105..67df42a 100644 --- a/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.html +++ b/docs/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.html @@ -1,42 +1,48 @@ - + NamedEntityRedactionSettings + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.namedentities
    -

    Class NamedEntityRedactionSettings

    +
    Package com.nuix.superutilities.namedentities
    +

    Class NamedEntityRedactionSettings

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
        • -
      -
      • -
    -
    - -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            NamedEntityRedactionSettings

            -
            public NamedEntityRedactionSettings()
            +
            +

            NamedEntityRedactionSettings

            +
            public NamedEntityRedactionSettings()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          addAllBuiltInEntities

          -
          public void addAllBuiltInEntities()
          +
          +

          addAllBuiltInEntities

          +
          public void addAllBuiltInEntities()
          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
          +
          • -
        - - - -
        • -

          getEntityNames

          -
          public java.util.Set<java.lang.String> getEntityNames()
          +
          +

          getEntityNames

          +
          public java.util.Set<java.lang.String> getEntityNames()
          Gets the entity names currently associated with this instance
          Returns:
          The entity names currently associated with this instance
          +
          • -
        - - - -
        • -

          addEntityNames

          -
          public void addEntityNames(java.util.Collection<java.lang.String> entityNames)
          +
          +

          addEntityNames

          +
          public void addEntityNames​(java.util.Collection<java.lang.String> entityNames)
          Adds entity names to this instance.
          Parameters:
          entityNames - The entity names to add
          +
          • -
        - - - -
        • -

          clearEntityNames

          -
          public void clearEntityNames()
          +
          +

          clearEntityNames

          +
          public void clearEntityNames()
          Clears all entity names associated with this instance
          +
          • -
        - - - -
        • -

          getRedactProperties

          -
          public boolean getRedactProperties()
          +
          +

          getRedactProperties

          +
          public boolean getRedactProperties()
          Gets value determining whether metadata properties should be processed.
          Returns:
          True if metadata properties should be processed
          +
          • -
        - - - -
        • -

          setRedactProperties

          -
          public void setRedactProperties(boolean redactProperties)
          +
          +

          setRedactProperties

          +
          public void setRedactProperties​(boolean redactProperties)
          Sets value determining whether metadata properties should be processed
          Parameters:
          redactProperties - Whether metadata properties should be processed
          +
          • -
        - - - -
        • -

          getRedactContentText

          -
          public boolean getRedactContentText()
          +
          +

          getRedactContentText

          +
          public boolean getRedactContentText()
          Gets value determining whether item's content text should be processed
          Returns:
          True if item's content text should be processed
          +
          • -
        - - - -
        • -

          setRedactContentText

          -
          public void setRedactContentText(boolean redactContentText)
          +
          +

          setRedactContentText

          +
          public void setRedactContentText​(boolean redactContentText)
          Sets value determining whether items' content text should be processed
          Parameters:
          redactContentText - Whether items' content text should be processed
          +
          • -
        - - - -
        • -

          getOnlyRecordChanges

          -
          public boolean getOnlyRecordChanges()
          +
          +

          getOnlyRecordChanges

          +
          public boolean getOnlyRecordChanges()
          Gets value determining whether only values that have a redaction performed should be recorded.
          Returns:
          True when only updated fields are recorded, false when all fields are recorded
          +
          • -
        - - - -
        • -

          setOnlyRecordChanges

          -
          public void setOnlyRecordChanges(boolean onlyRecordChanges)
          +
          +

          setOnlyRecordChanges

          +
          public void setOnlyRecordChanges​(boolean onlyRecordChanges)
          Sets value determining whether only values that have a redaction performed should be recorded
          Parameters:
          onlyRecordChanges - True when only updated fields are recorded, false when all fields are recorded
          +
          • -
        - - - -
        • -

          getCustomMetadataFieldPrefix

          -
          public java.lang.String getCustomMetadataFieldPrefix()
          +
          +

          getCustomMetadataFieldPrefix

          +
          public java.lang.String getCustomMetadataFieldPrefix()
          Gets the prefix applied to custom metadata fields names. Custom metadata field names are source property field name prepended with this prefix or "ContentText" (for item content text) prepended with this prefix.
          Returns:
          The prefix which will be appended to custom metadata field names. Can be an empty string.
          +
          • -
        - - - -
        • -

          setCustomMetadataFieldPrefix

          -
          public void setCustomMetadataFieldPrefix(java.lang.String customMetadataFieldPrefix)
          +
          +

          setCustomMetadataFieldPrefix

          +
          public void setCustomMetadataFieldPrefix​(java.lang.String customMetadataFieldPrefix)
          Sets the prefix applied to custom metadata fields names. Custom metadata field names are source property field name prepended with this prefix or "ContentText" (for item content text) prepended with this prefix.
          Parameters:
          customMetadataFieldPrefix - The prefix applied to custom metadata fields names
          +
          • -
        - - - -
        • -

          getRedactionReplacementTemplate

          -
          public java.lang.String getRedactionReplacementTemplate()
          +
          +

          getRedactionReplacementTemplate

          +
          public java.lang.String getRedactionReplacementTemplate()
          Gets the template string used to generate the replacement text put in place of a redaction in the text.
          Returns:
          The template string used to generate replacement text put in place of a redaction in the text
          +
          • -
        - - - -
        • -

          setRedactionReplacementTemplate

          -
          public void setRedactionReplacementTemplate(java.lang.String redactionReplacementTemplate)
          +
          +

          setRedactionReplacementTemplate

          +
          public void setRedactionReplacementTemplate​(java.lang.String redactionReplacementTemplate)
          Sets the template string used to generate replacement text put in place of a redaction in the text. The placeholder {entity_name} will be replaced at run-time with the name of the entity if present in the template.
          Parameters:
          redactionReplacementTemplate - The template string used to generate replacement text put in place of a redaction in the text
          +
          • -
        - - - -
    Returns:
    True if time stamp will be written to updated items
    + - - - - -
    • -

      setRecordTimeOfRedaction

      -
      public void setRecordTimeOfRedaction(boolean recordTimeOfRedaction)
      +
      +

      setRecordTimeOfRedaction

      +
      public void setRecordTimeOfRedaction​(boolean recordTimeOfRedaction)
      Sets whether a custom metadata field will be written to updated items with a time stamp of when the redaction was performed. - The name of the custom metadata field used can be set using setTimeOfRedactionFieldName(String).
      + The name of the custom metadata field used can be set using setTimeOfRedactionFieldName(String).
      Parameters:
      recordTimeOfRedaction - True to record when the redaction was performed
      +
      • -
    - - - -
    • -

      getTimeOfRedactionFieldName

      -
      public java.lang.String getTimeOfRedactionFieldName()
      -
      Gets the name of the custom metadata field used to record redaction time stamp when getRecordTimeOfRedaction() returns true.
      +
      +

      getTimeOfRedactionFieldName

      +
      public java.lang.String getTimeOfRedactionFieldName()
      +
      Gets the name of the custom metadata field used to record redaction time stamp when getRecordTimeOfRedaction() returns true.
      Returns:
      The name of the custom metadata field used to record redaction time stamp
      +
      • -
    - - - -
    • -

      setTimeOfRedactionFieldName

      -
      public void setTimeOfRedactionFieldName(java.lang.String timeOfRedactionFieldName)
      -
      Sets the name of the custom metadata field used to record redaction time stamp when getRecordTimeOfRedaction() returns true.
      +
      +

      setTimeOfRedactionFieldName

      +
      public void setTimeOfRedactionFieldName​(java.lang.String timeOfRedactionFieldName)
      +
      Sets the name of the custom metadata field used to record redaction time stamp when getRecordTimeOfRedaction() returns true.
      Parameters:
      timeOfRedactionFieldName - The name of the custom metadata field used to record redaction time stamp
      +
      • -
    - - - -
    • -

      getSpecificProperties

      -
      public java.util.Set<java.lang.String> getSpecificProperties()
      +
      +

      getSpecificProperties

      +
      public java.util.Set<java.lang.String> getSpecificProperties()
      Gets list of specific metadata property names to be scanned. If null or has no entries, all metadata properties are scanned. If this contains a list of metadata property names, only those metadata properties will be scanned.
      Returns:
      Set of specific metadata properties to be scanned or a null or empty collection if all properties are to be scanned.
      +
      • -
    - - - -
    • -

      setSpecificProperties

      -
      public void setSpecificProperties(java.util.Collection<java.lang.String> specificProperties)
      +
      +

      setSpecificProperties

      +
      public void setSpecificProperties​(java.util.Collection<java.lang.String> specificProperties)
      Sets list of specific metadata property names to be scanned. If null or has no entries, all metadata properties are scanned. If this contains a list of metadata property names, only those metadata properties will be scanned.
      Parameters:
      specificProperties - Set of specific metadata properties to be scanned or a null or empty collection means all properties are to be scanned.
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/namedentities/NamedEntityUtility.html b/docs/com/nuix/superutilities/namedentities/NamedEntityUtility.html index 7336de0..e1a2d7b 100644 --- a/docs/com/nuix/superutilities/namedentities/NamedEntityUtility.html +++ b/docs/com/nuix/superutilities/namedentities/NamedEntityUtility.html @@ -1,42 +1,48 @@ - + NamedEntityUtility + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.namedentities
    -

    Class NamedEntityUtility

    +
    Package com.nuix.superutilities.namedentities
    +

    Class NamedEntityUtility

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.namedentities.NamedEntityUtility
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.namedentities.NamedEntityUtility
      +
      +
      -
      public class NamedEntityUtility
 extends java.lang.Object
      Provides functionality for working with Nuix named entities.
      @@ -115,185 +99,194 @@

      Class NamedEntityUtility

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
    Parameters:
    items - The items to process
    @@ -324,21 +314,18 @@

    recordRedactedCopies

    Returns:
    Results object which contains some information about how things went. Is a combination of the results generated for each individual item.
    + - - - - - - - - - - - - -
    • -

      saveRedactionProfile

      -
      public static void saveRedactionProfile(java.io.File destination,
-                                        NamedEntityRedactionResults redactionResults,
-                                        NamedEntityRedactionSettings settings)
-                                 throws java.lang.Exception
      +
      +

      saveRedactionProfile

      +
      public static void saveRedactionProfile​(java.io.File destination, +NamedEntityRedactionResults redactionResults, +NamedEntityRedactionSettings settings) + throws java.lang.Exception
      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.
      @@ -398,18 +379,15 @@

      saveRedactionProfile

      Throws:
      java.lang.Exception - Thrown if something goes wrong unexpectedly.
      +
      • -
    - - - -
    • -

      saveRedactionProfile

      -
      public static void saveRedactionProfile(java.lang.String destination,
-                                        NamedEntityRedactionResults redactionResults,
-                                        NamedEntityRedactionSettings settings)
-                                 throws java.lang.Exception
      +
      +

      saveRedactionProfile

      +
      public static void saveRedactionProfile​(java.lang.String destination, +NamedEntityRedactionResults redactionResults, +NamedEntityRedactionSettings settings) + throws java.lang.Exception
      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.
      @@ -420,25 +398,28 @@

      saveRedactionProfile

      Throws:
      java.lang.Exception - Thrown if something goes wrong unexpectedly.
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionProgressCallback.html b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionProgressCallback.html index 119f358..09c6673 100644 --- a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionProgressCallback.html +++ b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionProgressCallback.html @@ -1,38 +1,44 @@ - + Uses of Interface com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback

    +

    Uses of Interface
    com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionResults.html b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionResults.html index 67f2f80..5d10a0b 100644 --- a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionResults.html +++ b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionResults.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.namedentities.NamedEntityRedactionResults + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityRedactionResults

    +

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityRedactionResults

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionSettings.html b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionSettings.html index d0caa30..aadea20 100644 --- a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionSettings.html +++ b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityRedactionSettings.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityRedactionSettings

    +

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityRedactionSettings

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityUtility.html b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityUtility.html index 973516e..dfccd90 100644 --- a/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityUtility.html +++ b/docs/com/nuix/superutilities/namedentities/class-use/NamedEntityUtility.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.namedentities.NamedEntityUtility + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityUtility

    +

    Uses of Class
    com.nuix.superutilities.namedentities.NamedEntityUtility

    No usage of com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/namedentities/package-summary.html b/docs/com/nuix/superutilities/namedentities/package-summary.html index f7ea2ab..47db53e 100644 --- a/docs/com/nuix/superutilities/namedentities/package-summary.html +++ b/docs/com/nuix/superutilities/namedentities/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.namedentities + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.namedentities

    +
  • - +
    +
    + + - + - + - +
    Class Summary 
    Class Description
    NamedEntityRedactionResultsNamedEntityRedactionResults  
    NamedEntityRedactionSettingsNamedEntityRedactionSettings -
    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).
    +
    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).
    NamedEntityUtilityNamedEntityUtility
    Provides functionality for working with Nuix named entities.
    +
    • +
    + + + + diff --git a/docs/com/nuix/superutilities/namedentities/package-tree.html b/docs/com/nuix/superutilities/namedentities/package-tree.html index 3028153..fab59ce 100644 --- a/docs/com/nuix/superutilities/namedentities/package-tree.html +++ b/docs/com/nuix/superutilities/namedentities/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.namedentities Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.namedentities

    Package Hierarchies: @@ -76,31 +68,38 @@

    Hierarchy For Package com.nuix.superutilities.namedentities

    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/namedentities/package-use.html b/docs/com/nuix/superutilities/namedentities/package-use.html index 5c3c11a..e578aef 100644 --- a/docs/com/nuix/superutilities/namedentities/package-use.html +++ b/docs/com/nuix/superutilities/namedentities/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.namedentities + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.namedentities

    -
    +
    +
    + +
    + + + + diff --git a/docs/com/nuix/superutilities/package-summary.html b/docs/com/nuix/superutilities/package-summary.html index e3a93cd..944daf1 100644 --- a/docs/com/nuix/superutilities/package-summary.html +++ b/docs/com/nuix/superutilities/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities

    +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/package-tree.html b/docs/com/nuix/superutilities/package-tree.html index c186db1..9b4c3a3 100644 --- a/docs/com/nuix/superutilities/package-tree.html +++ b/docs/com/nuix/superutilities/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities

    Package Hierarchies: @@ -76,25 +68,30 @@

    Hierarchy For Package com.nuix.superutilities

    +

    Class Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/package-use.html b/docs/com/nuix/superutilities/package-use.html index a2a8c8d..49302c1 100644 --- a/docs/com/nuix/superutilities/package-use.html +++ b/docs/com/nuix/superutilities/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities

    -
    +
    +
    + +
    + + + + diff --git a/docs/com/nuix/superutilities/query/QueryHelper.html b/docs/com/nuix/superutilities/query/QueryHelper.html index decfab0..b9ccbb2 100644 --- a/docs/com/nuix/superutilities/query/QueryHelper.html +++ b/docs/com/nuix/superutilities/query/QueryHelper.html @@ -1,42 +1,48 @@ - + QueryHelper + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.query
    -

    Class QueryHelper

    +
    Package com.nuix.superutilities.query
    +

    Class QueryHelper

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.query.QueryHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.query.QueryHelper
      +
      +
      -
      public class QueryHelper
 extends java.lang.Object
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        QueryHelper() QueryHelper() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + + - + - + - + - + - + - + + - + - + - + + + + + + - + - + - + + - + - + + - + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static java.lang.StringescapeForSearch(java.lang.String value) escapeForSearch​(java.lang.String value) 
      static java.lang.StringjoinByAnd(java.util.Collection<java.lang.String> expressions) +joinByAnd​(java.util.Collection<java.lang.String> expressions)
      Joins a series of expressions by " AND ", so expressions "cat", "dog" would become "cat AND dog".
      static java.lang.StringjoinByOr(java.util.Collection<java.lang.String> expressions) +joinByOr​(java.util.Collection<java.lang.String> expressions)
      Joins a series of expressions by " OR ", so expressions "cat", "dog" would become "cat OR dog".
      static java.lang.StringmarkupSetQuery(nuix.MarkupSet markupSet) markupSetQuery​(nuix.MarkupSet markupSet) 
      static java.lang.StringnamedEntityQuery(java.util.Collection<java.lang.String> entityNames) +namedEntityQuery​(java.util.Collection<java.lang.String> entityNames)
      Generates a query to find items which have a match for any of the provided named entities.
      static java.lang.StringnotJoinByAnd​(java.util.Collection<java.lang.String> expressions) +
      Returns a query in the form: NOT (a AND b AND c) with a,b and c being expressions provided.
      +
      static java.lang.StringnotJoinByOr(java.util.Collection<java.lang.String> expressions) +notJoinByOr​(java.util.Collection<java.lang.String> expressions)
      Returns a query in the form: NOT (a OR b OR c) with a,b and c being expressions provided.
      static java.lang.StringorTagQuery(java.util.Collection<java.lang.String> tags) orTagQuery​(java.lang.String... tags) 
      static java.lang.StringorTagQuery(java.lang.String... tags) orTagQuery​(java.util.Collection<java.lang.String> tags) 
      static java.lang.StringparenThenJoinByAnd(java.util.Collection<java.lang.String> expressions) +parenThenJoinByAnd​(java.util.Collection<java.lang.String> expressions)
      Joins a series of expressions by " AND " after wrapping each expression in parentheses.
      static java.lang.StringparenThenJoinByOr(java.util.Collection<java.lang.String> expressions) +parenThenJoinByOr​(java.util.Collection<java.lang.String> expressions)
      Joins a series of expressions by " OR " after wrapping each expression in parentheses.
      static java.lang.StringyearMonthRangeQuery(int year, - int month) +yearMonthRangeQuery​(int year, +int month)
      Builds an item-date range query for items with a date occurring within the specified year and month.
      static java.lang.StringyearRangeQuery(int year) +yearRangeQuery​(int year)
      Builds an item-date Nuix range query for items with a date occurring within the specified year.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            QueryHelper

            -
            public QueryHelper()
            +
            +

            QueryHelper

            +
            public QueryHelper()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          yearRangeQuery

          -
          public static java.lang.String yearRangeQuery(int year)
          +
          +

          yearRangeQuery

          +
          public static java.lang.String yearRangeQuery​(int year)
          Builds an item-date Nuix range query for items with a date occurring within the specified year.
          Parameters:
          @@ -263,16 +273,13 @@

          yearRangeQuery

          Returns:
          A Nuix range query for item dates that occurred within the given year, i.e. item-date:[20190101 TO 20191231]
          +
          • -
        - - - -
        • -

          yearMonthRangeQuery

          -
          public static java.lang.String yearMonthRangeQuery(int year,
-                                                   int month)
          +
          +

          yearMonthRangeQuery

          +
          public static java.lang.String yearMonthRangeQuery​(int year, +int month)
          Builds an item-date range query for items with a date occurring within the specified year and month. For example a year input of 2019 and month input of 6 should yield the query: item-date:[20190601 TO 20190630]
          @@ -282,15 +289,12 @@

          yearMonthRangeQuery

          Returns:
          A Nuix range query for items with an item date in the specified year and month
          +
          • -
        - - - -
        • -

          joinByAnd

          -
          public static java.lang.String joinByAnd(java.util.Collection<java.lang.String> expressions)
          +
          +

          joinByAnd

          +
          public static java.lang.String joinByAnd​(java.util.Collection<java.lang.String> expressions)
          Joins a series of expressions by " AND ", so expressions "cat", "dog" would become "cat AND dog". Nil/null values and values containing only whitespace characters in the provided expressions collection are ignored.
          @@ -299,15 +303,12 @@

          joinByAnd

          Returns:
          The expressions AND'ed together.
          +
          • -
        - - - -
        • -

          parenThenJoinByAnd

          -
          public static java.lang.String parenThenJoinByAnd(java.util.Collection<java.lang.String> expressions)
          +
          +

          parenThenJoinByAnd

          +
          public static java.lang.String parenThenJoinByAnd​(java.util.Collection<java.lang.String> expressions)
          Joins a series of expressions by " AND " after wrapping each expression in parentheses. So expressions "cat", "dog" would become "(cat) AND (dog)". Nil/null values and values containing only whitespace characters in the provided expressions collection are ignored.
          @@ -317,15 +318,12 @@

          parenThenJoinByAnd

          Returns:
          The expressions surrounded by parentheses and AND'ed together.
          +
          • -
        - - - -
        • -

          joinByOr

          -
          public static java.lang.String joinByOr(java.util.Collection<java.lang.String> expressions)
          +
          +

          joinByOr

          +
          public static java.lang.String joinByOr​(java.util.Collection<java.lang.String> expressions)
          Joins a series of expressions by " OR ", so expressions "cat", "dog" would become "cat OR dog". Nil/null values and values containing only whitespace characters in the provided expressions collection are ignored.
          @@ -334,15 +332,12 @@

          joinByOr

          Returns:
          The expressions OR'ed together.
          +
          • -
        - - - -
        • -

          parenThenJoinByOr

          -
          public static java.lang.String parenThenJoinByOr(java.util.Collection<java.lang.String> expressions)
          +
          +

          parenThenJoinByOr

          +
          public static java.lang.String parenThenJoinByOr​(java.util.Collection<java.lang.String> expressions)
          Joins a series of expressions by " OR " after wrapping each expression in parentheses. So expressions "cat", "dog" would become "(cat) OR (dog)". Nil/null values and values containing only whitespace characters in the provided expressions collection are ignored.
          @@ -352,15 +347,12 @@

          parenThenJoinByOr

          Returns:
          The expressions surrounded by parentheses and OR'ed together.
          +
          • -
        - - - -
        • -

          notJoinByOr

          -
          public static java.lang.String notJoinByOr(java.util.Collection<java.lang.String> expressions)
          +
          +

          notJoinByOr

          +
          public static java.lang.String notJoinByOr​(java.util.Collection<java.lang.String> expressions)
          Returns a query in the form: NOT (a OR b OR c) with a,b and c being expressions provided.
          Parameters:
          @@ -368,15 +360,25 @@

          notJoinByOr

          Returns:
          A query in the form: NOT (a OR b OR c)
          +
          • -
        - - - -
        • -

          namedEntityQuery

          -
          public static java.lang.String namedEntityQuery(java.util.Collection<java.lang.String> entityNames)
          +
          +

          notJoinByAnd

          +
          public static java.lang.String notJoinByAnd​(java.util.Collection<java.lang.String> expressions)
          +
          Returns a query in the form: NOT (a AND b AND c) with a,b and c being expressions provided.
          +
          +
          Parameters:
          +
          expressions - Expressions to be AND'ed and then NOT'ed.
          +
          Returns:
          +
          A query in the form: NOT (a AND b AND c)
          +
          +
          +
          • +
        • +
          +

          namedEntityQuery

          +
          public static java.lang.String namedEntityQuery​(java.util.Collection<java.lang.String> entityNames)
          Generates a query to find items which have a match for any of the provided named entities.
          Parameters:
          @@ -384,61 +386,52 @@

          namedEntityQuery

          Returns:
          A query for items having matches for any of the specified named entities such as: named-entities:( company;* OR country;* OR credit-card-num;*)
          +
          • -
        - - - -
        • -

          markupSetQuery

          -
          public static java.lang.String markupSetQuery(nuix.MarkupSet markupSet)
          +
          +

          markupSetQuery

          +
          public static java.lang.String markupSetQuery​(nuix.MarkupSet markupSet)
          +
          • -
        - - - -
        • -

          escapeForSearch

          -
          public static java.lang.String escapeForSearch(java.lang.String value)
          +
          +

          escapeForSearch

          +
          public static java.lang.String escapeForSearch​(java.lang.String value)
          +
          • -
        - - - -
        • -

          orTagQuery

          -
          public static java.lang.String orTagQuery(java.util.Collection<java.lang.String> tags)
          +
          +

          orTagQuery

          +
          public static java.lang.String orTagQuery​(java.util.Collection<java.lang.String> tags)
          +
          • -
        - - - -
        • -

          orTagQuery

          -
          public static java.lang.String orTagQuery(java.lang.String... tags)
          -
          • -
        +
        +

        orTagQuery

        +
        public static java.lang.String orTagQuery​(java.lang.String... tags)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/query/class-use/QueryHelper.html b/docs/com/nuix/superutilities/query/class-use/QueryHelper.html index a9eef79..e2b01f7 100644 --- a/docs/com/nuix/superutilities/query/class-use/QueryHelper.html +++ b/docs/com/nuix/superutilities/query/class-use/QueryHelper.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.query.QueryHelper + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.query.QueryHelper

    +

    Uses of Class
    com.nuix.superutilities.query.QueryHelper

    No usage of com.nuix.superutilities.query.QueryHelper
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/query/package-summary.html b/docs/com/nuix/superutilities/query/package-summary.html index 17133df..1a40fda 100644 --- a/docs/com/nuix/superutilities/query/package-summary.html +++ b/docs/com/nuix/superutilities/query/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.query + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.query

    +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/query/package-tree.html b/docs/com/nuix/superutilities/query/package-tree.html index 4151710..c18463c 100644 --- a/docs/com/nuix/superutilities/query/package-tree.html +++ b/docs/com/nuix/superutilities/query/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.query Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.query

    Package Hierarchies: @@ -76,25 +68,30 @@

    Hierarchy For Package com.nuix.superutilities.query

    +

    Class Hierarchy

      -
    • java.lang.Object +
    • java.lang.Object
    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/query/package-use.html b/docs/com/nuix/superutilities/query/package-use.html index c68eb2a..a8f56de 100644 --- a/docs/com/nuix/superutilities/query/package-use.html +++ b/docs/com/nuix/superutilities/query/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.query + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.query

    No usage of com.nuix.superutilities.query
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/regex/ItemRegexMatchCollection.html b/docs/com/nuix/superutilities/regex/ItemRegexMatchCollection.html index f0964f3..9c9c1a9 100644 --- a/docs/com/nuix/superutilities/regex/ItemRegexMatchCollection.html +++ b/docs/com/nuix/superutilities/regex/ItemRegexMatchCollection.html @@ -1,42 +1,48 @@ - + ItemRegexMatchCollection + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.regex
    -

    Class ItemRegexMatchCollection

    +
    Package com.nuix.superutilities.regex
    +

    Class ItemRegexMatchCollection

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.regex.ItemRegexMatchCollection
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.regex.ItemRegexMatchCollection
      +
      +
      -
      public class ItemRegexMatchCollection
 extends java.lang.Object
      Represents an item and the associated regular expression matches made against it.
      @@ -115,136 +99,149 @@

      Class ItemRegexMatchCol
      Author:
      Jason Wells
      -

      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        ItemRegexMatchCollection(nuix.Item item) +ItemRegexMatchCollection​(nuix.Item item)
        Creates a new empty instance against the specified item.
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ItemRegexMatchCollection

            -
            public ItemRegexMatchCollection(nuix.Item item)
            +
            +

            ItemRegexMatchCollection

            +
            public ItemRegexMatchCollection​(nuix.Item item)
            Creates a new empty instance against the specified item.
            Parameters:
            item - The item to associated.
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getItem

          -
          public nuix.Item getItem(nuix.Case nuixCase)
          +
          +

          getItem

          +
          public nuix.Item getItem​(nuix.Case nuixCase)
          Gets the associated item.
          Parameters:
          @@ -252,63 +249,51 @@

          getItem

          Returns:
          The associated item.
          +
          • -
        - - - -
        • -

          getMatches

          -
          public java.util.List<RegexMatch> getMatches()
          +
          +

          getMatches

          +
          public java.util.List<RegexMatch> getMatches()
          Gets the matches associated.
          Returns:
          The matches associated.
          +
          • -
        - - - -
        • -

          getContentMatches

          -
          public java.util.List<RegexMatch> getContentMatches()
          +
          +

          getContentMatches

          +
          public java.util.List<RegexMatch> getContentMatches()
          Get the matches associated specifically to the item's content text.
          Returns:
          The matches associated specifically to the item's content text.
          +
          • -
        - - - -
        • -

          getPropertyMatches

          -
          public java.util.List<RegexMatch> getPropertyMatches()
          +
          +

          getPropertyMatches

          +
          public java.util.List<RegexMatch> getPropertyMatches()
          Gets the matches associated specifically to the item's property text.
          Returns:
          The matches associated specifically to the item's property text.
          +
          • -
        - - - -
        • -

          addMatch

          -
          public void addMatch(PatternInfo patternInfo,
-                     java.lang.String location,
-                     boolean isContentMatch,
-                     java.lang.String value,
-                     java.lang.String valueContext,
-                     int matchStart,
-                     int matchEnd)
          +
          +

          addMatch

          +
          public void addMatch​(PatternInfo patternInfo, +java.lang.String location, +boolean isContentMatch, +java.lang.String value, +java.lang.String valueContext, +int matchStart, +int matchEnd)
          Adds a match to this instance.
          Parameters:
          @@ -320,39 +305,39 @@

          addMatch

          matchStart - Offset in source text where this match begins
          matchEnd - Offset in source text where this match ends
          +
          • -
        - - - -
        • -

          getMatchCount

          -
          public int getMatchCount()
          +
          +

          getMatchCount

          +
          public int getMatchCount()
          Gets the number of matches currently associated with this instance.
          Returns:
          The number of matches associated with this instance.
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/regex/PatternInfo.html b/docs/com/nuix/superutilities/regex/PatternInfo.html index c43243e..1d7342b 100644 --- a/docs/com/nuix/superutilities/regex/PatternInfo.html +++ b/docs/com/nuix/superutilities/regex/PatternInfo.html @@ -1,42 +1,48 @@ - + PatternInfo + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.regex
    -

    Class PatternInfo

    +
    Package com.nuix.superutilities.regex
    +

    Class PatternInfo

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.regex.PatternInfo
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.regex.PatternInfo
      +
      +
      -
      public class PatternInfo
 extends java.lang.Object
      Represents a regular expression including associated title.
      @@ -115,187 +99,198 @@

      Class PatternInfo

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        PatternInfo(java.lang.String title, - java.lang.String expression) +PatternInfo​(java.lang.String title, +java.lang.String expression)
        Create a new instance
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidcompile(boolean caseSensitive) +compile​(boolean caseSensitive, +boolean multiline, +boolean dotAll)
      Compiles the regular expression String provided into a Java Pattern object
      java.lang.StringgetExpression() +getExpression()
      Gets the Java regular expression string associated with this instance
      java.util.regex.PatterngetPattern() +getPattern()
      Gets the compiled Pattern object.
      java.lang.StringgetTitle() +getTitle()
      Gets the title associated with this instance
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            PatternInfo

            -
            public PatternInfo(java.lang.String title,
-                   java.lang.String expression)
            +
            +

            PatternInfo

            +
            public PatternInfo​(java.lang.String title, +java.lang.String expression)
            Create a new instance
            Parameters:
            title - The associated title of this pattern
            expression - The Java regular expression
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          compile

          -
          public void compile(boolean caseSensitive)
          +
          +

          compile

          +
          public void compile​(boolean caseSensitive, +boolean multiline, +boolean dotAll)
          Compiles the regular expression String provided into a Java Pattern object
          Parameters:
          caseSensitive - Whether it should be case sensitive
          +
          multiline - Whether the multi-line matching flag should be set
          +
          dotAll - Whether the dot matches all flag should be set
          +
          • -
        - - - -
        • -

          getTitle

          -
          public java.lang.String getTitle()
          +
          +

          getTitle

          +
          public java.lang.String getTitle()
          Gets the title associated with this instance
          Returns:
          The associated title
          +
          • -
        - - - -
        • -

          getExpression

          -
          public java.lang.String getExpression()
          +
          +

          getExpression

          +
          public java.lang.String getExpression()
          Gets the Java regular expression string associated with this instance
          Returns:
          The Java regular expression string
          +
          • -
        - - - - +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/regex/RegexMatch.html b/docs/com/nuix/superutilities/regex/RegexMatch.html index 4514b46..2f63e78 100644 --- a/docs/com/nuix/superutilities/regex/RegexMatch.html +++ b/docs/com/nuix/superutilities/regex/RegexMatch.html @@ -1,42 +1,48 @@ - + RegexMatch + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.regex
    -

    Class RegexMatch

    +
    Package com.nuix.superutilities.regex
    +

    Class RegexMatch

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.regex.RegexMatch
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.regex.RegexMatch
      +
      +
      -
      public class RegexMatch
 extends java.lang.Object
      Represents information about a regular expression match.
      @@ -115,132 +99,148 @@

      Class RegexMatch

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        RegexMatch(PatternInfo patternInfo, - java.lang.String location, - boolean isContentMatch, - java.lang.String value, - java.lang.String valueContext, - int matchStart, - int matchEnd) +RegexMatch​(PatternInfo patternInfo, +java.lang.String location, +boolean isContentMatch, +java.lang.String value, +java.lang.String valueContext, +int matchStart, +int matchEnd)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            RegexMatch

            -
            public RegexMatch(PatternInfo patternInfo,
-                  java.lang.String location,
-                  boolean isContentMatch,
-                  java.lang.String value,
-                  java.lang.String valueContext,
-                  int matchStart,
-                  int matchEnd)
            +
            +

            RegexMatch

            +
            public RegexMatch​(PatternInfo patternInfo, +java.lang.String location, +boolean isContentMatch, +java.lang.String value, +java.lang.String valueContext, +int matchStart, +int matchEnd)
            Creates a new instance
            Parameters:
            @@ -252,145 +252,126 @@

            RegexMatch

            matchStart - Offset in source text where match starts
            matchEnd - Offset in source text where match ends
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getExpression

          -
          public java.lang.String getExpression()
          -
          Convenience method for obtaining the regular expression string from the associated PatternInfo object.
          +
          +

          getExpression

          +
          public java.lang.String getExpression()
          +
          Convenience method for obtaining the regular expression string from the associated PatternInfo object.
          Returns:
          -
          The regular expression string from the associated PatternInfo object
          +
          The regular expression string from the associated PatternInfo object
          +
          • -
        - - - - - - - -
        • -

          getLocation

          -
          public java.lang.String getLocation()
          +
          +

          getLocation

          +
          public java.lang.String getLocation()
          Gets the location of match such as content or metdata property name.
          Returns:
          The location of match such as content or metdata property name
          +
          • -
        - - - -
        • -

          isContentMatch

          -
          public boolean isContentMatch()
          +
          +

          isContentMatch

          +
          public boolean isContentMatch()
          Gets whether this match was made in the content text of an item.
          Returns:
          True if this match was made in the content text of an item.
          +
          • -
        - - - -
        • -

          getValue

          -
          public java.lang.String getValue()
          +
          +

          getValue

          +
          public java.lang.String getValue()
          Gets the matched value
          Returns:
          The matched value
          +
          • -
        - - - -
        • -

          getMatchStart

          -
          public long getMatchStart()
          +
          +

          getMatchStart

          +
          public long getMatchStart()
          Gets the offset in source text where match starts
          Returns:
          The offset in source text where match starts
          +
          • -
        - - - -
        • -

          getMatchEnd

          -
          public long getMatchEnd()
          +
          +

          getMatchEnd

          +
          public long getMatchEnd()
          Gets the offset in source text where match ends
          Returns:
          The offset in source text where match ends
          +
          • -
        - - - -
        • -

          getValueContext

          -
          public java.lang.String getValueContext()
          +
          +

          getValueContext

          +
          public java.lang.String getValueContext()
          Gets contextual string of match if one was provided
          Returns:
          The context string of match if one was provided
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/regex/RegexScanError.html b/docs/com/nuix/superutilities/regex/RegexScanError.html index 7fbed6a..c9442a2 100644 --- a/docs/com/nuix/superutilities/regex/RegexScanError.html +++ b/docs/com/nuix/superutilities/regex/RegexScanError.html @@ -1,42 +1,48 @@ - + RegexScanError + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.regex
    -

    Class RegexScanError

    +
    Package com.nuix.superutilities.regex
    +

    Class RegexScanError

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.regex.RegexScanError
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.regex.RegexScanError
      +
      +
      -
      public class RegexScanError
 extends java.lang.Object
      -
      Represents information about an error which occurred in RegexScanner while scanning.
      +
      Represents information about an error which occurred in RegexScanner while scanning.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        RegexScanError(nuix.Item item, - PatternInfo patternInfo, - java.lang.String location, - java.lang.Exception exception) +RegexScanError​(nuix.Item item, +PatternInfo patternInfo, +java.lang.String location, +java.lang.Exception exception)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            RegexScanError

            -
            public RegexScanError(nuix.Item item,
-                      PatternInfo patternInfo,
-                      java.lang.String location,
-                      java.lang.Exception exception)
            +
            +

            RegexScanError

            +
            public RegexScanError​(nuix.Item item, +PatternInfo patternInfo, +java.lang.String location, +java.lang.Exception exception)
            Creates a new instance
            Parameters:
            @@ -223,23 +220,22 @@

            RegexScanError

            location - The location being scanned when the error occured (content or metadata property name)
            exception - The exception which was thrown
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getItem

          -
          public nuix.Item getItem(nuix.Case nuixCase)
          +
          +

          getItem

          +
          public nuix.Item getItem​(nuix.Case nuixCase)
          Gets the associated item
          Parameters:
          @@ -247,76 +243,67 @@

          getItem

          Returns:
          The associated item
          +
          • -
        - - - -
        • -

          getItemGuid

          -
          public java.lang.String getItemGuid()
          +
          +

          getItemGuid

          +
          public java.lang.String getItemGuid()
          +
          • -
        - - - -
        • -

          getPatternInfo

          -
          public PatternInfo getPatternInfo()
          +
          +

          getPatternInfo

          +
          public PatternInfo getPatternInfo()
          Gets the associated pattern info
          Returns:
          The associated pattern info
          +
          • -
        - - - -
        • -

          getLocation

          -
          public java.lang.String getLocation()
          +
          +

          getLocation

          +
          public java.lang.String getLocation()
          Gets the associated location
          Returns:
          The associated location
          +
          • -
        - - - -
        • -

          getException

          -
          public java.lang.Exception getException()
          +
          +

          getException

          +
          public java.lang.Exception getException()
          Gets the associated exception
          Returns:
          The associated exception
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/regex/RegexScanner.html b/docs/com/nuix/superutilities/regex/RegexScanner.html index 94b5e90..9bdb1ee 100644 --- a/docs/com/nuix/superutilities/regex/RegexScanner.html +++ b/docs/com/nuix/superutilities/regex/RegexScanner.html @@ -1,42 +1,48 @@ - + RegexScanner + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.regex
    -

    Class RegexScanner

    +
    Package com.nuix.superutilities.regex
    +

    Class RegexScanner

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.regex.RegexScanner
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.regex.RegexScanner
      +
      +
      -
      public class RegexScanner
 extends java.lang.Object
      Class for scanning a series of items with a series of regular expressions.
      @@ -115,259 +99,320 @@

      Class RegexScanner

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        RegexScanner() RegexScanner() 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            RegexScanner

            -
            public RegexScanner()
            +
            +

            RegexScanner

            +
            public RegexScanner()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          setMaxToStringLength

          -
          public static void setMaxToStringLength(int maxLength)
          +
          +

          setMaxToStringLength

          +
          public static void setMaxToStringLength​(int maxLength)
          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. CharSequence may make use of less memory and perform slower but scanning value as a String may perform faster and user more memory.
          @@ -375,60 +420,48 @@

          setMaxToStringLength

          Parameters:
          maxLength - Maximum text length that should be converted to a String before scanning
          +
          • -
        - - - -
        • -

          whenProgressUpdated

          -
          public void whenProgressUpdated(java.util.function.Consumer<java.lang.Integer> callback)
          +
          +

          whenProgressUpdated

          +
          public void whenProgressUpdated​(java.util.function.Consumer<java.lang.Integer> callback)
          Allows you to provide a callback which will be invoked when progress updates occur.
          Parameters:
          callback - Callback to receive progress updates
          +
          • -
        - - - -
        • -

          whenErrorOccurs

          -
          public void whenErrorOccurs(java.util.function.Consumer<RegexScanError> errorCallback)
          +
          +

          whenErrorOccurs

          +
          public void whenErrorOccurs​(java.util.function.Consumer<RegexScanError> errorCallback)
          Allows you to provide a callback which will be invoked when an error occurs during scanning.
          Parameters:
          errorCallback - The callback to be invoked when errors occur
          +
          • -
        - - - -
        • -

          addPattern

          -
          public void addPattern(java.lang.String title,
-                       java.lang.String expression)
          +
          +

          addPattern

          +
          public void addPattern​(java.lang.String title, +java.lang.String expression)
          Adds a regular expression to be part of the scan with a given title. Creates a new instance of - PatternInfo using the values provided.
          + PatternInfo using the values provided.
    Parameters:
    title - The associated title
    expression - The Java regular expression string to add
    + - - - - -
    • -

      scanItems

      -
      public java.util.List<ItemRegexMatchCollection> scanItems(java.util.Collection<nuix.Item> items)
      +
      +

      scanItems

      +
      public java.util.List<ItemRegexMatchCollection> scanItems​(java.util.Collection<nuix.Item> items)
      Scans a series of items serially (no concurrency)
      Parameters:
      @@ -436,16 +469,13 @@

      scanItems

      Returns:
      List of matches
      +
      • -
    - - - -
    • -

      scanItems

      -
      public void scanItems(java.util.Collection<nuix.Item> items,
-                      java.util.function.Consumer<ItemRegexMatchCollection> callback)
      +
      +

      scanItems

      +
      public void scanItems​(java.util.Collection<nuix.Item> items, +java.util.function.Consumer<ItemRegexMatchCollection> callback)
      Scans a series of items, providing each item's matches to callback as they are obtained. Items are scanned in serial (no concurrency).
      @@ -453,16 +483,13 @@

      scanItems

      items - The items to scan
      callback - Callback which will received each item's matches as they are obtained.
      +
      • -
    - - - -
    • -

      scanItemsParallel

      -
      public void scanItemsParallel(java.util.Collection<nuix.Item> items,
-                              java.util.function.Consumer<ItemRegexMatchCollection> callback)
      +
      +

      scanItemsParallel

      +
      public void scanItemsParallel​(java.util.Collection<nuix.Item> items, +java.util.function.Consumer<ItemRegexMatchCollection> callback)
      Scans a series of items, providing each item's matches to callback as they are obtained. Items are scanned in parallel using a Java parallel stream.
      @@ -470,20 +497,17 @@

      scanItemsParallel

      items - The items to scan
      callback - Callback which will received each item's matches as they are obtained.
      +
      • -
    - - - -
    • -

      scanItemsParallel

      -
      public void scanItemsParallel(java.util.Collection<nuix.Item> items,
-                              java.util.function.Consumer<ItemRegexMatchCollection> callback,
-                              int concurrency)
-                       throws java.lang.Exception
      +
      +

      scanItemsParallel

      +
      public void scanItemsParallel​(java.util.Collection<nuix.Item> items, +java.util.function.Consumer<ItemRegexMatchCollection> callback, +int concurrency) + throws java.lang.Exception
      Scans a series of items, providing each item's matches to callback as they are obtained. - Items are scanned in parallel using a Java parallel stream. This differs from the method scanItemsParallel(Collection, Consumer) + Items are scanned in parallel using a Java parallel stream. This differs from the method scanItemsParallel(Collection, Consumer) in that this method invokes the parallel stream within a thread pool to allow for controlling how many threads are used.
      Parameters:
      @@ -493,16 +517,13 @@

      scanItemsParallel

      Throws:
      java.lang.Exception - if there is an error
      +
      • -
    - - - -
    • -

      getStringProperties

      -
      public static java.util.Map<java.lang.String,java.lang.String> getStringProperties(nuix.Item item,
-                                                                                   java.util.Set<java.lang.String> specificProperties)
      +
      +

      getStringProperties

      +
      public static java.util.Map<java.lang.String,​java.lang.String> getStringProperties​(nuix.Item item, +java.util.Set<java.lang.String> specificProperties)
      Convenience method for converting the metadata properties of an item into a Map<String,String> so that regular expressions may be ran against them.
      @@ -512,16 +533,13 @@

      getStringProperties

      Returns:
      Map of "stringified" metadata properties for the specified item
      +
      • -
    - - - -
    • -

      getStringCustomMetadata

      -
      public static java.util.Map<java.lang.String,java.lang.String> getStringCustomMetadata(nuix.Item item,
-                                                                                       java.util.Set<java.lang.String> specificFields)
      +
      +

      getStringCustomMetadata

      +
      public static java.util.Map<java.lang.String,​java.lang.String> getStringCustomMetadata​(nuix.Item item, +java.util.Set<java.lang.String> specificFields)
      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.
      @@ -531,246 +549,201 @@

      getStringCustomMetadata

      Returns:
      Map of "stringified" custom metadata fields for the specified item
      +
      • -
    - - - -
    • -

      getContextualSubString

      -
      public static java.lang.String getContextualSubString(java.lang.CharSequence textSequence,
-                                                      int matchStart,
-                                                      int matchEnd,
-                                                      int contextSize)
      +
      +

      getContextualSubString

      +
      public static java.lang.String getContextualSubString​(java.lang.CharSequence textSequence, +int matchStart, +int matchEnd, +int contextSize)
      +
      • -
    - - - -
    • -

      getScanProperties

      -
      public boolean getScanProperties()
      +
      +

      getScanProperties

      +
      public boolean getScanProperties()
      +
      • -
    - - - -
    • -

      setScanProperties

      -
      public void setScanProperties(boolean scanProperties)
      +
      +

      setScanProperties

      +
      public void setScanProperties​(boolean scanProperties)
      +
      • -
    - - - -
    • -

      getScanCustomMetadata

      -
      public boolean getScanCustomMetadata()
      +
      +

      getScanCustomMetadata

      +
      public boolean getScanCustomMetadata()
      +
      • -
    - - - -
    • -

      setScanCustomMetadata

      -
      public void setScanCustomMetadata(boolean scanCustomMetadata)
      +
      +

      setScanCustomMetadata

      +
      public void setScanCustomMetadata​(boolean scanCustomMetadata)
      +
      • -
    - - - -
    • -

      getScanContent

      -
      public boolean getScanContent()
      +
      +

      getScanContent

      +
      public boolean getScanContent()
      +
      • -
    - - - -
    • -

      setScanContent

      -
      public void setScanContent(boolean scanContent)
      +
      +

      setScanContent

      +
      public void setScanContent​(boolean scanContent)
      +
      • -
    - - - -
    • -

      getCaseSensitive

      -
      public boolean getCaseSensitive()
      +
      +

      getCaseSensitive

      +
      public boolean getCaseSensitive()
      +
      • -
    - - - -
    • -

      setCaseSensitive

      -
      public void setCaseSensitive(boolean caseSensitive)
      +
      +

      setCaseSensitive

      +
      public void setCaseSensitive​(boolean caseSensitive)
      +
      • -
    - - - -
    • -

      getCaptureContextualText

      -
      public boolean getCaptureContextualText()
      +
      +

      getMultiline

      +
      public boolean getMultiline()
      +
      • -
    - - - -
    • -

      setCaptureContextualText

      -
      public void setCaptureContextualText(boolean captureContextualText)
      +
      +

      setMultiline

      +
      public void setMultiline​(boolean multiline)
      +
      • -
    - - - -
    • -

      getContextSize

      -
      public int getContextSize()
      +
      +

      getDotall

      +
      public boolean getDotall()
      +
      • -
    - - - -
    • -

      setContextSize

      -
      public void setContextSize(int contextSize)
      +
      +

      setDotall

      +
      public void setDotall​(boolean dotall)
      +
      • -
    - - - - - - - -
    • -

      setPatterns

      -
      public void setPatterns(java.util.List<PatternInfo> patterns)
      +
      +

      setCaptureContextualText

      +
      public void setCaptureContextualText​(boolean captureContextualText)
      +
      • -
    - - - -
    • -

      getPropertiesToScan

      -
      public java.util.List<java.lang.String> getPropertiesToScan()
      +
      +

      getContextSize

      +
      public int getContextSize()
      +
      • -
    - - - -
    • -

      setPropertiesToScan

      -
      public void setPropertiesToScan(java.util.List<java.lang.String> propertiesToScan)
      +
      +

      setContextSize

      +
      public void setContextSize​(int contextSize)
      +
      • -
    - - - -
    • -

      getCustomMetadataToScan

      -
      public java.util.List<java.lang.String> getCustomMetadataToScan()
      +
      +

      getPatterns

      +
      public java.util.List<PatternInfo> getPatterns()
      +
      • -
    - - - -
    • -

      setCustomMetadataToScan

      -
      public void setCustomMetadataToScan(java.util.List<java.lang.String> fieldsToScan)
      +
      +

      setPatterns

      +
      public void setPatterns​(java.util.List<PatternInfo> patterns)
      +
      • -
    - - - -
    • -

      getMatchNamedEntityValues

      -
      public boolean getMatchNamedEntityValues()
      +
      +

      getPropertiesToScan

      +
      public java.util.List<java.lang.String> getPropertiesToScan()
      +
      • -
    - - - -
    • -

      setMatchNamedEntityValues

      -
      public void setMatchNamedEntityValues(boolean matchNamedEntityValues)
      +
      +

      setPropertiesToScan

      +
      public void setPropertiesToScan​(java.util.List<java.lang.String> propertiesToScan)
      +
      • -
    - - - -
    • -

      getNamedEntityTypes

      -
      public java.util.Set<java.lang.String> getNamedEntityTypes()
      +
      +

      getCustomMetadataToScan

      +
      public java.util.List<java.lang.String> getCustomMetadataToScan()
      +
      • -
    - - - -
    • -

      setNamedEntityTypes

      -
      public void setNamedEntityTypes(java.util.Collection<java.lang.String> namedEntityTypes)
      +
      +

      setCustomMetadataToScan

      +
      public void setCustomMetadataToScan​(java.util.List<java.lang.String> fieldsToScan)
      +
      • -
    - - - -
    • -

      abortScan

      -
      public void abortScan()
      +
      +

      getMatchNamedEntityValues

      +
      public boolean getMatchNamedEntityValues()
      +
      +
      • +
    • +
      +

      setMatchNamedEntityValues

      +
      public void setMatchNamedEntityValues​(boolean matchNamedEntityValues)
      +
      +
      • +
    • +
      +

      getNamedEntityTypes

      +
      public java.util.Set<java.lang.String> getNamedEntityTypes()
      +
      +
      • +
    • +
      +

      setNamedEntityTypes

      +
      public void setNamedEntityTypes​(java.util.Collection<java.lang.String> namedEntityTypes)
      +
      +
      • +
    • +
      +

      abortScan

      +
      public void abortScan()
      When running a scan by providing a Consumer callback, this will signal that further scanning should be aborted.
      +
    + - - - + + + + + diff --git a/docs/com/nuix/superutilities/regex/class-use/ItemRegexMatchCollection.html b/docs/com/nuix/superutilities/regex/class-use/ItemRegexMatchCollection.html index c599664..36b0c12 100644 --- a/docs/com/nuix/superutilities/regex/class-use/ItemRegexMatchCollection.html +++ b/docs/com/nuix/superutilities/regex/class-use/ItemRegexMatchCollection.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.regex.ItemRegexMatchCollection + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.regex.ItemRegexMatchCollection

    +

    Uses of Class
    com.nuix.superutilities.regex.ItemRegexMatchCollection

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/regex/class-use/PatternInfo.html b/docs/com/nuix/superutilities/regex/class-use/PatternInfo.html index aee3dbb..208b7bc 100644 --- a/docs/com/nuix/superutilities/regex/class-use/PatternInfo.html +++ b/docs/com/nuix/superutilities/regex/class-use/PatternInfo.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.regex.PatternInfo + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.regex.PatternInfo

    +

    Uses of Class
    com.nuix.superutilities.regex.PatternInfo

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/regex/class-use/RegexMatch.html b/docs/com/nuix/superutilities/regex/class-use/RegexMatch.html index dfe87db..6196ce8 100644 --- a/docs/com/nuix/superutilities/regex/class-use/RegexMatch.html +++ b/docs/com/nuix/superutilities/regex/class-use/RegexMatch.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.regex.RegexMatch + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.regex.RegexMatch

    +

    Uses of Class
    com.nuix.superutilities.regex.RegexMatch

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/regex/class-use/RegexScanError.html b/docs/com/nuix/superutilities/regex/class-use/RegexScanError.html index 089bdd3..ac7925c 100644 --- a/docs/com/nuix/superutilities/regex/class-use/RegexScanError.html +++ b/docs/com/nuix/superutilities/regex/class-use/RegexScanError.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.regex.RegexScanError + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.regex.RegexScanError

    +

    Uses of Class
    com.nuix.superutilities.regex.RegexScanError

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/regex/class-use/RegexScanner.html b/docs/com/nuix/superutilities/regex/class-use/RegexScanner.html index 7a73a4a..a18f18f 100644 --- a/docs/com/nuix/superutilities/regex/class-use/RegexScanner.html +++ b/docs/com/nuix/superutilities/regex/class-use/RegexScanner.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.regex.RegexScanner + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.regex.RegexScanner

    +

    Uses of Class
    com.nuix.superutilities.regex.RegexScanner

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/regex/package-summary.html b/docs/com/nuix/superutilities/regex/package-summary.html index d5abf08..ee39773 100644 --- a/docs/com/nuix/superutilities/regex/package-summary.html +++ b/docs/com/nuix/superutilities/regex/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.regex + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.regex

    +
    +
    + + +
    + diff --git a/docs/com/nuix/superutilities/regex/package-tree.html b/docs/com/nuix/superutilities/regex/package-tree.html index 95342dc..d5635ed 100644 --- a/docs/com/nuix/superutilities/regex/package-tree.html +++ b/docs/com/nuix/superutilities/regex/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.regex Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.regex

    Package Hierarchies: @@ -76,29 +68,34 @@

    Hierarchy For Package com.nuix.superutilities.regex

    +

    Class Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/regex/package-use.html b/docs/com/nuix/superutilities/regex/package-use.html index 74f63db..2af2806 100644 --- a/docs/com/nuix/superutilities/regex/package-use.html +++ b/docs/com/nuix/superutilities/regex/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.regex + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.regex

    -
    +
    +
    + -
  • +
  • +
    - - +
    +
    Classes in com.nuix.superutilities.regex used by com.nuix.superutilities.regex 
    + + - + + + - + - + - + - +
    Classes in com.nuix.superutilities.regex used by com.nuix.superutilities.regex 
    Class and DescriptionClassDescription
    ItemRegexMatchCollection +ItemRegexMatchCollection
    Represents an item and the associated regular expression matches made against it.
    PatternInfo +PatternInfo
    Represents a regular expression including associated title.
    RegexMatch +RegexMatch
    Represents information about a regular expression match.
    RegexScanError -
    Represents information about an error which occurred in RegexScanner while scanning.
    +    		RegexScanError +
    Represents information about an error which occurred in RegexScanner while scanning.
    +
    • + + + + + + diff --git a/docs/com/nuix/superutilities/reporting/AsposeCellsColorHelper.html b/docs/com/nuix/superutilities/reporting/AsposeCellsColorHelper.html index 06115f3..b56915f 100644 --- a/docs/com/nuix/superutilities/reporting/AsposeCellsColorHelper.html +++ b/docs/com/nuix/superutilities/reporting/AsposeCellsColorHelper.html @@ -1,42 +1,48 @@ - + AsposeCellsColorHelper + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class AsposeCellsColorHelper

    +
    Package com.nuix.superutilities.reporting
    +

    Class AsposeCellsColorHelper

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.AsposeCellsColorHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.AsposeCellsColorHelper
      +
      +
      -
      public class AsposeCellsColorHelper
 extends java.lang.Object
      A class containing helper methods for working with Aspose Cells colors.
      @@ -115,111 +99,121 @@

      Class AsposeCellsColorHel
      Author:
      Jason Wells
      -

      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static com.aspose.cells.ColorgetTint(com.aspose.cells.Color baseColor, - float degree) -
      Provides a tinted variation of the provided base color
      +      		getTint​(int red, +int green, +int blue, +float degree) +
      Tints a color by the given degree
      static com.aspose.cells.ColorgetTint(int red, - int green, - int blue, - float degree) -
      Tints a color by the given degree
      +      		getTint​(com.aspose.cells.Color baseColor, +float degree) +
      Provides a tinted variation of the provided base color
      static inttintChannel(int colorChannelValue, - float degree) +tintChannel​(int colorChannelValue, +float degree)
      Tints a particular color channel value by a certain degree.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            AsposeCellsColorHelper

            -
            public AsposeCellsColorHelper()
            +
            +

            AsposeCellsColorHelper

            +
            public AsposeCellsColorHelper()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          tintChannel

          -
          public static int tintChannel(int colorChannelValue,
-                              float degree)
          +
          +

          tintChannel

          +
          public static int tintChannel​(int colorChannelValue, +float degree)
          Tints a particular color channel value by a certain degree.
          Parameters:
          @@ -228,18 +222,15 @@

          tintChannel

          Returns:
          A tinted version of the color channel value
          +
          • -
        - - - -
        • -

          getTint

          -
          public static com.aspose.cells.Color getTint(int red,
-                                             int green,
-                                             int blue,
-                                             float degree)
          +
          +

          getTint

          +
          public static com.aspose.cells.Color getTint​(int red, +int green, +int blue, +float degree)
          Tints a color by the given degree
          Parameters:
          @@ -250,16 +241,13 @@

          getTint

          Returns:
          A new Color object which has been tinted the specified amount
          +
          • -
        - - - -
        • -

          getTint

          -
          public static com.aspose.cells.Color getTint(com.aspose.cells.Color baseColor,
-                                             float degree)
          +
          +

          getTint

          +
          public static com.aspose.cells.Color getTint​(com.aspose.cells.Color baseColor, +float degree)
          Provides a tinted variation of the provided base color
          Parameters:
          @@ -268,25 +256,28 @@

          getTint

          Returns:
          Tinted copy of the provided base color
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.html b/docs/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.html index 98f769b..bf89921 100644 --- a/docs/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.html +++ b/docs/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.html @@ -1,42 +1,48 @@ - + AsposeCellsStyleHelper + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class AsposeCellsStyleHelper

    +
    Package com.nuix.superutilities.reporting
    +

    Class AsposeCellsStyleHelper

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.AsposeCellsStyleHelper
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.AsposeCellsStyleHelper
      +
      +
      -
      public class AsposeCellsStyleHelper
 extends java.lang.Object
      A class containing helper methods for working with Aspose Cells Styles.
      @@ -115,117 +99,128 @@

      Class AsposeCellsStyleHel
      Author:
      Jason Wells
      -

      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Static Methods Concrete Methods 
      + - + + - + + + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      static voidenableAllBorders(com.aspose.cells.Style style) +enableAllBorders​(com.aspose.cells.Style style)
      Convenience method for applying a thin black border to all sides of a given cell style.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            AsposeCellsStyleHelper

            -
            public AsposeCellsStyleHelper()
            +
            +

            AsposeCellsStyleHelper

            +
            public AsposeCellsStyleHelper()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            enableAllBorders

            -
            public static void enableAllBorders(com.aspose.cells.Style style)
            +
            +

            enableAllBorders

            +
            public static void enableAllBorders​(com.aspose.cells.Style style)
            Convenience method for applying a thin black border to all sides of a given cell style.
            Parameters:
            style - The style to modify the borders of.
            +
          +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/ColorRing.html b/docs/com/nuix/superutilities/reporting/ColorRing.html index 182b47b..85243e8 100644 --- a/docs/com/nuix/superutilities/reporting/ColorRing.html +++ b/docs/com/nuix/superutilities/reporting/ColorRing.html @@ -1,42 +1,48 @@ - + ColorRing + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class ColorRing

    +
    Package com.nuix.superutilities.reporting
    +

    Class ColorRing

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.ColorRing
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.ColorRing
      +
      +
      All Implemented Interfaces:
      -
      java.util.Iterator<com.aspose.cells.Color>
      +
      java.util.Iterator<com.aspose.cells.Color>
      -
      public class ColorRing
 extends java.lang.Object
 implements java.util.Iterator<com.aspose.cells.Color>
      @@ -121,212 +105,211 @@

      Class ColorRing

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        ColorRing() ColorRing() 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + + - + - + - + - + - + - + + - + - + + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      voidaddColor(int red, - int green, - int blue) addColor​(int red, +int green, +int blue) 
      voidaddTintSeries(com.aspose.cells.Color baseColor, - int tintSteps) +addTintSeries​(com.aspose.cells.Color baseColor, +int tintSteps)
      Adds the provided base color and series of tinted variations to this instance.
      voidclearColors() +clearColors()
      Clears all colors currently assigned to this instance.
      booleanhasNext() hasNext() 
      com.aspose.cells.Colornext() next() 
      voidrestart() -
      Moves position of this collection back to the start so that next call to next() will return +
      		restart() +
      Moves position of this collection back to the start so that next call to next() will return the first color in the sequence.
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - -
      -
    • + - +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +

    Methods inherited from interface java.util.Iterator

    -forEachRemaining, remove - - - + + +forEachRemaining, remove
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ColorRing

            -
            public ColorRing()
            +
            +

            ColorRing

            +
            public ColorRing()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          hasNext

          -
          public boolean hasNext()
          +
          +

          hasNext

          +
          public boolean hasNext()
          Specified by:
          hasNext in interface java.util.Iterator<com.aspose.cells.Color>
          +
          • -
        - - - -
        • -

          next

          -
          public com.aspose.cells.Color next()
          +
          +

          next

          +
          public com.aspose.cells.Color next()
          Specified by:
          next in interface java.util.Iterator<com.aspose.cells.Color>
          +
          • -
        - - - -
        • -

          addTintSeries

          -
          public void addTintSeries(com.aspose.cells.Color baseColor,
-                          int tintSteps)
          +
          +

          addTintSeries

          +
          public void addTintSeries​(com.aspose.cells.Color baseColor, +int tintSteps)
          Adds the provided base color and series of tinted variations to this instance.
          Parameters:
          baseColor - The based color to start with
          tintSteps - The number of additional tinted versions of the base color to add
          +
          • -
        - - - -
        • -

          clearColors

          -
          public void clearColors()
          +
          +

          clearColors

          +
          public void clearColors()
          Clears all colors currently assigned to this instance.
          +
          • -
        - - - -
        • -

          restart

          -
          public void restart()
          -
          Moves position of this collection back to the start so that next call to next() will return +
          +

          restart

          +
          public void restart()
          +
          Moves position of this collection back to the start so that next call to next() will return the first color in the sequence.
          +
          • -
        - - - -
        • -

          addColor

          -
          public void addColor(int red,
-                     int green,
-                     int blue)
          +
          +

          addColor

          +
          public void addColor​(int red, +int green, +int blue)
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/ColumnValueGenerator.html b/docs/com/nuix/superutilities/reporting/ColumnValueGenerator.html index 0ea32e3..918f7b8 100644 --- a/docs/com/nuix/superutilities/reporting/ColumnValueGenerator.html +++ b/docs/com/nuix/superutilities/reporting/ColumnValueGenerator.html @@ -1,42 +1,48 @@ - + ColumnValueGenerator + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class ColumnValueGenerator

    +
    Package com.nuix.superutilities.reporting
    +

    Class ColumnValueGenerator

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.ColumnValueGenerator
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.ColumnValueGenerator
      +
      +
      Direct Known Subclasses:
      -
      ScriptedColumnValueGenerator
      +
      ScriptedColumnValueGenerator
      -
      public class ColumnValueGenerator
 extends java.lang.Object
      Base class for reporting. You should not use this class directly, but instead use classes @@ -120,178 +104,181 @@

      Class ColumnValueGenerator<
      Author:
      Jason Wells
      -

      • -
    -
    -
    + +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + + - + - + + - + - + - + - + + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      java.lang.ObjectgenerateValue(nuix.Case nuixCase, - java.lang.String query) generateValue​(nuix.Case nuixCase, +java.lang.String query) 
      java.lang.StringgetColumnLabel() getColumnLabel() 
      java.lang.StringgetLabel() +getLabel()
      Gets the label associated to this instance.
      voidsetColumnLabel(java.lang.String categoryLabel) setColumnLabel​(java.lang.String categoryLabel) 
      voidsetLabel(java.lang.String label) +setLabel​(java.lang.String label)
      Sets the label associated to this instance
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            ColumnValueGenerator

            -
            public ColumnValueGenerator()
            +
            +

            ColumnValueGenerator

            +
            public ColumnValueGenerator()
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          generateValue

          -
          public java.lang.Object generateValue(nuix.Case nuixCase,
-                                      java.lang.String query)
          +
          +

          generateValue

          +
          public java.lang.Object generateValue​(nuix.Case nuixCase, +java.lang.String query)
          +
          • -
        - - - -
        • -

          getLabel

          -
          public java.lang.String getLabel()
          +
          +

          getLabel

          +
          public java.lang.String getLabel()
          Gets the label associated to this instance.
          Returns:
          The associated label
          +
          • -
        - - - -
        • -

          getColumnLabel

          -
          public java.lang.String getColumnLabel()
          +
          +

          getColumnLabel

          +
          public java.lang.String getColumnLabel()
          +
          • -
        - - - -
        • -

          setLabel

          -
          public void setLabel(java.lang.String label)
          +
          +

          setLabel

          +
          public void setLabel​(java.lang.String label)
          Sets the label associated to this instance
          Parameters:
          label - The label to associate
          +
          • -
        - - - -
        • -

          setColumnLabel

          -
          public void setColumnLabel(java.lang.String categoryLabel)
          -
          • -
        +
        +

        setColumnLabel

        +
        public void setColumnLabel​(java.lang.String categoryLabel)
        +
      +
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/IntersectionReport.html b/docs/com/nuix/superutilities/reporting/IntersectionReport.html index e1514b0..f8a8188 100644 --- a/docs/com/nuix/superutilities/reporting/IntersectionReport.html +++ b/docs/com/nuix/superutilities/reporting/IntersectionReport.html @@ -1,42 +1,48 @@ - + IntersectionReport + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class IntersectionReport

    +
    Package com.nuix.superutilities.reporting
    +

    Class IntersectionReport

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.IntersectionReport
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.IntersectionReport
      +
      +
      -
      public class IntersectionReport
 extends java.lang.Object
      This class generates an "intersection report". The report is generated using 3 things: row criteria, column criteria and column value generators. - Row and column criteria are collections of NamedQuery objects. The value reported in a given cell is calculated by first AND'ing together - the relevant row and column criterion. In turn the AND'ed expression is provided to a ColumnValueGenerator which can make use of the query + Row and column criteria are collections of NamedQuery objects. The value reported in a given cell is calculated by first AND'ing together + the relevant row and column criterion. In turn the AND'ed expression is provided to a ColumnValueGenerator which can make use of the query provided to calculate its particular value. Examples might be running Case.count(query) to get a responsive item count or running Case.search(query) and tweaking the results to include families or calling methods on CaseStatistics such as getAuditSize(query) to report responsive items total audited size. This class takes care of iteratively running these things and providing formatting as they are written into an XLSX Excel spreadsheet. If a scope query - is provided via the method IntersectionReportSheetConfiguration.setScopeQuery(String), the provided query will be AND'ed together as well with each row/col criteria combination, allowing + is provided via the method IntersectionReportSheetConfiguration.setScopeQuery(String), the provided query will be AND'ed together as well with each row/col criteria combination, allowing you to further scope the overall report to things like particular evidence, item types, tags, etc.
      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        IntersectionReport(java.lang.String file) +IntersectionReport​(java.lang.String file)
        Creates a new instance
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          +
          • -

            IntersectionReport

            -
            public IntersectionReport(java.lang.String file)
-                   throws java.lang.Exception
            +
            +

            IntersectionReport

            +
            public IntersectionReport​(java.lang.String file) + throws java.lang.Exception
            Creates a new instance
            Parameters:
            @@ -220,44 +227,55 @@

            IntersectionReport

            Throws:
            java.lang.Exception - Thrown if there are errors
            +
          +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          whenProgressUpdated

          -
          public void whenProgressUpdated(IntersectionReportProgressCallback callback)
          +
          +

          findBatchLoadsInDateRange

          +
          public static java.util.List<java.lang.String> findBatchLoadsInDateRange​(nuix.Case nuixCase, +org.joda.time.DateTime min, +org.joda.time.DateTime max)
          +
          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.
          +
          +
          Parameters:
          +
          nuixCase - The case to analyze
          +
          min - The minimum date time, can be null
          +
          max - The maximum date time, can be null
          +
          Returns:
          +
          Returns a list of zero or more GUIDs for the batch loads loaded within the given date range
          +
          +
          +
          • +
        • +
          +

          whenProgressUpdated

          +
          public void whenProgressUpdated​(IntersectionReportProgressCallback callback)
          +
          • -
        - - - -
        • -

          whenMessageGenerated

          -
          public void whenMessageGenerated(java.util.function.Consumer<java.lang.String> callback)
          +
          +

          whenMessageGenerated

          +
          public void whenMessageGenerated​(java.util.function.Consumer<java.lang.String> callback)
          +
          • -
        - - - -
        • -

          generate

          -
          public void generate(nuix.Case nuixCase,
-                     java.lang.String sheetName,
-                     IntersectionReportSheetConfiguration sheetConfig)
-              throws java.lang.Exception
          +
          +

          generate

          +
          public void generate​(nuix.Case nuixCase, +java.lang.String sheetName, +IntersectionReportSheetConfiguration sheetConfig) + throws java.lang.Exception
          Generates a new report sheet using the row criteria, column criteria and value generators currently assigned to this instance
          Parameters:
          @@ -267,43 +285,40 @@

          generate

          Throws:
          java.lang.Exception - Thrown if there are errors
          +
          • -
        - - - - - - - - +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.html b/docs/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.html index b490b45..77e203e 100644 --- a/docs/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.html +++ b/docs/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.html @@ -1,42 +1,48 @@ - + IntersectionReportProgressCallback + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Interface IntersectionReportProgressCallback

    +
    Package com.nuix.superutilities.reporting
    +

    Interface IntersectionReportProgressCallback

    -
    -
      -
    • +
      -
      public interface IntersectionReportProgressCallback
      -
      • -
    -
    -
    + +
    +
    + - - -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        -
          +

          Method Details

          +
          • -

            progressUpdated

            -
            void progressUpdated(int current,
-                     int total)
            +
            +

            progressUpdated

            +
            void progressUpdated​(int current, +int total)
            +
          +
      -
      • -
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.html b/docs/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.html index 14dba2c..7f4d0d3 100644 --- a/docs/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.html +++ b/docs/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.html @@ -1,42 +1,48 @@ - + IntersectionReportSheetConfiguration + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class IntersectionReportSheetConfiguration

    +
    Package com.nuix.superutilities.reporting
    +

    Class IntersectionReportSheetConfiguration

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
      +
      +
      -
      public class IntersectionReportSheetConfiguration
 extends java.lang.Object
      -
      • -
    -
    -
    + +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        -
          +

          Constructor Details

          + +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getRowCriteria

          -
          public java.util.List<NamedQuery> getRowCriteria()
          +
          +

          getRowCriteria

          +
          public java.util.List<NamedQuery> getRowCriteria()
          Gets the list of criteria used for each row.
          Returns:
          List of row criteria.
          +
          • -
        - - - -
        • -

          setRowCriteria

          -
          public void setRowCriteria(java.util.List<NamedQuery> rowCriteria)
          +
          +

          setRowCriteria

          +
          public void setRowCriteria​(java.util.List<NamedQuery> rowCriteria)
          Sets the list of criteria used for each row.
          Parameters:
          rowCriteria - The list of criteria which defines each row.
          +
          • -
        - - - -
        • -

          addRowCriterion

          -
          public void addRowCriterion(NamedQuery criterion)
          -
          Adds a single NamedQuery to the list of row criteria.
          +
          +

          addRowCriterion

          +
          public void addRowCriterion​(NamedQuery criterion)
          +
          Adds a single NamedQuery to the list of row criteria.
          Parameters:
          criterion - The named query to add to the list of row criteria.
          +
          • -
        - - - -
        • -

          addRowCriterion

          -
          public void addRowCriterion(java.lang.String name,
-                            java.lang.String query)
          -
          Adds a single NamedQuery, constructed from the provided arguments, to the list of row criteria.
          +
          +

          addRowCriterion

          +
          public void addRowCriterion​(java.lang.String name, +java.lang.String query)
          +
          Adds a single NamedQuery, constructed from the provided arguments, to the list of row criteria.
          Parameters:
          -
          name - Name value used when constructing the NamedQuery object.
          -
          query - Query value used when constructing the NamedQuery object.
          +
          name - Name value used when constructing the NamedQuery object.
          +
          query - Query value used when constructing the NamedQuery object.
          +
          • -
        - - - -
        • -

          clearRowCriteria

          -
          public void clearRowCriteria()
          +
          +

          clearRowCriteria

          +
          public void clearRowCriteria()
          Removes all currently assigned row criteria.
          +
          • -
        - - - -
        • -

          getColCriteria

          -
          public java.util.List<NamedQuery> getColCriteria()
          +
          +

          getColCriteria

          +
          public java.util.List<NamedQuery> getColCriteria()
          Gets the list of criteria used for each primary column category.
          Returns:
          The list of criteria used for each primary column category.
          +
          • -
        - - - -
        • -

          setColCriteria

          -
          public void setColCriteria(java.util.List<NamedQuery> colCriteria)
          +
          +

          setColCriteria

          +
          public void setColCriteria​(java.util.List<NamedQuery> colCriteria)
          Sets the list of criteria used for each primary column category.
          Parameters:
          colCriteria - The list of criteria to use for each primary column category.
          +
          • -
        - - - -
        • -

          addColCriterion

          -
          public void addColCriterion(NamedQuery criterion)
          -
          Adds a single NamedQuery to the list of primary column criteria.
          +
          +

          addColCriterion

          +
          public void addColCriterion​(NamedQuery criterion)
          +
          Adds a single NamedQuery to the list of primary column criteria.
          Parameters:
          criterion - The named query to add to the list of primary column criteria.
          +
          • -
        - - - -
        • -

          addColCriterion

          -
          public void addColCriterion(java.lang.String name,
-                            java.lang.String query)
          -
          Adds a single NamedQuery, constructed from the provided arguments, to the list of primary column criteria.
          +
          +

          addColCriterion

          +
          public void addColCriterion​(java.lang.String name, +java.lang.String query)
          +
          Adds a single NamedQuery, constructed from the provided arguments, to the list of primary column criteria.
          Parameters:
          -
          name - Name value used when constructing the NamedQuery object.
          -
          query - Query value used when constructing the NamedQuery object.
          +
          name - Name value used when constructing the NamedQuery object.
          +
          query - Query value used when constructing the NamedQuery object.
          +
          • -
        - - - -
        • -

          getValueGenerators

          -
          public java.util.List<ColumnValueGenerator> getValueGenerators()
          -
          Gets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          +

          getValueGenerators

          +
          public java.util.List<ColumnValueGenerator> getValueGenerators()
          +
          Gets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          Returns:
          -
          The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          • -
        - - - -
        • -

          setValueGenerators

          -
          public void setValueGenerators(java.util.List<ColumnValueGenerator> valueGenerators)
          -
          Sets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          +

          setValueGenerators

          +
          public void setValueGenerators​(java.util.List<ColumnValueGenerator> valueGenerators)
          +
          Sets the list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          Parameters:
          -
          valueGenerators - The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          valueGenerators - The list of ColumnValueGenerator objects used to calculate the value of each secondary column nested beneath any given primary column.
          +
          • -
        - - - -
        • -

          addScriptedValueGenerator

          -
          public void addScriptedValueGenerator(java.lang.String label,
-                                      java.util.function.BiFunction<nuix.Case,java.lang.String,java.lang.Object> expression)
          -
          Adds a ColumnValueGenerator which calculates its value using the expression provided.
          +
          +

          addScriptedValueGenerator

          +
          public void addScriptedValueGenerator​(java.lang.String label, +java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression)
          +
          Adds a ColumnValueGenerator which calculates its value using the expression provided.
          Parameters:
          label - The label used for this secondary column
          expression - The expression used to calculate this secondary column's value. Expression is provided a Nuix Case object and query and should return an object such as a String or integer value.
          +
          • -
        - - - -
        • -

          getRowCategoryLabel

          -
          public java.lang.String getRowCategoryLabel()
          +
          +

          getRowCategoryLabel

          +
          public java.lang.String getRowCategoryLabel()
          Gets the overall row category label.
          Returns:
          The overall row category label.
          +
          • -
        - - - -
        • -

          setRowCategoryLabel

          -
          public void setRowCategoryLabel(java.lang.String rowCategoryLabel)
          +
          +

          setRowCategoryLabel

          +
          public void setRowCategoryLabel​(java.lang.String rowCategoryLabel)
          Sets the overall row category label. For example if each row is a search term, then you might set the label to "Terms".
          Parameters:
          rowCategoryLabel - The overall row category label.
          +
          • -
        - - - -
        • -

          getColPrimaryCategoryLabel

          -
          public java.lang.String getColPrimaryCategoryLabel()
          +
          +

          getColPrimaryCategoryLabel

          +
          public java.lang.String getColPrimaryCategoryLabel()
          Gets the overall primary column category label.
          Returns:
          The overall primary column category label.
          +
          • -
        - - - -
        • -

          setColPrimaryCategoryLabel

          -
          public void setColPrimaryCategoryLabel(java.lang.String colPrimaryCategoryLabel)
          +
          +

          setColPrimaryCategoryLabel

          +
          public void setColPrimaryCategoryLabel​(java.lang.String colPrimaryCategoryLabel)
          Sets the overall primary column category label. For example, if each primary column is a custodian name, then you might set the label to "Custodians".
          Parameters:
          colPrimaryCategoryLabel - The overall primary column label.
          +
          • -
        - - - -
        • -

          getScopeQuery

          -
          public java.lang.String getScopeQuery()
          +
          +

          getScopeQuery

          +
          public java.lang.String getScopeQuery()
          Gets the current scope query which scopes the overall item set reported on. A blank value is equivalent to no overall scope.
          Returns:
          The current overall scope query.
          +
          • -
        - - - -
        • -

          setScopeQuery

          -
          public void setScopeQuery(java.lang.String scopeQuery)
          +
          +

          setScopeQuery

          +
          public void setScopeQuery​(java.lang.String scopeQuery)
          Sets the current scope query which scopes the overall item set reported on. A blank value is equivalent to no overall scope.
          Parameters:
          scopeQuery - The overall scope query to use.
          +
          +
          • +
        • +
          +

          getBatchLoadMinDate

          +
          public org.joda.time.DateTime getBatchLoadMinDate()
          +
          Gets the minimum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
          +
          +
          Returns:
          +
          the minimum batch load date an item must have to be reported
          +
          +
          +
          • +
        • +
          +

          setBatchLoadMinDate

          +
          public void setBatchLoadMinDate​(org.joda.time.DateTime batchLoadMinDate)
          +
          Sets the minimum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
          +
          +
          Parameters:
          +
          batchLoadMinDate - the minimum batch load date an item must have to be reported
          +
          +
          +
          • +
        • +
          +

          getBatchLoadMaxDate

          +
          public org.joda.time.DateTime getBatchLoadMaxDate()
          +
          Gets the maximum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
          +
          +
          Returns:
          +
          the maximum batch load date an item must have to be reported
          +
          +
          +
          • +
        • +
          +

          setBatchLoadMaxDate

          +
          public void setBatchLoadMaxDate​(org.joda.time.DateTime batchLoadMaxDate)
          +
          Sets the maximum batch load date an item must have to be reported. A null value means batch load date is not to be considered.
          +
          +
          Parameters:
          +
          batchLoadMaxDate - the maximum batch load date an item must have to be reported
          +
          +
          • -
        - - - -
        • -

          getFreezePanes

          -
          public boolean getFreezePanes()
          +
          +

          hasBatchLoadDateCriteria

          +
          public boolean hasBatchLoadDateCriteria()
          +
          +
          • +
        • +
          +

          getFreezePanes

          +
          public boolean getFreezePanes()
          Gets whether "freeze panes" will be applied to this sheet. When true, first column and first 2 rows will be frozen into place.
          Returns:
          Whether "freeze panes" will be applied to this sheet.
          +
          • -
        - - - -
        • -

          setFreezePanes

          -
          public void setFreezePanes(boolean freezePanes)
          +
          +

          setFreezePanes

          +
          public void setFreezePanes​(boolean freezePanes)
          Sets whether "freeze panes" will be applied to this sheet. When true, first column and first 2 rows will be frozen into place.
          Parameters:
          freezePanes - Whether "freeze panes" will be applied to this sheet.
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/NamedQuery.html b/docs/com/nuix/superutilities/reporting/NamedQuery.html index 04e1452..3bd410d 100644 --- a/docs/com/nuix/superutilities/reporting/NamedQuery.html +++ b/docs/com/nuix/superutilities/reporting/NamedQuery.html @@ -1,42 +1,48 @@ - + NamedQuery + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class NamedQuery

    +
    Package com.nuix.superutilities.reporting
    +

    Class NamedQuery

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.NamedQuery
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.NamedQuery
      +
      +
      -
      public class NamedQuery
 extends java.lang.Object
      Encapsulates a Nuix query string and an associated name.
      @@ -115,191 +99,194 @@

      Class NamedQuery

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        NamedQuery() NamedQuery() 
        NamedQuery(java.lang.String name, - java.lang.String query) NamedQuery​(java.lang.String name, +java.lang.String query) 
        +
    + - -
      -
    • +
    • +
      -

      Method Summary

      - - +

      Method Summary

      +
      +
      +
      +
      All Methods Instance Methods Concrete Methods 
      + - + + - + + + - + - + - + - + - + - + - + +
      Modifier and TypeMethod and DescriptionMethodDescription
      java.lang.StringgetName() +getName()
      Gets the associated name
      java.lang.StringgetQuery() +getQuery()
      Gets the associated query
      voidsetName(java.lang.String name) +setName​(java.lang.String name)
      Sets the associated name
      voidsetQuery(java.lang.String query) +setQuery​(java.lang.String query)
      Sets the associated query
      -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          NamedQuery

          -
          public NamedQuery()
          +
          +

          NamedQuery

          +
          public NamedQuery()
          +
          • -
        - - - -
        • -

          NamedQuery

          -
          public NamedQuery(java.lang.String name,
-                  java.lang.String query)
          +
          +

          NamedQuery

          +
          public NamedQuery​(java.lang.String name, +java.lang.String query)
          +
        +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getName

          -
          public java.lang.String getName()
          +
          +

          getName

          +
          public java.lang.String getName()
          Gets the associated name
          Returns:
          The associated name
          +
          • -
        - - - -
        • -

          setName

          -
          public void setName(java.lang.String name)
          +
          +

          setName

          +
          public void setName​(java.lang.String name)
          Sets the associated name
          Parameters:
          name - The name to associate
          +
          • -
        - - - -
        • -

          getQuery

          -
          public java.lang.String getQuery()
          +
          +

          getQuery

          +
          public java.lang.String getQuery()
          Gets the associated query
          Returns:
          The associated query
          +
          • -
        - - - -
        • -

          setQuery

          -
          public void setQuery(java.lang.String query)
          +
          +

          setQuery

          +
          public void setQuery​(java.lang.String query)
          Sets the associated query
          Parameters:
          query - The query to associate
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.html b/docs/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.html index 12a2fb9..4cc53dc 100644 --- a/docs/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.html +++ b/docs/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.html @@ -1,42 +1,48 @@ - + ScriptedColumnValueGenerator + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class ScriptedColumnValueGenerator

    +
    Package com.nuix.superutilities.reporting
    +

    Class ScriptedColumnValueGenerator

    - -
    - -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        ScriptedColumnValueGenerator(java.lang.String label, - java.util.function.BiFunction<nuix.Case,java.lang.String,java.lang.Object> expression) -
        Creates a new instance which will used the specified expression.
        -        		ScriptedColumnValueGenerator​(java.lang.String label, +java.lang.String categoryLabel, +java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression) 
        ScriptedColumnValueGenerator(java.lang.String label, - java.lang.String categoryLabel, - java.util.function.BiFunction<nuix.Case,java.lang.String,java.lang.Object> expression) ScriptedColumnValueGenerator​(java.lang.String label, +java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression) +
        Creates a new instance which will used the specified expression.
        +
        +
    + - -
    +
    +
    +

    Methods inherited from class com.nuix.superutilities.reporting.ColumnValueGenerator

    + - +getColumnLabel, getLabel, setColumnLabel, setLabel
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          ScriptedColumnValueGenerator

          -
          public ScriptedColumnValueGenerator(java.lang.String label,
-                                    java.util.function.BiFunction<nuix.Case,java.lang.String,java.lang.Object> expression)
          +
          +

          ScriptedColumnValueGenerator

          +
          public ScriptedColumnValueGenerator​(java.lang.String label, +java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression)
          Creates a new instance which will used the specified expression.
          Parameters:
          label - The label to use when generating a report
          expression - The expression used to calculate this column's value. Expression will be provided a Nuix case object and query String and is expected to return a value such as a string or integer.
          +
          • -
        - - - -
        • -

          ScriptedColumnValueGenerator

          -
          public ScriptedColumnValueGenerator(java.lang.String label,
-                                    java.lang.String categoryLabel,
-                                    java.util.function.BiFunction<nuix.Case,java.lang.String,java.lang.Object> expression)
          +
          +

          ScriptedColumnValueGenerator

          +
          public ScriptedColumnValueGenerator​(java.lang.String label, +java.lang.String categoryLabel, +java.util.function.BiFunction<nuix.Case,​java.lang.String,​java.lang.Object> expression)
          +
        +
        • -
      - -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/SimpleWorksheet.html b/docs/com/nuix/superutilities/reporting/SimpleWorksheet.html index d0bcc04..129bf34 100644 --- a/docs/com/nuix/superutilities/reporting/SimpleWorksheet.html +++ b/docs/com/nuix/superutilities/reporting/SimpleWorksheet.html @@ -1,42 +1,48 @@ - + SimpleWorksheet + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class SimpleWorksheet

    +
    Package com.nuix.superutilities.reporting
    +

    Class SimpleWorksheet

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.SimpleWorksheet
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.SimpleWorksheet
      +
      +
      -
      public class SimpleWorksheet
 extends java.lang.Object
      Wrapper class around Aspose Cells Worksheet object which simplifies some of the @@ -116,152 +100,163 @@

      Class SimpleWorksheet

      Author:
      Jason Wells
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Method Summary

        - - +

        Method Summary

        +
        +
        +
        +
        All Methods Instance Methods Concrete Methods 
        + - + + - + + + - + + - + - + + - + - + + - + - + + - + - + + - + - + - + - + - + - + + - + - + - + - + - + - + - + - + + - + - + - + - + +
        Modifier and TypeMethod and DescriptionMethodDescription
        voidappendRow(java.util.List<? extends java.lang.Object> rowValues) appendRow​(java.util.List<? extends java.lang.Object> rowValues) 
        voidappendRow(java.util.List<java.lang.Object> rowValues, - com.aspose.cells.Style defaultStyle) appendRow​(java.util.List<java.lang.Object> rowValues, +com.aspose.cells.Style defaultStyle) 
        voidautoFitColumns() autoFitColumns() 
        voidautoFitRow(int row) autoFitRow​(int row) 
        voideachCell(int startRow, - int endRow, - int startCol, - int endCol, - java.util.function.Consumer<com.aspose.cells.Cell> activity) eachCell​(int startRow, +int endRow, +int startCol, +int endCol, +java.util.function.Consumer<com.aspose.cells.Cell> activity) 
        com.aspose.cells.WorksheetgetAsposeWorksheet() +getAsposeWorksheet()
        Gets the underlying Aspose Cells Worksheet object.
        com.aspose.cells.CellgetCell(int row, - int col) +getCell​(int row, +int col)
        Gets a particular Cell object from this work sheet.
        intgetCurrentRow() getCurrentRow() 
        com.aspose.cells.StylegetStyle(int row, - int col) +getStyle​(int row, +int col)
        Gets the style of a particular cell in this work sheet
        java.lang.ObjectgetValue(int row, - int col) +getValue​(int row, +int col)
        Gets the value of a particular cell in this work sheet
        voidmergeCols(int row, - int col, - int colCount) +mergeCols​(int row, +int col, +int colCount)
        Merges a series of cells horizontally
        voidsetCurrentRow(int currentRow) setCurrentRow​(int currentRow) 
        voidsetStyle(int row, - int col, - com.aspose.cells.Style style) +setStyle​(int row, +int col, +com.aspose.cells.Style style)
        Sets the style of of a particular cell in this work sheet
        voidsetValue(int row, - int col, - java.lang.Object value) +setValue​(int row, +int col, +java.lang.Object value)
        Sets the value of a particular cell in this work sheet
        -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          getAsposeWorksheet

          -
          public com.aspose.cells.Worksheet getAsposeWorksheet()
          +
          +

          getAsposeWorksheet

          +
          public com.aspose.cells.Worksheet getAsposeWorksheet()
          Gets the underlying Aspose Cells Worksheet object.
          Returns:
          The underlying Aspose Cells Worksheet object.
          +
          • -
        - - - -
        • -

          getCell

          -
          public com.aspose.cells.Cell getCell(int row,
-                                     int col)
          +
          +

          getCell

          +
          public com.aspose.cells.Cell getCell​(int row, +int col)
          Gets a particular Cell object from this work sheet.
          Parameters:
          @@ -270,16 +265,13 @@

          getCell

          Returns:
          The underlying Aspose Cells Cell object at the given indices
          +
          • -
        - - - -
        • -

          getValue

          -
          public java.lang.Object getValue(int row,
-                                 int col)
          +
          +

          getValue

          +
          public java.lang.Object getValue​(int row, +int col)
          Gets the value of a particular cell in this work sheet
          Parameters:
          @@ -288,17 +280,14 @@

          getValue

          Returns:
          The value of the cell at the given indices
          +
          • -
        - - - -
        • -

          setValue

          -
          public void setValue(int row,
-                     int col,
-                     java.lang.Object value)
          +
          +

          setValue

          +
          public void setValue​(int row, +int col, +java.lang.Object value)
          Sets the value of a particular cell in this work sheet
          Parameters:
          @@ -306,17 +295,14 @@

          setValue

          col - The 0 based column index
          value - The value to assign to the cell at the given indices
          +
          • -
        - - - -
        • -

          setStyle

          -
          public void setStyle(int row,
-                     int col,
-                     com.aspose.cells.Style style)
          +
          +

          setStyle

          +
          public void setStyle​(int row, +int col, +com.aspose.cells.Style style)
          Sets the style of of a particular cell in this work sheet
          Parameters:
          @@ -324,16 +310,13 @@

          setStyle

          col - The 0 based column index
          style - The Style to apply to the cell at the given indices
          +
          • -
        - - - -
        • -

          getStyle

          -
          public com.aspose.cells.Style getStyle(int row,
-                                       int col)
          +
          +

          getStyle

          +
          public com.aspose.cells.Style getStyle​(int row, +int col)
          Gets the style of a particular cell in this work sheet
          Parameters:
          @@ -342,17 +325,14 @@

          getStyle

          Returns:
          The Style of the cell at the given indices
          +
          • -
        - - - -
        • -

          mergeCols

          -
          public void mergeCols(int row,
-                      int col,
-                      int colCount)
          +
          +

          mergeCols

          +
          public void mergeCols​(int row, +int col, +int colCount)
          Merges a series of cells horizontally
          Parameters:
          @@ -360,103 +340,85 @@

          mergeCols

          col - The 0 based column index of the first column in the merged group of cells.
          colCount - How many cells total to merge, so if you want the 2 cells following the first cell specified by the indices, provide a value of 3.
          +
          • -
        - - - -
        • -

          autoFitColumns

          -
          public void autoFitColumns()
-                    throws java.lang.Exception
          +
          +

          autoFitColumns

          +
          public void autoFitColumns() + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          autoFitRow

          -
          public void autoFitRow(int row)
-                throws java.lang.Exception
          +
          +

          autoFitRow

          +
          public void autoFitRow​(int row) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          appendRow

          -
          public void appendRow(java.util.List<? extends java.lang.Object> rowValues)
          +
          +

          appendRow

          +
          public void appendRow​(java.util.List<? extends java.lang.Object> rowValues)
          +
          • -
        - - - -
        • -

          appendRow

          -
          public void appendRow(java.util.List<java.lang.Object> rowValues,
-                      com.aspose.cells.Style defaultStyle)
          +
          +

          appendRow

          +
          public void appendRow​(java.util.List<java.lang.Object> rowValues, +com.aspose.cells.Style defaultStyle)
          +
          • -
        - - - -
        • -

          eachCell

          -
          public void eachCell(int startRow,
-                     int endRow,
-                     int startCol,
-                     int endCol,
-                     java.util.function.Consumer<com.aspose.cells.Cell> activity)
          +
          +

          eachCell

          +
          public void eachCell​(int startRow, +int endRow, +int startCol, +int endCol, +java.util.function.Consumer<com.aspose.cells.Cell> activity)
          +
          • -
        - - - -
        • -

          getCurrentRow

          -
          public int getCurrentRow()
          +
          +

          getCurrentRow

          +
          public int getCurrentRow()
          +
          • -
        - - - -
        • -

          setCurrentRow

          -
          public void setCurrentRow(int currentRow)
          +
          +

          setCurrentRow

          +
          public void setCurrentRow​(int currentRow)
          +
        +
      -
      • -
    -
    +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/SimpleXlsx.html b/docs/com/nuix/superutilities/reporting/SimpleXlsx.html index 658f3ba..9379090 100644 --- a/docs/com/nuix/superutilities/reporting/SimpleXlsx.html +++ b/docs/com/nuix/superutilities/reporting/SimpleXlsx.html @@ -1,42 +1,48 @@ - + SimpleXlsx + + + + + + + + + - - +var pathtoroot = "../../../../"; +loadScripts(document, 'script'); +
    + +
    +
    -
    com.nuix.superutilities.reporting
    -

    Class SimpleXlsx

    +
    Package com.nuix.superutilities.reporting
    +

    Class SimpleXlsx

    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.nuix.superutilities.reporting.SimpleXlsx
        • -
      -
      • -
    -
    -
      -
    • +
      java.lang.Object +
      com.nuix.superutilities.reporting.SimpleXlsx
      +
      +
      All Implemented Interfaces:
      -
      java.io.Closeable, java.lang.AutoCloseable
      +
      java.io.Closeable, java.lang.AutoCloseable
      -
      public class SimpleXlsx
 extends java.lang.Object
 implements java.io.Closeable
      -
      • -
    -
    -
    + +
      -
    • -
        -
      • +
      • +
        -

        Constructor Summary

        - +

        Constructor Summary

        +
        +
        + - + + + + - + + - + + +
        Constructors 
        Constructor and DescriptionConstructorDescription
        SimpleXlsx(java.io.File file) SimpleXlsx​(java.io.File file) 
        SimpleXlsx(java.lang.String file) SimpleXlsx​(java.lang.String file) 
        +
    + - -
    +
    +

    Methods inherited from class java.lang.Object

    -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - - - + + +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    + -
    -
    + +
      -
    • -
        -
      • - - -

        Constructor Detail

        - +
      • +
        +

        Constructor Details

        • -

          SimpleXlsx

          -
          public SimpleXlsx(java.io.File file)
-           throws java.lang.Exception
          +
          +

          SimpleXlsx

          +
          public SimpleXlsx​(java.io.File file) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          SimpleXlsx

          -
          public SimpleXlsx(java.lang.String file)
-           throws java.lang.Exception
          +
          +

          SimpleXlsx

          +
          public SimpleXlsx​(java.lang.String file) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
        +
        • -
      -
        -
      • - - -

        Method Detail

        - +
      • +
        +

        Method Details

        • -

          initializeAspose

          -
          public static void initializeAspose()
-                             throws java.lang.Exception
          +
          +

          initializeAspose

          +
          public static void initializeAspose() + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          saveAs

          -
          public void saveAs(java.lang.String file)
-            throws java.lang.Exception
          +
          +

          saveAs

          +
          public void saveAs​(java.lang.String file) + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - -
        • -

          save

          -
          public void save()
-          throws java.lang.Exception
          +
          +

          save

          +
          public void save() + throws java.lang.Exception
          Throws:
          java.lang.Exception
          +
          • -
        - - - - - - - -
        • -

          getAsposeWorkbook

          -
          public com.aspose.cells.Workbook getAsposeWorkbook()
          +
          +

          getAsposeWorkbook

          +
          public com.aspose.cells.Workbook getAsposeWorkbook()
          +
          • -
        - - - -
        • -

          createStyle

          -
          public com.aspose.cells.Style createStyle()
          +
          +

          createStyle

          +
          public com.aspose.cells.Style createStyle()
          +
          • -
        - - - -
        • -

          close

          -
          public void close()
-           throws java.io.IOException
          +
          +

          close

          +
          public void close() + throws java.io.IOException
          Specified by:
          -
          close in interface java.io.Closeable
          -
          Specified by:
          close in interface java.lang.AutoCloseable
          +
          Specified by:
          +
          close in interface java.io.Closeable
          Throws:
          java.io.IOException
          +
        +
      -
      • -
    -
    + + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsColorHelper.html b/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsColorHelper.html index ec2e59e..7978207 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsColorHelper.html +++ b/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsColorHelper.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.AsposeCellsColorHelper + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.AsposeCellsColorHelper

    +

    Uses of Class
    com.nuix.superutilities.reporting.AsposeCellsColorHelper

    No usage of com.nuix.superutilities.reporting.AsposeCellsColorHelper
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsStyleHelper.html b/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsStyleHelper.html index 6efa5c2..68181c2 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsStyleHelper.html +++ b/docs/com/nuix/superutilities/reporting/class-use/AsposeCellsStyleHelper.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.AsposeCellsStyleHelper + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.AsposeCellsStyleHelper

    +

    Uses of Class
    com.nuix.superutilities.reporting.AsposeCellsStyleHelper

    No usage of com.nuix.superutilities.reporting.AsposeCellsStyleHelper
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/class-use/ColorRing.html b/docs/com/nuix/superutilities/reporting/class-use/ColorRing.html index d6f48bb..8595229 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/ColorRing.html +++ b/docs/com/nuix/superutilities/reporting/class-use/ColorRing.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.ColorRing + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.ColorRing

    +

    Uses of Class
    com.nuix.superutilities.reporting.ColorRing

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/ColumnValueGenerator.html b/docs/com/nuix/superutilities/reporting/class-use/ColumnValueGenerator.html index 61b8dd2..ce1b9ab 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/ColumnValueGenerator.html +++ b/docs/com/nuix/superutilities/reporting/class-use/ColumnValueGenerator.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.ColumnValueGenerator + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.ColumnValueGenerator

    +

    Uses of Class
    com.nuix.superutilities.reporting.ColumnValueGenerator

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReport.html b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReport.html index 800fe70..93938a1 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReport.html +++ b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReport.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.IntersectionReport + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.IntersectionReport

    +

    Uses of Class
    com.nuix.superutilities.reporting.IntersectionReport

    No usage of com.nuix.superutilities.reporting.IntersectionReport
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportProgressCallback.html b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportProgressCallback.html index 7b30a19..c051b1a 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportProgressCallback.html +++ b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportProgressCallback.html @@ -1,38 +1,44 @@ - + Uses of Interface com.nuix.superutilities.reporting.IntersectionReportProgressCallback + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Interface
    com.nuix.superutilities.reporting.IntersectionReportProgressCallback

    +

    Uses of Interface
    com.nuix.superutilities.reporting.IntersectionReportProgressCallback

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportSheetConfiguration.html b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportSheetConfiguration.html index d554287..921016a 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportSheetConfiguration.html +++ b/docs/com/nuix/superutilities/reporting/class-use/IntersectionReportSheetConfiguration.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration

    +

    Uses of Class
    com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/NamedQuery.html b/docs/com/nuix/superutilities/reporting/class-use/NamedQuery.html index a4ccd3a..9bfd5f4 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/NamedQuery.html +++ b/docs/com/nuix/superutilities/reporting/class-use/NamedQuery.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.NamedQuery + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.NamedQuery

    +

    Uses of Class
    com.nuix.superutilities.reporting.NamedQuery

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/ScriptedColumnValueGenerator.html b/docs/com/nuix/superutilities/reporting/class-use/ScriptedColumnValueGenerator.html index 4e30ea4..ec3c70b 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/ScriptedColumnValueGenerator.html +++ b/docs/com/nuix/superutilities/reporting/class-use/ScriptedColumnValueGenerator.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.ScriptedColumnValueGenerator

    +

    Uses of Class
    com.nuix.superutilities.reporting.ScriptedColumnValueGenerator

    No usage of com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/class-use/SimpleWorksheet.html b/docs/com/nuix/superutilities/reporting/class-use/SimpleWorksheet.html index 687189a..e9bc46b 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/SimpleWorksheet.html +++ b/docs/com/nuix/superutilities/reporting/class-use/SimpleWorksheet.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.SimpleWorksheet + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.SimpleWorksheet

    +

    Uses of Class
    com.nuix.superutilities.reporting.SimpleWorksheet

    -
    +
    + - - +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/class-use/SimpleXlsx.html b/docs/com/nuix/superutilities/reporting/class-use/SimpleXlsx.html index 25e0c92..39af27c 100644 --- a/docs/com/nuix/superutilities/reporting/class-use/SimpleXlsx.html +++ b/docs/com/nuix/superutilities/reporting/class-use/SimpleXlsx.html @@ -1,38 +1,44 @@ - + Uses of Class com.nuix.superutilities.reporting.SimpleXlsx + + + + + + + + + - - + + +
    + +
    +
    -

    Uses of Class
    com.nuix.superutilities.reporting.SimpleXlsx

    +

    Uses of Class
    com.nuix.superutilities.reporting.SimpleXlsx

    No usage of com.nuix.superutilities.reporting.SimpleXlsx
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/package-summary.html b/docs/com/nuix/superutilities/reporting/package-summary.html index 045e6b9..2a71a88 100644 --- a/docs/com/nuix/superutilities/reporting/package-summary.html +++ b/docs/com/nuix/superutilities/reporting/package-summary.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.reporting + + + + + + + + + - - + + +
    + +
    +

    Package com.nuix.superutilities.reporting

    +
  • - +
    +
    + + - + - + - + - + - + - + - + - + - + - +
    Class Summary 
    Class Description
    AsposeCellsColorHelperAsposeCellsColorHelper
    A class containing helper methods for working with Aspose Cells colors.
    AsposeCellsStyleHelperAsposeCellsStyleHelper
    A class containing helper methods for working with Aspose Cells Styles.
    ColorRingColorRing
    Iterator over a collection of Aspose Cells Color objects.
    ColumnValueGeneratorColumnValueGenerator
    Base class for reporting.
    IntersectionReportIntersectionReport
    This class generates an "intersection report".
    IntersectionReportSheetConfigurationIntersectionReportSheetConfiguration  
    NamedQueryNamedQuery
    Encapsulates a Nuix query string and an associated name.
    ScriptedColumnValueGeneratorScriptedColumnValueGenerator -
    A ColumnValueGenerator which uses the provided BiFunction expression to calculate its value.
    +
    A ColumnValueGenerator which uses the provided BiFunction expression to calculate its value.
    SimpleWorksheetSimpleWorksheet
    Wrapper class around Aspose Cells Worksheet object which simplifies some of the more common operations.
    SimpleXlsxSimpleXlsx  
    +
    • +
    + + + + diff --git a/docs/com/nuix/superutilities/reporting/package-tree.html b/docs/com/nuix/superutilities/reporting/package-tree.html index 3991d8a..d1460a1 100644 --- a/docs/com/nuix/superutilities/reporting/package-tree.html +++ b/docs/com/nuix/superutilities/reporting/package-tree.html @@ -1,36 +1,42 @@ - + com.nuix.superutilities.reporting Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For Package com.nuix.superutilities.reporting

    Package Hierarchies: @@ -76,41 +68,48 @@

    Hierarchy For Package com.nuix.superutilities.reporting

    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

    +
    +
    + +
    +
    diff --git a/docs/com/nuix/superutilities/reporting/package-use.html b/docs/com/nuix/superutilities/reporting/package-use.html index caaebec..c5d489f 100644 --- a/docs/com/nuix/superutilities/reporting/package-use.html +++ b/docs/com/nuix/superutilities/reporting/package-use.html @@ -1,36 +1,42 @@ - + Uses of Package com.nuix.superutilities.reporting + + + + + + + + + - - + + +
    + +
    +

    Uses of Package
    com.nuix.superutilities.reporting

    -
    +
    +
    + +
    + + + + diff --git a/docs/constant-values.html b/docs/constant-values.html index 3a21f16..19e17da 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -1,36 +1,42 @@ - + Constant Field Values + + + + + + + + + - - + + +
    + +
    +

    Constant Field Values

    +

    Contents

    +
    +
    + +
    +
    diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index 5f453a4..1bd303d 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -1,36 +1,42 @@ - + Deprecated List + + + + + + + + + - - + + +
    + +
    +

    Deprecated API

    Contents

    +
    + +
    +
    diff --git a/docs/element-list b/docs/element-list new file mode 100644 index 0000000..ef68300 --- /dev/null +++ b/docs/element-list @@ -0,0 +1,11 @@ +com.nuix.superutilities +com.nuix.superutilities.annotations +com.nuix.superutilities.cases +com.nuix.superutilities.export +com.nuix.superutilities.items +com.nuix.superutilities.loadfiles +com.nuix.superutilities.misc +com.nuix.superutilities.namedentities +com.nuix.superutilities.query +com.nuix.superutilities.regex +com.nuix.superutilities.reporting diff --git a/docs/help-doc.html b/docs/help-doc.html index 41a3670..0f75d45 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -1,36 +1,42 @@ - + API Help + + + + + + + + + - - + + +
    + +
    +

    How This API Document Is Organized

    This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
    @@ -75,118 +67,148 @@

    How This API Document Is Organized

    • +

      Overview

      -

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +
    • +

      Package

      -

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

        -
      • Interfaces (italic)
        • +
      • Interfaces
      • Classes
      • Enums
      • Exceptions
      • Errors
      • Annotation Types
      +
    • -

      Class/Interface

      +
      +

      Class or Interface

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

        -
      • Class inheritance diagram
        • +
      • Class Inheritance Diagram
      • Direct Subclasses
      • All Known Subinterfaces
      • All Known Implementing Classes
        • -
      • Class/interface declaration
        • -
      • Class/interface description
        • +
      • Class or Interface Declaration
        • +
      • Class or Interface Description
      +
      • Nested Class Summary
      • Field Summary
        • +
      • Property Summary
      • Constructor Summary
      • Method Summary
      +
        -
      • Field Detail
        • -
      • Constructor Detail
        • -
      • Method Detail
        • +
      • Field Details
        • +
      • Property Details
        • +
      • Constructor Details
        • +
      • Method Details

      Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

      +
    • +

      Annotation Type

      Each annotation type has its own separate page with the following sections:

        -
      • Annotation Type declaration
        • -
      • Annotation Type description
        • +
      • Annotation Type Declaration
        • +
      • Annotation Type Description
      • Required Element Summary
      • Optional Element Summary
        • -
      • Element Detail
        • +
      • Element Details
      +
    • +

      Enum

      Each enum has its own separate page with the following sections:

        -
      • Enum declaration
        • -
      • Enum description
        • +
      • Enum Declaration
        • +
      • Enum Description
      • Enum Constant Summary
        • -
      • Enum Constant Detail
        • +
      • Enum Constant Details
      +
    • +

      Use

      -

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

      +

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

      +
    • +

      Tree (Class Hierarchy)

      -

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

      • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
        • -
      • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
        • +
      • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
      +
    • +

      Deprecated API

      The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

      +
    • +

      Index

      -

      The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

      -
      • -
    • -

      Prev/Next

      -

      These links take you to the next or previous class, interface, package, or related page.

      -
      • -
    • -

      Frames/No Frames

      -

      These links show and hide the HTML frames. All pages are available with or without frames.

      -
      • -
    • -

      All Classes

      -

      The All Classes link shows all classes and interfaces except non-static nested types.

      +

      The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

      +
    • +

      Serialized Form

      Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

      +
    • +

      Constant Field Values

      The Constant Field Values page lists the static final fields and their values.

      +
      +
      • +
    • +
      +

      Search

      +

      You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camel-case" abbreviations. For example:

      +
        +
      • j.l.obj will match "java.lang.Object"
        • +
      • InpStr will match "java.io.InputStream"
        • +
      • HM.cK will match "java.util.HashMap.containsKey(Object)"
        • +
      +

      Refer to the Javadoc Search Specification for a full description of search features.

      +
    -This help file applies to API documentation generated using the standard doclet.
    +
    +This help file applies to API documentation generated by the standard doclet.
    +
    +
    + +
    +
    +
    diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index 2afc230..34b07c9 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -1,36 +1,42 @@ - + A-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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
    +
    abort() - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    Signals that you wish to abort.
    -
    abort() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo
    +
    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
    +
    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
    +
    abort() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent
    Notifies BulkCaseProcessor that all further processing should be aborted
    -
    abortScan() - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    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.
    -
    acceptCase(Case, CaseInfo, int, int) - Method in interface com.nuix.superutilities.cases.CaseConsumer
    +
    acceptCase(Case, CaseInfo, int, int) - Method in interface com.nuix.superutilities.cases.CaseConsumer
     
    -
    add(String) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    add(int, String) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    add(int, String) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    add(String) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    addAll(Collection<? extends String>) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    addAll(int, Collection<? extends 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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    addColor(int, int, int) - Method in class com.nuix.superutilities.reporting.ColorRing
     
    -
    addEntityNames(Collection<String>) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    addMatch(PatternInfo, String, boolean, String, String, int, int) - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    Adds a match to this instance.
    -
    addMd5(String) - Method in class com.nuix.superutilities.misc.DigestList
    +
    addMd5(byte[]) - Method in class com.nuix.superutilities.misc.DigestList
    Adds the given MD5 to this instance (if not already present).
    -
    addMd5(byte[]) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    addRecord(OptRecord) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    addRowCriterion(NamedQuery) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    AnnotationHistoryRepositorySummary() - Constructor for class com.nuix.superutilities.annotations.AnnotationHistoryRepositorySummary
     
    AnnotationMatchingMethod - Enum in com.nuix.superutilities.annotations
     
    @@ -224,43 +221,43 @@

    A

    This class leverages a SQLite database file to export and import annotations between Nuix cases.
    -
    AnnotationRepository(String) - Constructor for class com.nuix.superutilities.annotations.AnnotationRepository
    +
    AnnotationRepository(File) - Constructor for class com.nuix.superutilities.annotations.AnnotationRepository
    Creates a new instance associated to the specified SQLite DB file.
    -
    AnnotationRepository(File) - Constructor for class com.nuix.superutilities.annotations.AnnotationRepository
    +
    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
    +
    AnnotationSyncSettings() - Constructor for class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    appendRow(List<? extends Object>) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    appendRow(List<? extends Object>) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
     
    -
    appendRow(List<Object>, Style) - 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
    +
    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
    +
    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
    +
    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
    +
    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(String, String, boolean, int) - Method in class com.nuix.superutilities.cases.CaseUtility
    +
    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(File, File, boolean, int) - Method in class com.nuix.superutilities.cases.CaseUtility
    +
    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.
    @@ -268,30 +265,33 @@

    A

    A class containing helper methods for working with Aspose Cells colors.
    -
    AsposeCellsColorHelper() - Constructor for class com.nuix.superutilities.reporting.AsposeCellsColorHelper
    +
    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
    +
    AsposeCellsStyleHelper() - Constructor for class com.nuix.superutilities.reporting.AsposeCellsStyleHelper
     
    -
    autoFitColumns() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    autoFitColumns() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
     
    -
    autoFitRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    autoFitRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index 201c32a..b5b2d48 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -1,36 +1,42 @@ - + J-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    J

    -
    joinByAnd(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    JaroWinkler - com.nuix.superutilities.misc.SimilarityCalculation
    +
     
    +
    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
    +
    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
    +
    JsonExporter() - Constructor for class com.nuix.superutilities.export.JsonExporter
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index 173d1eb..8dd742d 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -1,36 +1,42 @@ - + L-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    L

    -
    lastIndexOf(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    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
    +
    LevenshteinDistance() - Constructor for class com.nuix.superutilities.misc.LevenshteinDistance
     
    -
    listIterator() - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    listIterator() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    listIterator(int) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    listIterator(int) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
     
    +
    LuceneLevenshstein - com.nuix.superutilities.misc.SimilarityCalculation
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 4f6517f..1a6689c 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -1,36 +1,42 @@ - + M-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    M

    -
    makeGuidPath(Item, File, String) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    makeGuidPath(Item, File, String) - Static method in class com.nuix.superutilities.misc.FormatUtility
     
    -
    mapAddress(Address) - Static method in class com.nuix.superutilities.export.JsonExporter
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    markupSetQuery(MarkupSet) - Static method in class com.nuix.superutilities.query.QueryHelper
     
    -
    mergeCols(int, int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    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
    +
    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
    +
    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
    +
    monitorEventOccurred(FreeSpaceMonitor, DriveSpaceInfo) - Method in interface com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index d84062d..f47af4b 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -1,36 +1,42 @@ - + N-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    N

    -
    namedEntityQuery(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    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.
    @@ -83,83 +78,94 @@

    N

    NamedEntityRedactionResults - Class in com.nuix.superutilities.namedentities
     
    -
    NamedEntityRedactionResults() - Constructor for class com.nuix.superutilities.namedentities.NamedEntityRedactionResults
    +
    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).
    + NamedEntityUtility.recordRedactedCopies(nuix.Item, NamedEntityRedactionSettings), + NamedEntityUtility.recordRedactedCopies(Collection, NamedEntityRedactionSettings) and + NamedEntityUtility.recordRedactedCopies(nuix.Case, NamedEntityRedactionSettings).
    -
    NamedEntityRedactionSettings() - Constructor for class com.nuix.superutilities.namedentities.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
    +
    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() - Constructor for class com.nuix.superutilities.reporting.NamedQuery
     
    -
    NamedQuery(String, String) - 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
    +
    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.cases.CaseHistoryHelper
    +
    next() - Method in class com.nuix.superutilities.reporting.ColorRing
     
    -
    next() - Method in class com.nuix.superutilities.reporting.ColorRing
    +
    NGram - com.nuix.superutilities.misc.SimilarityCalculation
     
    -
    notJoinByOr(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index 4e80f1f..f52307b 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -1,36 +1,42 @@ - + O-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    O

    -
    onCaseIsLocked(Consumer<CaseLockedEventInfo>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    +
    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
    +
    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
    +
    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) +
    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
    +
    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
    +
    OptRecord() - Constructor for class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    orTagQuery(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    orTagQuery(String...) - Static method in class com.nuix.superutilities.query.QueryHelper
     
    -
    orTagQuery(String...) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    orTagQuery(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index ab798b6..330ba0a 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -1,36 +1,42 @@ - + P-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    P

    -
    parallelStream() - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    parallelStream() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    parenThenJoinByAnd(Collection<String>) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    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
    +
    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
    +
    parse(String) - Static method in class com.nuix.superutilities.misc.NuixVersion
    Parses a version string into a NuixVersion instance.
    -
    parseFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo
    +
    parseFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo
    Parses a fuzzy term string into component term and similarity score.
    @@ -95,7 +90,7 @@

    P

    Represents a regular expression including associated title.
    -
    PatternInfo(String, String) - Constructor for class com.nuix.superutilities.regex.PatternInfo
    +
    PatternInfo(String, String) - Constructor for class com.nuix.superutilities.regex.PatternInfo
    Create a new instance
    @@ -103,17 +98,17 @@

    P

    A class containing some helper methods for PDFs.
    -
    PdfUtility() - Constructor for class com.nuix.superutilities.misc.PdfUtility
    +
    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
    +
    PdfWorkCache(File) - Constructor for class com.nuix.superutilities.export.PdfWorkCache
    Creates a new instance
    -
    phraseToExpression(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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.
    @@ -122,36 +117,39 @@

    P

    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
    +
    PlaceholderResolver() - Constructor for class com.nuix.superutilities.misc.PlaceholderResolver
     
    ProductionSetEvent - Class in com.nuix.superutilities.annotations
     
    -
    ProductionSetEvent() - Constructor for class com.nuix.superutilities.annotations.ProductionSetEvent
    +
    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() - Constructor for class com.nuix.superutilities.misc.ProfileDigester
     
    -
    ProfileDigester(MetadataProfile) - Constructor for class com.nuix.superutilities.misc.ProfileDigester
    +
    ProfileDigester(MetadataProfile) - Constructor for class com.nuix.superutilities.misc.ProfileDigester
     
    -
    progressUpdated(int, int, NamedEntityRedactionResults) - Method in interface com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback
    +
    progressUpdated(int, int) - Method in interface com.nuix.superutilities.reporting.IntersectionReportProgressCallback
     
    -
    progressUpdated(int, int) - Method in interface com.nuix.superutilities.reporting.IntersectionReportProgressCallback
    +
    progressUpdated(int, int, NamedEntityRedactionResults) - Method in interface com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-16.html b/docs/index-files/index-16.html index 3fe088d..c977856 100644 --- a/docs/index-files/index-16.html +++ b/docs/index-files/index-16.html @@ -1,36 +1,42 @@ - + Q-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    Q

    QueryHelper - Class in com.nuix.superutilities.query
     
    -
    QueryHelper() - Constructor for class com.nuix.superutilities.query.QueryHelper
    +
    QueryHelper() - Constructor for class com.nuix.superutilities.query.QueryHelper
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-17.html b/docs/index-files/index-17.html index bea3562..91fcaf6 100644 --- a/docs/index-files/index-17.html +++ b/docs/index-files/index-17.html @@ -1,36 +1,42 @@ - + R-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    R

    -
    recordRedactedCopies(Item, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    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(Collection<Item>, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    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, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    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(Case, Collection<Item>, NamedEntityRedactionSettings) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    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
    +
    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().
    + 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
    +
    RegexMatch(PatternInfo, String, boolean, String, String, int, int) - Constructor for class com.nuix.superutilities.regex.RegexMatch
    Creates a new instance
    @@ -110,7 +105,7 @@

    R

    Represents information about an error which occurred in RegexScanner while scanning.
    -
    RegexScanError(Item, PatternInfo, String, Exception) - Constructor for class com.nuix.superutilities.regex.RegexScanError
    +
    RegexScanError(Item, PatternInfo, String, Exception) - Constructor for class com.nuix.superutilities.regex.RegexScanError
    Creates a new instance
    @@ -118,113 +113,122 @@

    R

    Class for scanning a series of items with a series of regular expressions.
    -
    RegexScanner() - Constructor for class com.nuix.superutilities.regex.RegexScanner
    +
    RegexScanner() - Constructor for class com.nuix.superutilities.regex.RegexScanner
     
    -
    remove(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    remove(int) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    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
    +
    removeAll(Collection<?>) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    removeDynamicPlaceholder(String) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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
    +
    removeIf(Predicate<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    removeItem(Item) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    removeItems(Collection<Item>) - Method in class com.nuix.superutilities.misc.DigestList
    Removes MD5s from this instance based on the MD5s of the given items.
    -
    removeMd5(String) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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(byte[]) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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) - Method in class com.nuix.superutilities.export.TemplateExporter
     
    -
    render(Item, Map<String, Object>) - 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, 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
    +
    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
    +
    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
    +
    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.AnnotationEvent
     
    -
    replay(Case) - Method in class com.nuix.superutilities.annotations.CustodianEvent
    +
    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.CustomMetadataEvent
     
    -
    replay(Case) - Method in class com.nuix.superutilities.annotations.ExclusionEvent
    +
    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.ItemSetEvent
     
    -
    replay(Case) - Method in class com.nuix.superutilities.annotations.ProductionSetEvent
    +
    replay(Case) - Method in class com.nuix.superutilities.annotations.ProductionSetEvent
     
    -
    replay(Case) - Method in class com.nuix.superutilities.annotations.TagEvent
    +
    replay(Case) - Method in class com.nuix.superutilities.annotations.TagEvent
     
    -
    resolvePlaceholders(String, Map<String, Object>) - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    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
    +
    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
    +
    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
    +
    resolveTemplatePath(String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    Resolves place holders into a path string based on the currently associated values.
    -
    resolveTemplatePathMultiValues(String, List<NamedStringList>) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    resolveTemplatePathMultiValues(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.
    -
    restart() - Method in class com.nuix.superutilities.reporting.ColorRing
    +
    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 +
    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
    +
    retainAll(Collection<?>) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    retry() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo
    +
    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
    +
    retry() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent
    Notifies BulkCaseProcessor that it should try to open this case again
    -
    round(double, int) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    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.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-18.html b/docs/index-files/index-18.html index c474135..89a35d8 100644 --- a/docs/index-files/index-18.html +++ b/docs/index-files/index-18.html @@ -1,36 +1,42 @@ - + S-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    S

    -
    save() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    save() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
     
    -
    saveAs(String) - 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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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).
    -
    scanItems(Collection<Item>) - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    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
    +
    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
    +
    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
    +
    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.
    @@ -131,414 +126,434 @@

    S

    A ColumnValueGenerator which uses the provided BiFunction expression to calculate its value.
    -
    ScriptedColumnValueGenerator(String, BiFunction<Case, String, Object>) - Constructor for class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
    +
    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.
    -
    ScriptedColumnValueGenerator(String, String, BiFunction<Case, String, Object>) - Constructor for class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
    -
     
    -
    secondsToElapsedString(Double) - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    secondsToElapsedString(long) - Method in class com.nuix.superutilities.misc.FormatUtility
    Converts a value representing some number of seconds to an "elapsed" string.
    -
    secondsToElapsedString(long) - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    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(int, String) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    set(String, String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    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
    +
    setAllowCaseMigration(boolean) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    Sets whether Nuix will be allowed to migrate cases as they are opened.
    -
    setApplyHighLights(boolean) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    setApplyRedactions(boolean) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
     
    -
    setAsposeSourcePageRectangle(Rectangle) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setAsposeSourcePageRectangle(Rectangle) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setBox(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    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
    +
    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
    +
    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
    +
    setCaptureContextualText(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setCaseInfo(CaseInfo) - Method in class com.nuix.superutilities.cases.CaseLockInfo
    +
    setCaseInfo(CaseInfo) - Method in class com.nuix.superutilities.cases.CaseLockInfo
     
    -
    setCaseSensitive(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    setCaseSensitive(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setChunkSize(int) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    setChunkSize(int) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setColCategoryColorRing(ColorRing) - Method in class com.nuix.superutilities.reporting.IntersectionReport
    +
    setColCategoryColorRing(ColorRing) - Method in class com.nuix.superutilities.reporting.IntersectionReport
     
    -
    setColCriteria(List<NamedQuery>) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    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
    +
    setColumnLabel(String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
     
    -
    setColumnRemovals(Collection<String>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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
    +
    setConcurrency(int) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setContextSize(int) - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    setContextSize(int) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setCurrent(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
    +
    setCurrent(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
     
    -
    setCurrentRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    setCurrentRow(int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
     
    -
    setCustomMetadataFieldPrefix(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    setCustomMetadataToScan(List<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setDigestCustomField(String) - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    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.
    + ProfileDigester.getRecordDigest() returns true.
    -
    setDynamicPlaceholder(String, BiFunction<Item, String, String>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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(File) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setExportDirectory(String) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    setExportDirectory(String) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setExportXlsx(boolean) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setExportXlsx(boolean) - Method in class com.nuix.superutilities.export.CustomExporter
    Sets whether DAT contents should additionally be exported as an XLSX spreadsheet.
    -
    setExpressions(Collection<String>) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    setFilenamePrefix(String) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setFirstPage(boolean) - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    setFirstPage(boolean) - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    setFolder(String) - 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
    +
    setFreezePanes(boolean) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    Sets whether "freeze panes" will be applied to this sheet.
    -
    setFromItem(Item) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    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
    +
    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
    +
    setGuidRefInsertBatchSize(int) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    setHeaderRenames(Map<String, String>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setHeaderRenames(Map<String, String>) - Method in class com.nuix.superutilities.export.CustomExporter
    Allows you to provide a Map of headers to rename.
    -
    setHeadersOnFirstChunkOnly(boolean) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    setHeadersOnFirstChunkOnly(boolean) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    setHeight(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setHeight(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setHost(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
    +
    setHost(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
     
    -
    setId(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    setId(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    setImagingOptions(Map<?, ?>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setImagingOptions(Map<?, ?>) - 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
    +
    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).
    +
    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
    +
    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
    +
    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
    +
    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).
    +
    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
    +
    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).
    +
    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
    +
    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
    +
    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
    +
    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
    +
    setIntegerInfo(String, Long) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    setItem(Item) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setItem(Item) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setKeepOriginalDat(boolean) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setKeepOriginalDat(boolean) - Method in class com.nuix.superutilities.export.CustomExporter
    Sets whether final DAT will be kept by moving it to final export directory/
    -
    setLabel(String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
    +
    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
    +
    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
    +
    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
    +
    setMatchedTerm(String) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    setMatches(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
    +
    setMatches(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
     
    -
    setMatchNamedEntityValues(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    setMatchNamedEntityValues(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setMaxToStringLength(int) - Static 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
    +
    setMinor(int) - Method in class com.nuix.superutilities.misc.NuixVersion
    Sets the minor portion of this version instance (0.X.0.0)
    -
    setName(String) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    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
    +
    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
    +
    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
    +
    setNamedEntityTypes(Collection<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setOcurrences(long) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    setOcurrences(long) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    setOnlyRecordChanges(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    setOriginalTerm(String) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    setPageNumber(int) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setPageNumber(int) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setPages(int) - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    setPages(int) - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    setParallelProcessingSettings(Map<?, ?>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setParallelProcessingSettings(Map<?, ?>) - Method in class com.nuix.superutilities.export.CustomExporter
    Sets the Map of settings which will be passed to BatchExporter.setParallelProcessingSettings(Map) when performing the temporary export before restructuring.
    -
    setPath(String) - 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
    +
    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.
    +
    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
    +
    setPatterns(List<PatternInfo>) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setPrettyPrint(boolean) - Method in class com.nuix.superutilities.export.JsonExporter
    +
    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
    +
    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.export.ChunkedDATExporter
     
    -
    setProfile(MetadataProfile) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setProfile(MetadataProfile) - Method in class com.nuix.superutilities.export.CustomExporter
    Sets the metadata profile used during export.
    -
    setProfile(MetadataProfile) - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    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
    +
    setPropertiesToScan(List<String>) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setQuery(String) - Method in class com.nuix.superutilities.reporting.NamedQuery
    +
    setQuery(String) - Method in class com.nuix.superutilities.reporting.NamedQuery
    Sets the associated query
    -
    setReaction(CaseIssueReaction) - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo
    +
    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
    +
    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
    +
    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
    +
    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
    +
    setRecords(List<OptRecord>) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    setRecordTimeOfRedaction(boolean) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    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
    +
    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
    +
    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
    +
    setRegenerateStored(boolean) - Method in class com.nuix.superutilities.export.PdfWorkCache
     
    -
    setRowCategoryLabel(String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    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
    +
    setScanContent(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setScanCustomMetadata(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
    +
    setScanProperties(boolean) - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    setScopeQuery(String) - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    setSerializeNulls(boolean) - Method in class com.nuix.superutilities.export.JsonExporter
    Sets whether entries with null value are included in the generated JSON
    -
    setSimilarity(float) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    setSimilarity(float) - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    setSnapshotFirstSync(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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
    +
    setSpecificProperties(Collection<String>) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    Sets list of specific metadata property names to be scanned.
    -
    setStampingOptions(Map<?, ?>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    setStampingOptions(Map<?, ?>) - 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.
    -
    setStyle(int, int, Style) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    setSyncCustodianEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    setSyncCustomMetadataEvents(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
    +
    setSyncExclusionEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    setSyncItemSetEvents(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
    +
    setSyncPoint(DateTime) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    setSyncPointFromDestinationCaseLastEvent(Case) - 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
    +
    setSyncPointToNow() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    setSyncProductionSetEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
    +
    setSyncProductionSetEvents(boolean) - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    setSyncTagEvents(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
    +
    setTargetSimilarity(float) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    setTempDirectory(File) - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    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
    +
    setTerm(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    setText(String) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setText(String) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setTextInfo(String, String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    setTextInfo(String, String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    setTimeOfRedactionFieldName(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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.
    +
    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
    +
    setTotal(int) - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
     
    -
    setUser(String) - Method in class com.nuix.superutilities.cases.CaseLockInfo
    +
    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
    +
    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
    +
    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
    +
    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
    +
    setVolume(String) - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    setWidth(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    setWidth(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    setX(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
    +
    setY(double) - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    shutdownMonitoring() - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor
    +
    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
    +
    signalAbort() - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    Signals that no further processing should be performed after current case.
    @@ -549,11 +564,11 @@

    S

    SimpleTextFileReader - Class in com.nuix.superutilities.loadfiles
     
    -
    SimpleTextFileReader() - Constructor for class com.nuix.superutilities.loadfiles.SimpleTextFileReader
    +
    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
    +
    SimpleTextFileWriter(File) - Constructor for class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
     
    SimpleWorksheet - Class in com.nuix.superutilities.reporting
    @@ -562,39 +577,41 @@

    S

    SimpleXlsx - Class in com.nuix.superutilities.reporting
     
    -
    SimpleXlsx(File) - Constructor for class com.nuix.superutilities.reporting.SimpleXlsx
    +
    SimpleXlsx(File) - Constructor for class com.nuix.superutilities.reporting.SimpleXlsx
     
    -
    SimpleXlsx(String) - 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
    +
    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
    +
    size() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    skipCase() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo
    +
    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
    +
    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
    +
    skipCase() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent
    Notifies BulkCaseProcessor that this case should be skipped in response
    -
    sort(Comparator<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    SkipCase - com.nuix.superutilities.cases.CaseIssueReaction
     
    -
    splitAndMaintainFamilies(Collection<Item>, int, Consumer<Collection<Item>>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    +
    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
    +
    spliterator() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    splitLine(String) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    splitLine(String) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
     
    -
    splitPhrase(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    splitPhrase(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    Splits a string into tokens on whitespace using the regular expression: \s+
    @@ -602,27 +619,27 @@

    S

    Provides a wrapper around a SQLite database.
    -
    SQLiteBacked(File) - Constructor for class com.nuix.superutilities.misc.SQLiteBacked
    +
    SQLiteBacked(File) - Constructor for class com.nuix.superutilities.misc.SQLiteBacked
     
    -
    storeAllMarkupSets(Case) - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    +
    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
    +
    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
    +
    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
    +
    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
    +
    stream() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    subList(int, int) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    subList(int, int) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    SuperItemUtility - Class in com.nuix.superutilities.items
    @@ -633,22 +650,25 @@

    S

    Serves as the entry point to most of the functionality.
    -
    syncHistory(Case, AnnotationSyncSettings) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    syncHistory(Case, AnnotationSyncSettings) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    Records annotation event data to the database file.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-19.html b/docs/index-files/index-19.html index e72fc4c..7ec9a57 100644 --- a/docs/index-files/index-19.html +++ b/docs/index-files/index-19.html @@ -1,36 +1,42 @@ - + T-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    T

    TagEvent - Class in com.nuix.superutilities.annotations
     
    -
    TagEvent() - Constructor for class com.nuix.superutilities.annotations.TagEvent
    +
    TagEvent() - Constructor for class com.nuix.superutilities.annotations.TagEvent
     
    -
    tallyContentTextUdpated() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults
    +
    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().
    +
    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
    +
    tallyUpdatedItem() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults
    -
    Adds 1 to updated item count, as obtained by calling NamedEntityRedactionResults.getUpdatedItemCount().
    +
    Adds 1 to updated item count, as obtained by calling NamedEntityRedactionResults.getUpdatedItemCount().
    -
    tallyUpdatedProperty(String) - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionResults
    +
    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.
    @@ -94,90 +89,93 @@

    T

    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
    +
    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
    +
    TermExpander() - Constructor for class com.nuix.superutilities.misc.TermExpander
     
    -
    termToRegex(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    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() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    toArray(T[]) - 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
    +
    toFile(File) - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    toHeaderLine(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    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
    +
    toHeaderLine(List<String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
     
    -
    tokenizeText(String) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    tokenizeText(String) - Static method in class com.nuix.superutilities.misc.FormatUtility
    Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.
    -
    toLine(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    toLine() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    toLine(String[]) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    toLine(String[]) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
     
    -
    toLine() - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    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.AnnotationHistoryRepositorySummary
     
    -
    toString() - Method in class com.nuix.superutilities.annotations.CustodianEvent
    +
    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.CustomMetadataEvent
     
    -
    toString() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
    +
    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.ItemSetEvent
     
    -
    toString() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    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.ProductionSetEvent
     
    -
    toString() - Method in class com.nuix.superutilities.annotations.TagEvent
    +
    toString() - Method in class com.nuix.superutilities.annotations.TagEvent
     
    -
    toString() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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.cases.CaseLockInfo
     
    -
    toString() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
    +
    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.ExpandedTermInfo
     
    -
    toString() - Method in class com.nuix.superutilities.misc.NuixVersion
    +
    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.namedentities.NamedEntityRedactionResults
    +
    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<LinkedHashMap<String, String>>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    transpose(File, File, Consumer<OptRecord>) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    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
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index 6b883da..8e7f220 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -1,36 +1,42 @@ - + B-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    B

    -
    beforeOpeningCase(Consumer<CaseInfo>) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    +
    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
    +
    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).
    + by JsonExporter.exportItemAsJson(Item, File) or JsonExporter.convertItemToJsonString(Item).
    -
    beginMonitoring() - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor
    +
    beginMonitoring() - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor
    Begins monitoring locations by polling them at intervals.
    -
    buildSettingsSummary() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
    +
    buildSettingsSummary() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    buildSummary() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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
    +
    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
    +
    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
    +
    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).
    +
    Provides settings regarding bulk redaction performed by BulkRedactor.findAndMarkup(Case, BulkRedactorSettings, Collection, int).
    -
    BulkRedactorSettings() - Constructor for class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    BulkRedactorSettings() - Constructor for class com.nuix.superutilities.annotations.BulkRedactorSettings
     
    -
    bytesToDynamicSize(long, int) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-20.html b/docs/index-files/index-20.html index 4d6a580..65d2802 100644 --- a/docs/index-files/index-20.html +++ b/docs/index-files/index-20.html @@ -1,36 +1,42 @@ - + U-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    U

    -
    unionMany(List<Collection<Item>>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    +
    unionMany(List<Collection<Item>>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    Unions multiple collections of items into a single Set of items.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-21.html b/docs/index-files/index-21.html index 4f09bcf..49c5d1a 100644 --- a/docs/index-files/index-21.html +++ b/docs/index-files/index-21.html @@ -1,36 +1,42 @@ - + V-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    V

    -
    valueOf(String) - Static method in enum com.nuix.superutilities.annotations.AnnotationMatchingMethod
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-22.html b/docs/index-files/index-22.html index c15221c..96f9b47 100644 --- a/docs/index-files/index-22.html +++ b/docs/index-files/index-22.html @@ -1,36 +1,42 @@ - + W-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    W

    -
    waterMarkPrintedImages(String, Collection<Item>, String, int, float, float, BiConsumer<Integer, Integer>) - Static method in class com.nuix.superutilities.misc.PdfUtility
    +
    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(File, Collection<Item>, String, int, float, float, BiConsumer<Integer, Integer>) - Static method in class com.nuix.superutilities.misc.PdfUtility
    +
    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
    +
    whenErrorLogged(BiConsumer<String, Item>) - Method in class com.nuix.superutilities.misc.ProfileDigester
    -
    Invoked when an error occurs in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    +
    Invoked when an error occurs in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    -
    whenErrorOccurs(FreeSpaceMonitorEventCallback) - Method in class com.nuix.superutilities.misc.FreeSpaceMonitor
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    whenMessageGenerated(Consumer<String>) - Method in class com.nuix.superutilities.reporting.IntersectionReport
     
    -
    whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    +
    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
    +
    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.misc.ProfileDigester
    +
    whenMessageLogged(Consumer<String>) - Method in class com.nuix.superutilities.misc.ProfileDigester
    -
    Invoked when a message is logged by ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    +
    Invoked when a message is logged by ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    -
    whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    +
    whenProgressUpdated(NamedEntityRedactionProgressCallback) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    -
    Allows you to provide a callback which will be invoked when this instance emits a progress update.
    +
    Registers callback for when this instance signals it has made progress.
    -
    whenProgressUpdated(Consumer<BulkRedactorProgressInfo>) - Method in class com.nuix.superutilities.annotations.BulkRedactor
    +
    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
    +
    whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.misc.ProfileDigester
    -
    Invoked when progress is updated in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    +
    Invoked when progress is updated in ProfileDigester.addItemsToItemSet(Case, String, String, Collection).
    -
    whenProgressUpdated(BiConsumer<Integer, Integer>) - Method in class com.nuix.superutilities.misc.TermExpander
    +
    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) +
    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(NamedEntityRedactionProgressCallback) - Method in class com.nuix.superutilities.namedentities.NamedEntityUtility
    +
    whenProgressUpdated(Consumer<BulkRedactorProgressInfo>) - Method in class com.nuix.superutilities.annotations.BulkRedactor
    -
    Registers callback for when this instance signals it has made progress.
    +
    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
    +
    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.
    -
    whenProgressUpdated(IntersectionReportProgressCallback) - Method in class com.nuix.superutilities.reporting.IntersectionReport
    -
     
    -
    withCase(boolean, Consumer<Case>) - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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
    +
    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
    +
    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
    @@ -164,51 +159,54 @@

    W

    - Current index of the case provided
    - Total number of cases to be iterated
    -
    withEachCase(Case, CaseConsumer) - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    +
    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 + 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
    +
    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
    +
    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
    +
    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
    +
    writeDatLine(String[]) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
     
    -
    writeLine(String) - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
    +
    writeLine(String) - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
     
    -
    writeRecordKeys(LinkedHashMap<String, String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
    +
    writeRecordKeys(LinkedHashMap<String, String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
     
    -
    writeRecordValues(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
    +
    writeValues(List<String>) - Method in class com.nuix.superutilities.loadfiles.DatLoadFileWriter
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-23.html b/docs/index-files/index-23.html index 6efc369..0430e26 100644 --- a/docs/index-files/index-23.html +++ b/docs/index-files/index-23.html @@ -1,36 +1,42 @@ - + Y-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    Y

    -
    yearMonthRangeQuery(int, int) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    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
    +
    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.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-24.html b/docs/index-files/index-24.html index 688d4d1..069d8b1 100644 --- a/docs/index-files/index-24.html +++ b/docs/index-files/index-24.html @@ -1,36 +1,42 @@ - + Z-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    Z

    ZipHelper - Class in com.nuix.superutilities.misc
     
    -
    ZipHelper() - Constructor for class com.nuix.superutilities.misc.ZipHelper
    +
    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 
    +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
    + + +
    + diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 1b9c1d1..cc3481b 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -1,36 +1,42 @@ - + C-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    C

    -
    calculate(String, String) - Static method in class com.nuix.superutilities.misc.LevenshteinDistance
    +
    calculate(String, String) - Static method in class com.nuix.superutilities.misc.LevenshteinDistance
     
    -
    calculateJaroWinklerSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
    +
    calculateJaroWinklerSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    calculateLastDbEventStart() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    calculateLastDbEventStart() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    calculateLuceneLevenshteinSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
    +
    calculateLuceneLevenshteinSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    calculateNGramSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
    +
    calculateNGramSimilarityTo(String) - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    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
    +
    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.
    @@ -96,18 +91,18 @@

    C

    Helper class for iterating a case's history.
    -
    CaseHistoryHelper(Case, List<String>, DateTime, DateTime) - Constructor for class com.nuix.superutilities.cases.CaseHistoryHelper
    +
    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
    +
    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
    +
    CaseInfo(String) - Constructor for class com.nuix.superutilities.cases.CaseInfo
    Creates a new instance associated to the specified case directory.
    @@ -120,7 +115,7 @@

    C

    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
    +
    CaseLockedEventInfo(CaseInfo) - Constructor for class com.nuix.superutilities.cases.CaseLockedEventInfo
    Creates a new instance
    @@ -128,14 +123,14 @@

    C

    Represents information parsed from a case lock file.
    -
    CaseLockInfo() - Constructor for class com.nuix.superutilities.cases.CaseLockInfo
    +
    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
    +
    CaseOpenErrorEvent(CaseInfo, Exception) - Constructor for class com.nuix.superutilities.cases.CaseOpenErrorEvent
    Creates a new instance
    @@ -148,64 +143,64 @@

    C

    Generates a series of DAT loadfiles, based on a metadata profile.
    -
    ChunkedDATExporter() - Constructor for class com.nuix.superutilities.export.ChunkedDATExporter
    +
    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
    +
    ChunkInfo(int) - Constructor for class com.nuix.superutilities.export.ChunkedDATExporter.ChunkInfo
     
    -
    cleanPathString(String) - Static method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    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
    +
    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.NamedStringList
     
    -
    clear() - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    clear() - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    Clears all currently associated place holders (keys and values)
    -
    clearAllDynamicPlaholders() - Method in class com.nuix.superutilities.export.CustomExporter
    +
    clearAllDynamicPlaholders() - Method in class com.nuix.superutilities.export.CustomExporter
    Removes all previously added dynamic placeholders.
    -
    clearColors() - Method in class com.nuix.superutilities.reporting.ColorRing
    +
    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
    +
    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
    +
    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.annotations.AnnotationHistoryRepository
     
    -
    close() - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
    +
    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.misc.SQLiteBacked
     
    -
    close() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    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
    +
    ColorRing() - Constructor for class com.nuix.superutilities.reporting.ColorRing
     
    ColumnValueGenerator - Class in com.nuix.superutilities.reporting
    Base class for reporting.
    -
    ColumnValueGenerator() - Constructor for class com.nuix.superutilities.reporting.ColumnValueGenerator
    +
    ColumnValueGenerator() - Constructor for class com.nuix.superutilities.reporting.ColumnValueGenerator
     
    com.nuix.superutilities - package com.nuix.superutilities
     
    @@ -229,119 +224,124 @@

    C

     
    com.nuix.superutilities.reporting - package com.nuix.superutilities.reporting
     
    -
    combineDigestFiles(File, Collection<File>) - Static method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    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
    +
    compareTo(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion
    Provides comparison logic when comparing two instances.
    -
    compile(boolean) - Method in class com.nuix.superutilities.regex.PatternInfo
    +
    compile(boolean, boolean, boolean) - Method in class com.nuix.superutilities.regex.PatternInfo
    Compiles the regular expression String provided into a Java Pattern object
    -
    compressDirectoryToZipFile(String, String, int) - Static method in class com.nuix.superutilities.misc.ZipHelper
    +
    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
    +
    contains(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    containsAll(Collection<?>) - 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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    createFreeSpaceMonitor() - Method in class com.nuix.superutilities.SuperUtilities
    Creates a new instance of FreeSpaceMonitor.
    -
    createJsonExporter() - Method in class com.nuix.superutilities.SuperUtilities
    +
    createJsonExporter() - Method in class com.nuix.superutilities.SuperUtilities
    Creates a new instance of JsonExporter
    -
    createRegexScanner() - Method in class com.nuix.superutilities.SuperUtilities
    +
    createRegexScanner() - Method in class com.nuix.superutilities.SuperUtilities
    Creates a new instance of RegexScanner
    -
    createStyle() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    createStyle() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
     
    -
    createTemplateExporter(File) - Method in class com.nuix.superutilities.SuperUtilities
    +
    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
    +
    createTemplateExporter(String) - Method in class com.nuix.superutilities.SuperUtilities
    Creates a new instance of TemplateExporter with a template based on the specified file.
    -
    createWaterMarkedPdf(String, String, String, int, float, float) - Static method in class com.nuix.superutilities.misc.PdfUtility
    +
    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(File, File, String, int, float, float) - Static method in class com.nuix.superutilities.misc.PdfUtility
    +
    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.
    CustodianEvent - Class in com.nuix.superutilities.annotations
     
    -
    CustodianEvent() - Constructor for class com.nuix.superutilities.annotations.CustodianEvent
    +
    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
    +
    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
    +
    CustomMetadataEvent() - Constructor for class com.nuix.superutilities.annotations.CustomMetadataEvent
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 316c245..85fa1ee 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -1,36 +1,42 @@ - + D-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    D

    DatLoadFile - Class in com.nuix.superutilities.loadfiles
     
    -
    DatLoadFile() - Constructor for class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    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
    +
    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
    +
    DatLoadFileWriter(File) - Constructor for class com.nuix.superutilities.loadfiles.DatLoadFileWriter
     
    -
    debugString(Map<String, ?>) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    debugString(Exception) - Static method in class com.nuix.superutilities.misc.FormatUtility
     
    -
    debugString(Exception) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    debugString(Map<String, ?>) - Static method in class com.nuix.superutilities.misc.FormatUtility
     
    -
    deduplicateCustomTieBreaker(Collection<Item>, BiFunction<Item, Item, Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    +
    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.
    @@ -97,36 +92,39 @@

    D

    This class provides an in-memory representation of a Nuix binary digest list.
    -
    DigestList() - Constructor for class com.nuix.superutilities.misc.DigestList
    +
    DigestList() - Constructor for class com.nuix.superutilities.misc.DigestList
    Creates a new empty instance.
    -
    DigestList(File...) - Constructor for class com.nuix.superutilities.misc.DigestList
    +
    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.
    + 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
    +
    DriveSpaceInfo(String) - Constructor for class com.nuix.superutilities.misc.DriveSpaceInfo
    Creates a new instance for the specified file path.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index fe0f2eb..e42631b 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -1,36 +1,42 @@ - + E-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    E

    -
    eachCell(int, int, int, int, Consumer<Cell>) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    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(long, Consumer<CustodianEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedCustodianEvent(DateTime, 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(long, Consumer<CustomMetadataEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedCustomMetadataEvent(DateTime, 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(long, Consumer<ExclusionEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedExclusionEvent(DateTime, 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(long, Consumer<ItemSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedItemSetEvent(DateTime, 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(long, Consumer<ProductionSetEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedProductionSetEvent(DateTime, 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(long, Consumer<TagEvent>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    eachRecordedTagEvent(DateTime, 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
    +
    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.
    -
    equals(Object) - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    equals(Object) - Method in class com.nuix.superutilities.cases.CaseInfo
     
    -
    equals(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    equals(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    escapeForSearch(String) - Static method in class com.nuix.superutilities.query.QueryHelper
    +
    escapeForSearch(String) - Static method in class com.nuix.superutilities.query.QueryHelper
     
    -
    escapeRegexSpecialCharacters(String) - Static method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    ExclusionEvent() - Constructor for class com.nuix.superutilities.annotations.ExclusionEvent
     
    -
    executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    -
     
    -
    executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    Executes an insert query against the SQLite database file
    -
    executeInsert(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    executeInsert(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    Executes an insert query against the SQLite database file
    -
    executeLongScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    -
     
    -
    executeLongScalar(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    -
     
    -
    executeLongScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    executeLongScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    executeLongScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    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, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    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) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    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
    +
    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
    +
    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
    +
    executeScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    executeStringScalar(String, Object...) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    executeScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked
     
    -
    executeStringScalar(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    executeStringScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    executeStringScalar(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    -
     
    -
    executeStringScalar(String, Object...) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    executeStringScalar(String) - 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.misc.SQLiteBacked
    +
    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) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    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, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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.annotations.AnnotationHistoryRepository
     
    -
    executeUpdate(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    -
     
    -
    executeUpdate(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    executeUpdate(String, Object...) - 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.misc.SQLiteBacked
    +
    executeUpdate(String, List<Object>) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    Executes an update query against the SQLite database file
    -
    executeUpdate(String) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    +
    executeUpdate(String, List<Object>) - Method in class com.nuix.superutilities.misc.SQLiteBacked
    Executes an update query against the SQLite database file
    @@ -208,66 +205,69 @@

    E

    Encapsulates information about a term designated as a match result generated by TermExpander.
    -
    ExpandedTermInfo() - Constructor for class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    ExpandedTermInfo() - Constructor for class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    expandTerm(Case, String) - Method in class com.nuix.superutilities.misc.TermExpander
    +
    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) - Method in class com.nuix.superutilities.misc.TermExpander
    +
    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, boolean, boolean, String, String) - Method in class com.nuix.superutilities.misc.TermExpander
    +
    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
    +
    export(List<Item>) - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    exportItemAsJson(Item, File) - Method in class com.nuix.superutilities.export.JsonExporter
    +
    exportItemAsJson(Item, File) - Method in class com.nuix.superutilities.export.JsonExporter
    Exports an item as a JSON representation.
    -
    exportItems(Case, String, List<Item>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    exportItems(Case, File, List<Item>) - Method in class com.nuix.superutilities.export.CustomExporter
    Exports given items in custom structure.
    -
    exportItems(Case, File, List<Item>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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
    +
    exportJson(String) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportJson(String, JsonExporter) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    exportJson(String, JsonExporter) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportNatives(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    exportNatives(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportPdfs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    exportPdfs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportSourceItemAsJson(SourceItem, File) - Method in class com.nuix.superutilities.export.JsonExporter
    +
    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
    +
    exportText(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportTiffs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
    +
    exportTiffs(String, Map<String, Object>) - Method in class com.nuix.superutilities.export.CustomExporter
     
    -
    exportWorkerItemAsJson(WorkerItem, File) - Method in class com.nuix.superutilities.export.JsonExporter
    +
    exportWorkerItemAsJson(WorkerItem, File) - Method in class com.nuix.superutilities.export.JsonExporter
    Exports a worker item as a JSON representation.
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index afc1e04..3349f79 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -1,36 +1,42 @@ - + F-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    F

    -
    findAndMarkup(Case, BulkRedactorSettings, Collection<Item>) - Method in class com.nuix.superutilities.annotations.BulkRedactor
    +
    findAndMarkup(Case, BulkRedactorSettings, Collection<Item>, int) - Method in class com.nuix.superutilities.annotations.BulkRedactor
    Finds text in PDFs of given items.
    -
    findCaseDirectories(File) - Method in class com.nuix.superutilities.cases.CaseUtility
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    findContainerAncestors(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    -
    Similar to findContainerAncestor(Item), but resolves nearest container ancestor items +
    Similar to 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
    +
    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.
    -
    findMatchingItems(Case, int) - Method in class com.nuix.superutilities.misc.DigestList
    +
    findFamiliesWithoutItemsResponsiveToQuery(Case, Collection<Item>, String) - Method in class com.nuix.superutilities.items.SuperItemUtility
    +
     
    +
    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) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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.
    -
    findPhysicalFileAncestor(Item) - Method in class com.nuix.superutilities.items.SuperItemUtility
    +
    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
    +
    findPhysicalFileAncestors(Collection<Item>) - Method in class com.nuix.superutilities.items.SuperItemUtility
    -
    Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items +
    Similar to findPhysicalFileAncestor(Item), but resolves physical file ancestor items for multiple items at once.
    -
    forEach(Consumer<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    forEach(Consumer<? super String>) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    forgetItem(Item) - Method in class com.nuix.superutilities.export.PdfWorkCache
    +
    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
    +
    formatAsTextualTable(List<List<String>>) - Static method in class com.nuix.superutilities.misc.FormatUtility
     
    -
    formatNumber(int) - 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(long) - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    formatNumber(int) - Method in class com.nuix.superutilities.misc.FormatUtility
    Convenience method for formatting numeric value using US locale.
    -
    formatNumber(double) - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    formatNumber(long) - Method in class com.nuix.superutilities.misc.FormatUtility
    Convenience method for formatting numeric value using US locale.
    @@ -164,46 +166,49 @@

    F

    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
    +
    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
    +
    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
    +
    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(String) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
    +
    fromFile(File) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    fromFile(File) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
    +
    fromFile(String) - Static method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    fromLine(String[], String) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    fromLine(String) - Static method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    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
    +
    FuzzyTermInfo() - Constructor for class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 7712218..16f6461 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -1,36 +1,42 @@ - + G-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    G

    -
    generate(Case, String, IntersectionReportSheetConfiguration) - Method in class com.nuix.superutilities.reporting.IntersectionReport
    +
    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
    +
    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
    +
    generateMd5String(Item) - Method in class com.nuix.superutilities.misc.ProfileDigester
    Generates MD5 digest hex string for a given item.
    -
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
    +
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
     
    -
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
    +
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
     
    -
    get(int) - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    get(int) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    get(String) - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    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
    +
    getAccessedDateTime() - Method in class com.nuix.superutilities.cases.CaseInfo
    The case last accessed date time.
    -
    getAccessedDateTimeString() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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.CustomMetadataEvent
     
    -
    getAdded() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
    +
    getAdded() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
     
    -
    getAdded() - Method in class com.nuix.superutilities.annotations.TagEvent
    +
    getAdded() - Method in class com.nuix.superutilities.annotations.TagEvent
     
    -
    getAllowCaseMigration() - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    +
    getAllowCaseMigration() - Method in class com.nuix.superutilities.cases.BulkCaseProcessor
    Gets whether Nuix will be allowed to migrate cases as they are opened.
    -
    getApplyHighLights() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    getApplyRedactions() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
     
    -
    getAsposeSourcePageRectangle() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getAsposeSourcePageRectangle() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getAsposeWorkbook() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    getAsposeWorkbook() - Method in class com.nuix.superutilities.reporting.SimpleXlsx
     
    -
    getAsposeWorksheet() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    getAssigned() - Method in class com.nuix.superutilities.annotations.CustodianEvent
     
    -
    getAssociatedItems(Case) - Method in class com.nuix.superutilities.annotations.AnnotationEvent
    +
    getAssociatedItems(Case) - Method in class com.nuix.superutilities.annotations.AnnotationEvent
     
    -
    getBatchName() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
    +
    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
    +
    getBox() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    getBugfix() - Method in class com.nuix.superutilities.misc.NuixVersion
    +
    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
    +
    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
    +
    getBulkAnnotater() - Static method in class com.nuix.superutilities.SuperUtilities
    Convenience method to obtain Nuix BulkAnnotater
    -
    getCaptureContextualText() - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    getCaptureContextualText() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getCaseDirectory() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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
    +
    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
    +
    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.CaseLockInfo
     
    -
    getCaseInfo() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent
    +
    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
    +
    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
    +
    getCaseSensitive() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getCaseUtility() - Method in class com.nuix.superutilities.SuperUtilities
    +
    getCaseUtility() - Method in class com.nuix.superutilities.SuperUtilities
    Gets singleton of CaseUtility
    -
    getCell(int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    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
    +
    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
    +
    getChunkSize() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    getColCategoryColorRing() - Method in class com.nuix.superutilities.reporting.IntersectionReport
    +
    getColCategoryColorRing() - Method in class com.nuix.superutilities.reporting.IntersectionReport
     
    -
    getColCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    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
    +
    getColumnLabel() - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
     
    -
    getConcurrency() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    getConcurrency() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    getContentMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    +
    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
    +
    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
    +
    getContextSize() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getContextualSubString(CharSequence, int, int, int) - Static 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
    +
    getCreationDateTime() - Method in class com.nuix.superutilities.cases.CaseInfo
    The case creation date time.
    -
    getCreationDateTimeString() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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() - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
     
    -
    getCurrent() - Static method in class com.nuix.superutilities.misc.NuixVersion
    +
    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
    +
    getCurrentRow() - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
     
    -
    getCurrentVersion() - Static method in class com.nuix.superutilities.SuperUtilities
    +
    getCurrentVersion() - Static method in class com.nuix.superutilities.SuperUtilities
    -
    Gets NuixVersion object representing version of Nuix passed into SuperUtilities.init(Utilities, String)
    +
    Gets NuixVersion object representing version of Nuix passed into SuperUtilities.init(Utilities, String)
    -
    getCustodian() - Method in class com.nuix.superutilities.annotations.CustodianEvent
    +
    getCustodian() - Method in class com.nuix.superutilities.annotations.CustodianEvent
     
    -
    getCustomMetadataFieldPrefix() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    getCustomMetadataToScan() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getDestinationFile() - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
    +
    getDestinationFile() - Method in class com.nuix.superutilities.loadfiles.SimpleTextFileWriter
     
    -
    getDigestCount(File) - Static method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    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.
    + ProfileDigester.getRecordDigest() returns true.
    -
    getEarliestEventStart(Case) - Static method in class com.nuix.superutilities.cases.CaseHistoryHelper
    +
    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
    +
    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
    +
    getError() - Method in class com.nuix.superutilities.cases.CaseOpenErrorEvent
    Gets the exception which was thrown
    -
    getError() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent
    +
    getError() - Method in class com.nuix.superutilities.cases.WorkFunctionErrorEvent
    Gets the exception thrown
    -
    getError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
    +
    getError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    getException() - Method in class com.nuix.superutilities.regex.RegexScanError
    +
    getException() - Method in class com.nuix.superutilities.regex.RegexScanError
    Gets the associated exception
    -
    getExcluded() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
    +
    getExcluded() - Method in class com.nuix.superutilities.annotations.ExclusionEvent
     
    -
    getExclusionName() - 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
    +
    getExpectedItemCount() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
     
    -
    getExportDirectory() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    getExportDirectory() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    getExportXlsx() - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    getFieldName() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
     
    -
    getFilenamePrefix() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    getFilenamePrefix() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    getFilenameTimestamp() - Method in class com.nuix.superutilities.misc.FormatUtility
    +
    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
    +
    getFirstPageRecords() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    getFolder() - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    getFolder() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    getFormatUtility() - Method in class com.nuix.superutilities.SuperUtilities
    +
    getFormatUtility() - Method in class com.nuix.superutilities.SuperUtilities
    Gets singleton of FormatUtility
    -
    getFreeBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
    +
    getFreeBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    getFreeGigaBytes() - 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
    +
    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
    +
    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
    +
    getGuid() - Method in class com.nuix.superutilities.cases.CaseInfo
    The case GUID of this case.
    -
    getGuidRefInsertBatchSize() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    getGuidRefInsertBatchSize() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    getHeadersFromRecord(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
    +
    getHeadersFromRecord(LinkedHashMap<String, String>) - Static method in class com.nuix.superutilities.loadfiles.DatLoadFile
     
    -
    getHeadersOnFirstChunkOnly() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
    +
    getHeadersOnFirstChunkOnly() - Method in class com.nuix.superutilities.export.ChunkedDATExporter
     
    -
    getHeight() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getHeight() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getHost() - Method in class com.nuix.superutilities.cases.CaseLockInfo
    +
    getHost() - Method in class com.nuix.superutilities.cases.CaseLockInfo
     
    -
    getHtmlText(String) - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    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
    +
    getId() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    getIncludeChildGuids() - Method in class com.nuix.superutilities.export.JsonExporter
    +
    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).
    +
    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
    +
    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
    +
    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
    +
    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).
    +
    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
    +
    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).
    +
    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
    +
    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
    +
    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
    +
    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.cases.CaseUtility
     
    -
    getInstance() - Static method in class com.nuix.superutilities.items.SuperItemUtility
    +
    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.misc.FormatUtility
     
    -
    getInstance() - Static method in class com.nuix.superutilities.SuperUtilities
    +
    getInstance() - Static method in class com.nuix.superutilities.SuperUtilities
    Obtains singleton of this class.
    -
    getIntegerInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    getIntegerInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    getInvestigator() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    getInvestigator() - Method in class com.nuix.superutilities.cases.CaseInfo
    The investigator value.
    -
    getItem() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getItem() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getItem(Case) - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    +
    getItem(Case) - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    Gets the associated item.
    -
    getItem(Case) - Method in class com.nuix.superutilities.regex.RegexScanError
    +
    getItem(Case) - Method in class com.nuix.superutilities.regex.RegexScanError
    Gets the associated item
    -
    getItemGuid() - Method in class com.nuix.superutilities.regex.RegexScanError
    +
    getItemGuid() - Method in class com.nuix.superutilities.regex.RegexScanError
     
    -
    getItemId(Item) - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    +
    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
    +
    getItemMarkupCount() - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    Gets the number of markups present in the ItemMarkup table.
    -
    getItemSetName() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
    +
    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
     
    -
    getJarDirectory() - Method in class com.nuix.superutilities.SuperUtilities
    +
    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
    +
    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
    +
    getJarFile() - Method in class com.nuix.superutilities.SuperUtilities
    Get file path of SuperUtilities.jar
    -
    getJarFilePath() - Method in class com.nuix.superutilities.SuperUtilities
    +
    getJarFilePath() - Method in class com.nuix.superutilities.SuperUtilities
    Get file path of SuperUtilities.jar
    -
    getKeepOriginalDat() - Method in class com.nuix.superutilities.export.CustomExporter
    +
    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
    +
    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
    +
    getLastUpdated() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    getLatestEventStart(Case) - Static method in class com.nuix.superutilities.cases.CaseHistoryHelper
    +
    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
    +
    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
    +
    getLocation() - Method in class com.nuix.superutilities.regex.RegexScanError
    Gets the associated location
    -
    getLockProperties() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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
    +
    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
    +
    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).
    +
    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
    +
    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
    +
    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
    +
    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
    +
    getMatchedTerm() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    getMatchEnd() - Method in class com.nuix.superutilities.regex.RegexMatch
    +
    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.annotations.BulkRedactorProgressInfo
     
    -
    getMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    +
    getMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    Gets the matches associated.
    -
    getMatchNamedEntityValues() - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    getMatchNamedEntityValues() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getMatchStart() - Method in class com.nuix.superutilities.regex.RegexMatch
    +
    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
    +
    getMinor() - Method in class com.nuix.superutilities.misc.NuixVersion
    Gets the determined minor portion of this version instance (0.X.0.0)
    -
    getName() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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.misc.NamedStringList
     
    -
    getName() - Method in class com.nuix.superutilities.reporting.NamedQuery
    +
    getName() - Method in class com.nuix.superutilities.reporting.NamedQuery
    Gets the associated name
    -
    getNamedEntityTypes() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    getNamedEntityTypes() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getNuixUtilities() - Method in class com.nuix.superutilities.SuperUtilities
    +
    getNuixUtilities() - Method in class com.nuix.superutilities.SuperUtilities
    Gets the underlying regular API utilities object
    -
    getOcurrences() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    getOcurrences() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    getOnlyRecordChanges() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    getOrCreateRelatedItemSet(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
     
    -
    getOriginalTerm() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    getOriginalTerm() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    getPageNumber() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getPageNumber() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getPages() - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    getPages() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    getPath() - 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
    +
    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
    +
    getPattern() - Method in class com.nuix.superutilities.regex.PatternInfo
    Gets the compiled Pattern object.
    -
    getPatternInfo() - Method in class com.nuix.superutilities.regex.RegexMatch
    +
    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
    +
    getPatternInfo() - Method in class com.nuix.superutilities.regex.RegexScanError
    Gets the associated pattern info
    -
    getPatterns() - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    getPatterns() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getPdfPath(Item) - Method in class com.nuix.superutilities.export.PdfWorkCache
    +
    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
    +
    getPhysicalAncestorPath(Item) - Method in class com.nuix.superutilities.items.SuperItemUtility
    Returns the file system path of an item's physical file ancestor.
    -
    getPlaceholderData() - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    +
    getPlaceholderData() - Method in class com.nuix.superutilities.misc.PlaceholderResolver
    Gets the Map containing all the current place holder data
    -
    getPrettyPrint() - Method in class com.nuix.superutilities.export.JsonExporter
    +
    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
    +
    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.export.ChunkedDATExporter
     
    -
    getProfile() - Method in class com.nuix.superutilities.export.CustomExporter
    +
    getProfile() - Method in class com.nuix.superutilities.export.CustomExporter
    Gets the metadata profile which will be used during export.
    -
    getProfile() - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    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
    +
    getPropertiesToScan() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getPropertyMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    +
    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
    +
    getQuery() - Method in class com.nuix.superutilities.reporting.NamedQuery
    Gets the associated query
    -
    getReaction() - Method in class com.nuix.superutilities.cases.CaseLockedEventInfo
    +
    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
    +
    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
    +
    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
    +
    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
    +
    getRecords() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    getRecordTimeOfRedaction() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    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
    +
    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
    +
    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
    +
    getRegenerateStored() - Method in class com.nuix.superutilities.export.PdfWorkCache
     
    -
    getRelatedItemSet(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
    +
    getRelatedItemSet(Case) - Method in class com.nuix.superutilities.annotations.ItemSetEvent
     
    -
    getRowCategoryLabel() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    getRowCategoryLabel() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    Gets the overall row category label.
    -
    getRowCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    getSavedByName() - Method in class com.nuix.superutilities.cases.CaseInfo
    The saved by name.
    -
    getSavedByVersion() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    getSavedByVersion() - Method in class com.nuix.superutilities.cases.CaseInfo
    The saved by version.
    -
    getScanContent() - Method in class com.nuix.superutilities.regex.RegexScanner
    +
    getScanContent() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getScanCustomMetadata() - 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
    +
    getScanProperties() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    -
    getScopeQuery() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    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
    +
    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
    +
    getSettings() - Method in class com.nuix.superutilities.annotations.ItemSetEvent
     
    -
    getSheet(String) - Method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    getSheet(String) - Method in class com.nuix.superutilities.reporting.SimpleXlsx
     
    -
    getSimilarity() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
    +
    getSimilarity() - Method in class com.nuix.superutilities.misc.ExpandedTermInfo
     
    -
    getSnapshotFirstSync() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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
    +
    getSourceRepo() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
     
    -
    getSpecificProperties() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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
    +
    getSuperItemUtility() - Method in class com.nuix.superutilities.SuperUtilities
    Gets singleton of SuperItemUtility
    -
    getSyncCustodianEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
    +
    getSyncCustodianEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    getSyncCustomMetadataEvents() - 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
    +
    getSyncExclusionEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    getSyncItemSetEvents() - 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
    +
    getSyncProductionSetEvents() - Method in class com.nuix.superutilities.annotations.AnnotationSyncSettings
     
    -
    getSyncTagEvents() - 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
    +
    getTag() - Method in class com.nuix.superutilities.annotations.TagEvent
     
    -
    getTagId(String) - Method in class com.nuix.superutilities.annotations.AnnotationRepository
    +
    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
    +
    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
    +
    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
    +
    getTargetSimilarity() - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    getTempDirectory() - Method in class com.nuix.superutilities.annotations.BulkRedactorSettings
    +
    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
    +
    getTerm() - Method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    getText() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getText() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getTextInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    getTextInfo(String) - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
     
    -
    getTimeOfRedactionFieldName() - Method in class com.nuix.superutilities.namedentities.NamedEntityRedactionSettings
    +
    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.
    +
    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
    +
    getTimeStamp() - Method in class com.nuix.superutilities.annotations.AnnotationEvent
     
    -
    getTint(int, int, int, float) - Static method in class com.nuix.superutilities.reporting.AsposeCellsColorHelper
    +
    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
    +
    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
    +
    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
    +
    getTotal() - Method in class com.nuix.superutilities.annotations.BulkRedactorProgressInfo
     
    -
    getTotalBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
    +
    getTotalBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    getTotalEventCount() - Method in class com.nuix.superutilities.annotations.AnnotationHistoryRepository
    +
    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
    +
    getTotalGigaBytes() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    getUnitBase() - Static method in class com.nuix.superutilities.misc.FormatUtility
    +
    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
    +
    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
    +
    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
    +
    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.
    -
    getUser() - Method in class com.nuix.superutilities.cases.CaseLockInfo
    +
    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
    +
    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.annotations.CustomMetadataEvent
     
    -
    getValue() - Method in class com.nuix.superutilities.regex.RegexMatch
    +
    getValue() - Method in class com.nuix.superutilities.regex.RegexMatch
    Gets the matched value
    -
    getValue(int, int) - Method in class com.nuix.superutilities.reporting.SimpleWorksheet
    +
    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
    +
    getValueAsByteArray() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
     
    -
    getValueAsDateTime() - 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
    +
    getValueAsDouble() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
     
    -
    getValueAsInteger() - 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
    +
    getValueAsLong() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
     
    -
    getValueAsString() - 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
    +
    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
    +
    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
    +
    getValueType() - Method in class com.nuix.superutilities.annotations.CustomMetadataEvent
    +
     
    +
    getVolume() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    getVolume() - Method in class com.nuix.superutilities.loadfiles.OptRecord
    +
    getVolumeNames() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
     
    -
    getVolumeNames() - Method in class com.nuix.superutilities.loadfiles.OptLoadFile
    +
    getWidth() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
     
    -
    getWidth() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    getX() - 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
     
    -
    getY() - Method in class com.nuix.superutilities.annotations.NuixImageAnnotationRegion
    +
    GUID - com.nuix.superutilities.annotations.AnnotationMatchingMethod
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + + + diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index ec8206e..a4fc083 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -1,36 +1,42 @@ - + H-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    H

    -
    hadError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
    +
    hadError() - Method in class com.nuix.superutilities.misc.DriveSpaceInfo
     
    -
    hashCode() - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    hasBatchLoadDateCriteria() - Method in class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
     
    -
    hashCode() - Method in class com.nuix.superutilities.misc.NamedStringList
    +
    hashCode() - Method in class com.nuix.superutilities.cases.CaseInfo
     
    -
    hasNext() - Method in class com.nuix.superutilities.cases.CaseHistoryHelper
    +
    hashCode() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    hasNext() - Method in class com.nuix.superutilities.reporting.ColorRing
    +
    hasNext() - Method in class com.nuix.superutilities.cases.CaseHistoryHelper
     
    -
    hasSameGuidAs(Case) - Method in class com.nuix.superutilities.cases.CaseInfo
    +
    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
    +
    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, File) - Static method in class com.nuix.superutilities.export.TemplateExporter
     
    -
    htmlToPdf(String, String) - Static method in class com.nuix.superutilities.export.TemplateExporter
    +
    htmlToPdf(String, String) - Static method in class com.nuix.superutilities.export.TemplateExporter
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index f4a6f6a..80aeffa 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -1,36 +1,42 @@ - + I-Index + + + + + + + + + - - + + +
    + +
    +
    +
    +

    Index

    +
    +
    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

    I

    -
    importCaseLevelDigestList(Case, String) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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(String) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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(File) - Method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    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
    +
    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
    +
    indexOf(Object) - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    init(Utilities, String) - Static method in class com.nuix.superutilities.SuperUtilities
    +
    init(Utilities, String) - Static method in class com.nuix.superutilities.SuperUtilities
    Initializes this class.
    -
    initializeAspose() - Static method in class com.nuix.superutilities.reporting.SimpleXlsx
    +
    initializeAspose() - Static method in class com.nuix.superutilities.reporting.SimpleXlsx
     
    IntersectionReport - Class in com.nuix.superutilities.reporting
    This class generates an "intersection report".
    -
    IntersectionReport(String) - Constructor for class com.nuix.superutilities.reporting.IntersectionReport
    +
    IntersectionReport(String) - Constructor for class com.nuix.superutilities.reporting.IntersectionReport
    Creates a new instance
    @@ -113,55 +108,55 @@

    I

     
    IntersectionReportSheetConfiguration - Class in com.nuix.superutilities.reporting
     
    -
    IntersectionReportSheetConfiguration() - Constructor for class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
    +
    IntersectionReportSheetConfiguration() - Constructor for class com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration
     
    -
    isAtLeast(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion
    +
    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
    +
    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
    +
    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
    +
    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
    +
    isEmpty() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -
    isEqualTo(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion
    +
    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
    +
    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
    +
    isFirstPage() - Method in class com.nuix.superutilities.loadfiles.OptRecord
     
    -
    isFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo
    +
    isFuzzyTerm(String) - Static method in class com.nuix.superutilities.misc.FuzzyTermInfo
     
    -
    isGreaterThan(NuixVersion) - Method in class com.nuix.superutilities.misc.NuixVersion
    +
    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
    +
    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
    +
    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
    +
    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
    +
    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.
    @@ -170,38 +165,41 @@

    I

    Represents an item and the associated regular expression matches made against it.
    -
    ItemRegexMatchCollection(Item) - Constructor for class com.nuix.superutilities.regex.ItemRegexMatchCollection
    +
    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
    +
    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
    +
    ItemSetEvent() - Constructor for class com.nuix.superutilities.annotations.ItemSetEvent
     
    -
    iterator() - Method in class com.nuix.superutilities.misc.DigestList
    +
    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
    +
    iterator() - Method in class com.nuix.superutilities.misc.NamedStringList
     
    -A B C D E F G H I J L M N O P Q R S T U V W Y Z 
    +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
    + + +
    + diff --git a/docs/index.html b/docs/index.html index 6ed0808..5fd726e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,75 +1,153 @@ - + -Generated Documentation (Untitled) - +Overview + + + + + + + + + + + - - - - - - - +<body class="package-index"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> - - +
    + +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Packages 
    PackageDescription
    com.nuix.superutilities 
    com.nuix.superutilities.annotations 
    com.nuix.superutilities.cases 
    com.nuix.superutilities.export 
    com.nuix.superutilities.items 
    com.nuix.superutilities.loadfiles 
    com.nuix.superutilities.misc 
    com.nuix.superutilities.namedentities 
    com.nuix.superutilities.query 
    com.nuix.superutilities.regex 
    com.nuix.superutilities.reporting 
    +
    +
    +
    + +
    +
    + diff --git a/docs/member-search-index.js b/docs/member-search-index.js new file mode 100644 index 0000000..1667147 --- /dev/null +++ b/docs/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"com.nuix.superutilities.cases","c":"CaseIssueReaction","l":"Abort"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"abort()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"abort()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"abort()"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"abort()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"abortScan()"},{"p":"com.nuix.superutilities.cases","c":"CaseConsumer","l":"acceptCase(Case, CaseInfo, int, int)","url":"acceptCase(nuix.Case,com.nuix.superutilities.cases.CaseInfo,int,int)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"add(int, String)","url":"add(int,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"add(String)","url":"add(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"addAll(Collection)","url":"addAll(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"addAll(int, Collection)","url":"addAll(int,java.util.Collection)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"addAllBuiltInEntities()"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"addCaseDirectory(File)","url":"addCaseDirectory(java.io.File)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"addCaseDirectory(String)","url":"addCaseDirectory(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"addColCriterion(NamedQuery)","url":"addColCriterion(com.nuix.superutilities.reporting.NamedQuery)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"addColCriterion(String, String)","url":"addColCriterion(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"addColor(int, int, int)","url":"addColor(int,int,int)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"addEntityNames(Collection)","url":"addEntityNames(java.util.Collection)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"addExpression(String)","url":"addExpression(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"addItem(Item)","url":"addItem(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"addItems(Collection)","url":"addItems(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"addItemsToItemSet(Case, String, String, Collection)","url":"addItemsToItemSet(nuix.Case,java.lang.String,java.lang.String,java.util.Collection)"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"addMatch(PatternInfo, String, boolean, String, String, int, int)","url":"addMatch(com.nuix.superutilities.regex.PatternInfo,java.lang.String,boolean,java.lang.String,java.lang.String,int,int)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"addMd5(byte[])"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"addMd5(String)","url":"addMd5(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"addMonitoredLocation(String, double)","url":"addMonitoredLocation(java.lang.String,double)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"addNamedEntity(String)","url":"addNamedEntity(java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"addPattern(String, String)","url":"addPattern(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"addPhrase(String)","url":"addPhrase(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"addPhrases(Collection)","url":"addPhrases(java.util.Collection)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"addRecord(OptRecord)","url":"addRecord(com.nuix.superutilities.loadfiles.OptRecord)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"addRowCriterion(NamedQuery)","url":"addRowCriterion(com.nuix.superutilities.reporting.NamedQuery)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"addRowCriterion(String, String)","url":"addRowCriterion(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"addScriptedValueGenerator(String, BiFunction)","url":"addScriptedValueGenerator(java.lang.String,java.util.function.BiFunction)"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"addTintSeries(Color, int)","url":"addTintSeries(com.aspose.cells.Color,int)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"AnnotationEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"AnnotationHistoryRepository(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"AnnotationHistoryRepository(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepositorySummary","l":"AnnotationHistoryRepositorySummary()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"AnnotationRepository(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"AnnotationRepository(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"AnnotationSyncSettings()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"appendRow(List)","url":"appendRow(java.util.List)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"appendRow(List, Style)","url":"appendRow(java.util.List,com.aspose.cells.Style)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"applyHighlight(MarkupSet)","url":"applyHighlight(nuix.MarkupSet)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"applyMarkupsFromDatabaseToCase(Case, boolean, AnnotationMatchingMethod)","url":"applyMarkupsFromDatabaseToCase(nuix.Case,boolean,com.nuix.superutilities.annotations.AnnotationMatchingMethod)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"applyRedaction(MarkupSet)","url":"applyRedaction(nuix.MarkupSet)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"applyTagsFromDatabaseToCase(Case, AnnotationMatchingMethod)","url":"applyTagsFromDatabaseToCase(nuix.Case,com.nuix.superutilities.annotations.AnnotationMatchingMethod)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"archiveCase(File, File, boolean, int)","url":"archiveCase(java.io.File,java.io.File,boolean,int)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"archiveCase(String, String, boolean, int)","url":"archiveCase(java.lang.String,java.lang.String,boolean,int)"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsColorHelper","l":"AsposeCellsColorHelper()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsStyleHelper","l":"AsposeCellsStyleHelper()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"autoFitColumns()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"autoFitRow(int)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"beforeOpeningCase(Consumer)","url":"beforeOpeningCase(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"beforeSerialization(Consumer>)","url":"beforeSerialization(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"beginMonitoring()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"buildSettingsSummary()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"buildSummary()"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"BulkCaseProcessor()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactor","l":"BulkRedactor()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"BulkRedactorProgressInfo()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"BulkRedactorSettings()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"bytesToDynamicSize(long, int)","url":"bytesToDynamicSize(long,int)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"bytesToGigaBytes(long, int)","url":"bytesToGigaBytes(long,int)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"bytesToHex(byte[])"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"bytesToKiloBytes(long, int)","url":"bytesToKiloBytes(long,int)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"bytesToMegaBytes(long, int)","url":"bytesToMegaBytes(long,int)"},{"p":"com.nuix.superutilities.misc","c":"LevenshteinDistance","l":"calculate(String, String)","url":"calculate(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"calculateJaroWinklerSimilarityTo(String)","url":"calculateJaroWinklerSimilarityTo(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"calculateLastDbEventStart()"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"calculateLuceneLevenshteinSimilarityTo(String)","url":"calculateLuceneLevenshteinSimilarityTo(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"calculateNGramSimilarityTo(String)","url":"calculateNGramSimilarityTo(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"caseExists()"},{"p":"com.nuix.superutilities.cases","c":"CaseHistoryHelper","l":"CaseHistoryHelper(Case, List, DateTime, DateTime)","url":"%3Cinit%3E(nuix.Case,java.util.List,org.joda.time.DateTime,org.joda.time.DateTime)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"CaseInfo(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"CaseInfo(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"CaseLockedEventInfo(CaseInfo)","url":"%3Cinit%3E(com.nuix.superutilities.cases.CaseInfo)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"CaseLockInfo()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"CaseOpenErrorEvent(CaseInfo, Exception)","url":"%3Cinit%3E(com.nuix.superutilities.cases.CaseInfo,java.lang.Exception)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"ChunkedDATExporter()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter.ChunkInfo","l":"chunkIndex"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter.ChunkInfo","l":"ChunkInfo(int)","url":"%3Cinit%3E(int)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"cleanPathString(String)","url":"cleanPathString(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"cleanupTemporaryPdfs()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"clear()"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"clear()"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"clearAllDynamicPlaholders()"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"clearColors()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"clearEntityNames()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"clearRowCriteria()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"close()"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileWriter","l":"close()"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"close()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"close()"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"ColorRing()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"ColumnValueGenerator()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"combineDigestFiles(File, Collection)","url":"combineDigestFiles(java.io.File,java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"combineDigestFiles(String, Collection)","url":"combineDigestFiles(java.lang.String,java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"compareTo(NuixVersion)","url":"compareTo(com.nuix.superutilities.misc.NuixVersion)"},{"p":"com.nuix.superutilities.regex","c":"PatternInfo","l":"compile(boolean, boolean, boolean)","url":"compile(boolean,boolean,boolean)"},{"p":"com.nuix.superutilities.misc","c":"ZipHelper","l":"compressDirectoryToSevenZipFile(String, String)","url":"compressDirectoryToSevenZipFile(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"ZipHelper","l":"compressDirectoryToZipFile(String, String, int)","url":"compressDirectoryToZipFile(java.lang.String,java.lang.String,int)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"contains(Object)","url":"contains(java.lang.Object)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"containsAll(Collection)","url":"containsAll(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"containsMd5(byte[])"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"containsMd5(String)","url":"containsMd5(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"convertItemToJsonString(Item)","url":"convertItemToJsonString(nuix.Item)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"convertSourceItemToJsonString(SourceItem)","url":"convertSourceItemToJsonString(nuix.SourceItem)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"convertToString(Object)","url":"convertToString(java.lang.Object)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"convertWorkerItemToJsonString(WorkerItem)","url":"convertWorkerItemToJsonString(nuix.WorkerItem)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createBulkCaseProcessor()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createCaseHistoryHelper(Case, List, DateTime, DateTime)","url":"createCaseHistoryHelper(nuix.Case,java.util.List,org.joda.time.DateTime,org.joda.time.DateTime)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createFreeSpaceMonitor()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createJsonExporter()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createRegexScanner()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"createStyle()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createTemplateExporter(File)","url":"createTemplateExporter(java.io.File)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"createTemplateExporter(String)","url":"createTemplateExporter(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"createWaterMarkedPdf(File, File, String, int, float, float)","url":"createWaterMarkedPdf(java.io.File,java.io.File,java.lang.String,int,float,float)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"createWaterMarkedPdf(String, String, String, int, float, float)","url":"createWaterMarkedPdf(java.lang.String,java.lang.String,java.lang.String,int,float,float)"},{"p":"com.nuix.superutilities.annotations","c":"CustodianEvent","l":"CustodianEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"CustomExporter()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"CustomMetadataEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"DatLoadFile()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileReader","l":"DatLoadFileReader()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileWriter","l":"DatLoadFileWriter(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"debugString(Exception)","url":"debugString(java.lang.Exception)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"debugString(Map)","url":"debugString(java.util.Map)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"deduplicateCustomTieBreaker(Collection, BiFunction)","url":"deduplicateCustomTieBreaker(java.util.Collection,java.util.function.BiFunction)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"DigestList()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"DigestList(File...)","url":"%3Cinit%3E(java.io.File...)"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"DriveSpaceInfo(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"eachCell(int, int, int, int, Consumer)","url":"eachCell(int,int,int,int,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"eachDigest(File, Consumer)","url":"eachDigest(java.io.File,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedCustodianEvent(DateTime, Consumer)","url":"eachRecordedCustodianEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedCustodianEvent(long, Consumer)","url":"eachRecordedCustodianEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedCustomMetadataEvent(DateTime, Consumer)","url":"eachRecordedCustomMetadataEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedCustomMetadataEvent(long, Consumer)","url":"eachRecordedCustomMetadataEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedExclusionEvent(DateTime, Consumer)","url":"eachRecordedExclusionEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedExclusionEvent(long, Consumer)","url":"eachRecordedExclusionEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedItemSetEvent(DateTime, Consumer)","url":"eachRecordedItemSetEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedItemSetEvent(long, Consumer)","url":"eachRecordedItemSetEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedProductionSetEvent(DateTime, Consumer)","url":"eachRecordedProductionSetEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedProductionSetEvent(long, Consumer)","url":"eachRecordedProductionSetEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedTagEvent(DateTime, Consumer)","url":"eachRecordedTagEvent(org.joda.time.DateTime,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"eachRecordedTagEvent(long, Consumer)","url":"eachRecordedTagEvent(long,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsStyleHelper","l":"enableAllBorders(Style)","url":"enableAllBorders(com.aspose.cells.Style)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"equals(Object)","url":"equals(java.lang.Object)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"equals(Object)","url":"equals(java.lang.Object)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"escapeForSearch(String)","url":"escapeForSearch(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"escapeRegexSpecialCharacters(String)","url":"escapeRegexSpecialCharacters(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"escapeTagForSearch(String)","url":"escapeTagForSearch(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"ExclusionEvent","l":"ExclusionEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeInsert(String, List)","url":"executeInsert(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeInsert(String, List)","url":"executeInsert(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeInsert(String, Object...)","url":"executeInsert(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeInsert(String, Object...)","url":"executeInsert(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeLongScalar(String)","url":"executeLongScalar(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeLongScalar(String)","url":"executeLongScalar(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeLongScalar(String, List)","url":"executeLongScalar(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeLongScalar(String, List)","url":"executeLongScalar(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeLongScalar(String, Object...)","url":"executeLongScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeLongScalar(String, Object...)","url":"executeLongScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeQuery(String, List, Consumer)","url":"executeQuery(java.lang.String,java.util.List,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeQuery(String, List, Consumer)","url":"executeQuery(java.lang.String,java.util.List,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeScalar(String, Object...)","url":"executeScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeScalar(String, Object...)","url":"executeScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeStringScalar(String)","url":"executeStringScalar(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeStringScalar(String)","url":"executeStringScalar(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeStringScalar(String, List)","url":"executeStringScalar(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeStringScalar(String, List)","url":"executeStringScalar(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeStringScalar(String, Object...)","url":"executeStringScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeStringScalar(String, Object...)","url":"executeStringScalar(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeUpdate(String)","url":"executeUpdate(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeUpdate(String)","url":"executeUpdate(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeUpdate(String, List)","url":"executeUpdate(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeUpdate(String, List)","url":"executeUpdate(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"executeUpdate(String, Object...)","url":"executeUpdate(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"executeUpdate(String, Object...)","url":"executeUpdate(java.lang.String,java.lang.Object...)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"ExpandedTermInfo()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"expandTerm(Case, boolean, boolean, String)","url":"expandTerm(nuix.Case,boolean,boolean,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"expandTerm(Case, boolean, boolean, String, String)","url":"expandTerm(nuix.Case,boolean,boolean,java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"expandTerm(Case, String)","url":"expandTerm(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"export(List)","url":"export(java.util.List)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"exportItemAsJson(Item, File)","url":"exportItemAsJson(nuix.Item,java.io.File)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportItems(Case, File, List)","url":"exportItems(nuix.Case,java.io.File,java.util.List)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportItems(Case, String, List)","url":"exportItems(nuix.Case,java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportJson(String)","url":"exportJson(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportJson(String, JsonExporter)","url":"exportJson(java.lang.String,com.nuix.superutilities.export.JsonExporter)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportNatives(String, Map)","url":"exportNatives(java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportPdfs(String, Map)","url":"exportPdfs(java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"exportSourceItemAsJson(SourceItem, File)","url":"exportSourceItemAsJson(nuix.SourceItem,java.io.File)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportText(String, Map)","url":"exportText(java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"exportTiffs(String, Map)","url":"exportTiffs(java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"exportWorkerItemAsJson(WorkerItem, File)","url":"exportWorkerItemAsJson(nuix.WorkerItem,java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactor","l":"findAndMarkup(Case, BulkRedactorSettings, Collection, int)","url":"findAndMarkup(nuix.Case,com.nuix.superutilities.annotations.BulkRedactorSettings,java.util.Collection,int)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"findBatchLoadsInDateRange(Case, DateTime, DateTime)","url":"findBatchLoadsInDateRange(nuix.Case,org.joda.time.DateTime,org.joda.time.DateTime)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseDirectories(File)","url":"findCaseDirectories(java.io.File)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseDirectories(String)","url":"findCaseDirectories(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseDirectoryPaths(File)","url":"findCaseDirectoryPaths(java.io.File)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseDirectoryPaths(String)","url":"findCaseDirectoryPaths(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseInformation(File)","url":"findCaseInformation(java.io.File)"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"findCaseInformation(String)","url":"findCaseInformation(java.lang.String)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"findContainerAncestor(Item)","url":"findContainerAncestor(nuix.Item)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"findContainerAncestors(Collection)","url":"findContainerAncestors(java.util.Collection)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactor","l":"findExpressionsInPdfFile(File, Collection)","url":"findExpressionsInPdfFile(java.io.File,java.util.Collection)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"findFamiliesWithoutItemsResponsiveToQuery(Case, Collection, String)","url":"findFamiliesWithoutItemsResponsiveToQuery(nuix.Case,java.util.Collection,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"findMatchingItems(Case)","url":"findMatchingItems(nuix.Case)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"findMatchingItems(Case, int)","url":"findMatchingItems(nuix.Case,int)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"findPhysicalFileAncestor(Item)","url":"findPhysicalFileAncestor(nuix.Item)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"findPhysicalFileAncestors(Collection)","url":"findPhysicalFileAncestors(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"forEach(Consumer)","url":"forEach(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"forgetItem(Item)","url":"forgetItem(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"formatAsTextualTable(List>)","url":"formatAsTextualTable(java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"formatNumber(double)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"formatNumber(int)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"formatNumber(long)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"FreeSpaceMonitor()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"fromCaseDirectories(List)","url":"fromCaseDirectories(java.util.List)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"fromCasePaths(List)","url":"fromCasePaths(java.util.List)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"fromFile(File)","url":"fromFile(java.io.File)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"fromFile(String)","url":"fromFile(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"fromLine(String)","url":"fromLine(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"fromLine(String[], String)","url":"fromLine(java.lang.String[],java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"FuzzyTermInfo()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"generate(Case, String, IntersectionReportSheetConfiguration)","url":"generate(nuix.Case,java.lang.String,com.nuix.superutilities.reporting.IntersectionReportSheetConfiguration)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"generateMd5Bytes(Item)","url":"generateMd5Bytes(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"generateMd5String(Item)","url":"generateMd5String(nuix.Item)"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"generateValue(Case, String)","url":"generateValue(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"ScriptedColumnValueGenerator","l":"generateValue(Case, String)","url":"generateValue(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"get(int)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"get(String)","url":"get(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getAccessedDateTime()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getAccessedDateTimeString()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getAdded()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getAdded()"},{"p":"com.nuix.superutilities.annotations","c":"TagEvent","l":"getAdded()"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"getAllowCaseMigration()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getAlwaysCreateTagOnImport()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getApplyHighLights()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getApplyRedactions()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getAsposeSourcePageRectangle()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"getAsposeWorkbook()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"getAsposeWorksheet()"},{"p":"com.nuix.superutilities.annotations","c":"CustodianEvent","l":"getAssigned()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"getAssociatedItems(Case)","url":"getAssociatedItems(nuix.Case)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getBatchLoadMaxDate()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getBatchLoadMinDate()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getBatchName()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getBox()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"getBugfix()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"getBuild()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getBulkAnnotater()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getCaptureContextualText()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getCaseDirectory()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getCaseDirectoryPath()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"getCaseInfo()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"getCaseInfo()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"getCaseInfo()"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"getCaseInfo()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getCaseSensitive()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getCaseUtility()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"getCell(int, int)","url":"getCell(int,int)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getChildCaseCount()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getChildCases()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getChunkSize()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"getColCategoryColorRing()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getColCriteria()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getColPrimaryCategoryLabel()"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"getColumnLabel()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getConcurrency()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"getContentMatches()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"getContentTextUpdatedCount()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getContextSize()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getContextualSubString(CharSequence, int, int, int)","url":"getContextualSubString(java.lang.CharSequence,int,int,int)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getCreationDateTime()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getCreationDateTimeString()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"getCurrent()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"getCurrent()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"getCurrentRow()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getCurrentVersion()"},{"p":"com.nuix.superutilities.annotations","c":"CustodianEvent","l":"getCustodian()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getCustomMetadataFieldPrefix()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getCustomMetadataToScan()"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileWriter","l":"getDestinationFile()"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"getDigestCount(File)","url":"getDigestCount(java.io.File)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"getDigestCustomField()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getDotall()"},{"p":"com.nuix.superutilities.cases","c":"CaseHistoryHelper","l":"getEarliestEventStart(Case)","url":"getEarliestEventStart(nuix.Case)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getEntityNames()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"getError()"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"getError()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getError()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"getException()"},{"p":"com.nuix.superutilities.annotations","c":"ExclusionEvent","l":"getExcluded()"},{"p":"com.nuix.superutilities.annotations","c":"ExclusionEvent","l":"getExclusionName()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"getExpectedItemCount()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getExportDirectory()"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"getExportXlsx()"},{"p":"com.nuix.superutilities.regex","c":"PatternInfo","l":"getExpression()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getExpression()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getExpressions()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getFbi2File()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getFbi2FilePath()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getFieldName()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getFilenamePrefix()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"getFilenameTimestamp()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"getFirstPageRecords()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getFolder()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getFormatUtility()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getFreeBytes()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getFreeGigaBytes()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getFreezePanes()"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"getFuzzyResolutionAlgorithm()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getGuid()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"getGuidRefInsertBatchSize()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"getHeadersFromRecord(LinkedHashMap)","url":"getHeadersFromRecord(java.util.LinkedHashMap)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getHeadersOnFirstChunkOnly()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getHeight()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"getHost()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"getHtmlText(String)","url":"getHtmlText(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getId()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeChildGuids()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeCustomMetadata()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"getIncludeItemText()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeParentGuid()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludePathGuids()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeProperties()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeTags()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getIncludeText()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getInstance()"},{"p":"com.nuix.superutilities.cases","c":"CaseUtility","l":"getInstance()"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"getInstance()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"getInstance()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"getIntegerInfo(String)","url":"getIntegerInfo(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getInvestigator()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getItem()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"getItem(Case)","url":"getItem(nuix.Case)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"getItem(Case)","url":"getItem(nuix.Case)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"getItemGuid()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getItemId(Item)","url":"getItemId(nuix.Item)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getItemMarkupCount()"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"getItemsAndNeighboringSiblings(List, int, int)","url":"getItemsAndNeighboringSiblings(java.util.List,int,int)"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getItemSetName()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getItemUtility()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getJarDirectory()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getJarDirectoryPath()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getJarFile()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getJarFilePath()"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"getKeepOriginalDat()"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"getLabel()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getLastUpdated()"},{"p":"com.nuix.superutilities.cases","c":"CaseHistoryHelper","l":"getLatestEventStart(Case)","url":"getLatestEventStart(nuix.Case)"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getLocation()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"getLocation()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getLockProperties()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"getMajor()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getMarkupSet(Case)","url":"getMarkupSet(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getMarkupSetId(MarkupSet)","url":"getMarkupSetId(nuix.MarkupSet)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getMarkupSetName()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"getMatchCount()"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"getMatchedTerm()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getMatchEnd()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"getMatches()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"getMatches()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getMatchNamedEntityValues()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getMatchStart()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"getMinor()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getMultiline()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getName()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"getName()"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"getName()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getNamedEntityTypes()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getNamedEntityTypes()"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getNuixUtilities()"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"getOcurrences()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getOnlyRecordChanges()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getOrCreateRelatedItemSet(Case)","url":"getOrCreateRelatedItemSet(nuix.Case)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"getOriginalTerm()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getPageNumber()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getPages()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getPath()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getPathString()"},{"p":"com.nuix.superutilities.regex","c":"PatternInfo","l":"getPattern()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getPatternInfo()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"getPatternInfo()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getPatterns()"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"getPdfPath(Item)","url":"getPdfPath(nuix.Item)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"getPhysicalAncestorPath(Item)","url":"getPhysicalAncestorPath(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"getPlaceholderData()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getPrettyPrint()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"getProduct()"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"getProfile()"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"getProfile()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"getProfile()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getPropertiesToScan()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"getPropertyMatches()"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"getQuery()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"getReaction()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"getReaction()"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"getReaction()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"getRecordDigest()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"getRecords()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getRecordTimeOfRedaction()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getRedactContentText()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getRedactionReplacementTemplate()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getRedactProperties()"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"getRegenerateStored()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getRelatedItemSet(Case)","url":"getRelatedItemSet(nuix.Case)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getRowCategoryLabel()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getRowCriteria()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getSavedByName()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getSavedByVersion()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getScanContent()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getScanCustomMetadata()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getScanProperties()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getScopeQuery()"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"getSerializeNulls()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"getSettings()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"getSheet(String)","url":"getSheet(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"getSimilarity()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"getSnapshotFirstSync()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"getSourceRepo()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getSpecificProperties()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"getStoreCount()"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getStringCustomMetadata(Item, Set)","url":"getStringCustomMetadata(nuix.Item,java.util.Set)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"getStringProperties(Item, Set)","url":"getStringProperties(nuix.Item,java.util.Set)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"getStyle(int, int)","url":"getStyle(int,int)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"getSuperItemUtility()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncCustodianEvents()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncCustomMetadataEvents()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncExclusionEvents()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncItemSetEvents()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncProductionSetEvents()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"getSyncTagEvents()"},{"p":"com.nuix.superutilities.annotations","c":"TagEvent","l":"getTag()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getTagId(String)","url":"getTagId(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getTagsForGuid(String)","url":"getTagsForGuid(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"getTagsForMd5(String)","url":"getTagsForMd5(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"getTargetSimilarity()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"getTempDirectory()"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"getTerm()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getText()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"getTextInfo(String)","url":"getTextInfo(java.lang.String)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"getTimeOfRedactionFieldName()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"getTimeStamp()"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsColorHelper","l":"getTint(Color, float)","url":"getTint(com.aspose.cells.Color,float)"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsColorHelper","l":"getTint(int, int, int, float)","url":"getTint(int,int,int,float)"},{"p":"com.nuix.superutilities.regex","c":"PatternInfo","l":"getTitle()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"getTotal()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getTotalBytes()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"getTotalEventCount()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"getTotalGigaBytes()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"getUnitBase()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"getUpdatedItemCount()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"getUpdatedProperties()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"getUpdatedPropertyNames()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"getUseExistingValueWhenPresent()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"getUser()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"getUseSIUnits()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValue()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getValue()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"getValue(int, int)","url":"getValue(int,int)"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsByteArray()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsDateTime()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsDouble()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsInteger()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsLong()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueAsString()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"getValueContext()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"getValueGenerators()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"getValueType()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"getVolume()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"getVolumeNames()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getWidth()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getX()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"getY()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationMatchingMethod","l":"GUID"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"hadError()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"hasBatchLoadDateCriteria()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"hashCode()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"hashCode()"},{"p":"com.nuix.superutilities.cases","c":"CaseHistoryHelper","l":"hasNext()"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"hasNext()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"hasSameGuidAs(Case)","url":"hasSameGuidAs(nuix.Case)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"hexToBytes(String)","url":"hexToBytes(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"htmlToPdf(String, File)","url":"htmlToPdf(java.lang.String,java.io.File)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"htmlToPdf(String, String)","url":"htmlToPdf(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"importCaseLevelDigestList(Case, String)","url":"importCaseLevelDigestList(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"importFile(File)","url":"importFile(java.io.File)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"importFile(String)","url":"importFile(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"importSystemLevelDigestList(String)","url":"importSystemLevelDigestList(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"importUserLevelDigestList(String)","url":"importUserLevelDigestList(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"indexOf(Object)","url":"indexOf(java.lang.Object)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"init(Utilities, String)","url":"init(nuix.Utilities,java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"initializeAspose()"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"IntersectionReport(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"IntersectionReportSheetConfiguration()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isAtLeast(NuixVersion)","url":"isAtLeast(com.nuix.superutilities.misc.NuixVersion)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isAtLeast(String)","url":"isAtLeast(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"isCompound()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"isContentMatch()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"isEmpty()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isEqualTo(NuixVersion)","url":"isEqualTo(com.nuix.superutilities.misc.NuixVersion)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isEqualTo(String)","url":"isEqualTo(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"isFirstPage()"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"isFuzzyTerm(String)","url":"isFuzzyTerm(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isGreaterThan(NuixVersion)","url":"isGreaterThan(com.nuix.superutilities.misc.NuixVersion)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isGreaterThan(String)","url":"isGreaterThan(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isLessThan(NuixVersion)","url":"isLessThan(com.nuix.superutilities.misc.NuixVersion)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"isLessThan(String)","url":"isLessThan(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"isLocked()"},{"p":"com.nuix.superutilities.regex","c":"ItemRegexMatchCollection","l":"ItemRegexMatchCollection(Item)","url":"%3Cinit%3E(nuix.Item)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter.ChunkInfo","l":"items"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"itemsAreSiblings(Item, Item)","url":"itemsAreSiblings(nuix.Item,nuix.Item)"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"ItemSetEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"iterator()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"iterator()"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"JaroWinkler"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"joinByAnd(Collection)","url":"joinByAnd(java.util.Collection)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"joinByOr(Collection)","url":"joinByOr(java.util.Collection)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"JsonExporter()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"lastIndexOf(Object)","url":"lastIndexOf(java.lang.Object)"},{"p":"com.nuix.superutilities.misc","c":"LevenshteinDistance","l":"LevenshteinDistance()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"listIterator()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"listIterator(int)"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"LuceneLevenshstein"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"makeGuidPath(Item, File, String)","url":"makeGuidPath(nuix.Item,java.io.File,java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapAddress(Address)","url":"mapAddress(nuix.Address)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapAddresses(List
    )","url":"mapAddresses(java.util.List)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapCommunication(Communication)","url":"mapCommunication(nuix.Communication)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapItem(Item)","url":"mapItem(nuix.Item)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapItemType(ItemType)","url":"mapItemType(nuix.ItemType)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapProperties(Map)","url":"mapProperties(java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapSourceItem(SourceItem)","url":"mapSourceItem(nuix.SourceItem)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"mapWorkerItem(WorkerItem)","url":"mapWorkerItem(nuix.WorkerItem)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"markupSetQuery(MarkupSet)","url":"markupSetQuery(nuix.MarkupSet)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationMatchingMethod","l":"MD5"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"mergeCols(int, int, int)","url":"mergeCols(int,int,int)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"mergeOther(NamedEntityRedactionResults)","url":"mergeOther(com.nuix.superutilities.namedentities.NamedEntityRedactionResults)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"mergePdfFiles(File, List, boolean, List)","url":"mergePdfFiles(java.io.File,java.util.List,boolean,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"mergePdfFiles(String, List, boolean, List)","url":"mergePdfFiles(java.lang.String,java.util.List,boolean,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitorEventCallback","l":"monitorEventOccurred(FreeSpaceMonitor, DriveSpaceInfo)","url":"monitorEventOccurred(com.nuix.superutilities.misc.FreeSpaceMonitor,com.nuix.superutilities.misc.DriveSpaceInfo)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"namedEntityQuery(Collection)","url":"namedEntityQuery(java.util.Collection)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"NamedEntityRedactionResults()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"NamedEntityRedactionSettings()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"NamedEntityUtility()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"NamedQuery()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"NamedQuery(String, String)","url":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"NamedStringList()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.cases","c":"CaseHistoryHelper","l":"next()"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"next()"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"NGram"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"notJoinByAnd(Collection)","url":"notJoinByAnd(java.util.Collection)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"notJoinByOr(Collection)","url":"notJoinByOr(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"Nuix"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"NuixImageAnnotationRegion()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"NuixVersion()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"NuixVersion(int)","url":"%3Cinit%3E(int)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"NuixVersion(int, int)","url":"%3Cinit%3E(int,int)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"NuixVersion(int, int, int)","url":"%3Cinit%3E(int,int,int)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"NuixVersion(int, int, int, int)","url":"%3Cinit%3E(int,int,int,int)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"onCaseIsLocked(Consumer)","url":"onCaseIsLocked(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"onErrorOpeningCase(Consumer)","url":"onErrorOpeningCase(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"onUserFunctionError(Consumer)","url":"onUserFunctionError(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"OptLoadFile()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"OptRecord()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"orTagQuery(Collection)","url":"orTagQuery(java.util.Collection)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"orTagQuery(String...)","url":"orTagQuery(java.lang.String...)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"parallelStream()"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"parenThenJoinByAnd(Collection)","url":"parenThenJoinByAnd(java.util.Collection)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"parenThenJoinByOr(Collection)","url":"parenThenJoinByOr(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"parse(String)","url":"parse(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"parseFuzzyTerm(String)","url":"parseFuzzyTerm(java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"PatternInfo","l":"PatternInfo(String, String)","url":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"PdfUtility()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"PdfWorkCache(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"phraseToExpression(String)","url":"phraseToExpression(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"PlaceholderResolver()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"ProductionSetEvent","l":"ProductionSetEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"ProfileDigester()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"ProfileDigester(MetadataProfile)","url":"%3Cinit%3E(nuix.MetadataProfile)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportProgressCallback","l":"progressUpdated(int, int)","url":"progressUpdated(int,int)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionProgressCallback","l":"progressUpdated(int, int, NamedEntityRedactionResults)","url":"progressUpdated(int,int,com.nuix.superutilities.namedentities.NamedEntityRedactionResults)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"QueryHelper()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"recordRedactedCopies(Case, Collection, NamedEntityRedactionSettings)","url":"recordRedactedCopies(nuix.Case,java.util.Collection,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"recordRedactedCopies(Case, NamedEntityRedactionSettings)","url":"recordRedactedCopies(nuix.Case,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"recordRedactedCopies(Collection, NamedEntityRedactionSettings)","url":"recordRedactedCopies(java.util.Collection,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"recordRedactedCopies(Item, NamedEntityRedactionSettings)","url":"recordRedactedCopies(nuix.Item,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"refresh()"},{"p":"com.nuix.superutilities.regex","c":"RegexMatch","l":"RegexMatch(PatternInfo, String, boolean, String, String, int, int)","url":"%3Cinit%3E(com.nuix.superutilities.regex.PatternInfo,java.lang.String,boolean,java.lang.String,java.lang.String,int,int)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanError","l":"RegexScanError(Item, PatternInfo, String, Exception)","url":"%3Cinit%3E(nuix.Item,com.nuix.superutilities.regex.PatternInfo,java.lang.String,java.lang.Exception)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"RegexScanner()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"remove(int)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"remove(Object)","url":"remove(java.lang.Object)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"removeAll(Collection)","url":"removeAll(java.util.Collection)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"removeDynamicPlaceholder(String)","url":"removeDynamicPlaceholder(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"removeIf(Predicate)","url":"removeIf(java.util.function.Predicate)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"removeItem(Item)","url":"removeItem(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"removeItems(Collection)","url":"removeItems(java.util.Collection)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"removeItemsResponsiveToQuery(Case, Collection, String)","url":"removeItemsResponsiveToQuery(nuix.Case,java.util.Collection,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"removeMd5(byte[])"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"removeMd5(String)","url":"removeMd5(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"render(Item)","url":"render(nuix.Item)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"render(Item, Map)","url":"render(nuix.Item,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"renderToFile(Item, File, Map)","url":"renderToFile(nuix.Item,java.io.File,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"renderToFile(Item, String, Map)","url":"renderToFile(nuix.Item,java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"renderToPdf(Item, File, Map)","url":"renderToPdf(nuix.Item,java.io.File,java.util.Map)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"replaceAll(UnaryOperator)","url":"replaceAll(java.util.function.UnaryOperator)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"CustodianEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"ExclusionEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"ProductionSetEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"TagEvent","l":"replay(Case)","url":"replay(nuix.Case)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"resolvePlaceholders(String, Map)","url":"resolvePlaceholders(java.lang.String,java.util.Map)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"resolveTemplate(String)","url":"resolveTemplate(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"resolveTemplateMultiValues(String, List)","url":"resolveTemplateMultiValues(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"resolveTemplatePath(String)","url":"resolveTemplatePath(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"resolveTemplatePathMultiValues(String, List)","url":"resolveTemplatePathMultiValues(java.lang.String,java.util.List)"},{"p":"com.nuix.superutilities.reporting","c":"ColorRing","l":"restart()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"retainAll(Collection)","url":"retainAll(java.util.Collection)"},{"p":"com.nuix.superutilities.cases","c":"CaseIssueReaction","l":"Retry"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"retry()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"retry()"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"round(double, int)","url":"round(double,int)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"save()"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"saveAs(String)","url":"saveAs(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"saveCaseLevelDigestList(Case, String)","url":"saveCaseLevelDigestList(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"saveDiagnostics(File)","url":"saveDiagnostics(java.io.File)"},{"p":"com.nuix.superutilities","c":"SuperUtilities","l":"saveDiagnostics(String)","url":"saveDiagnostics(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"saveFile(File)","url":"saveFile(java.io.File)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"saveRedactionProfile(File, NamedEntityRedactionResults, NamedEntityRedactionSettings)","url":"saveRedactionProfile(java.io.File,com.nuix.superutilities.namedentities.NamedEntityRedactionResults,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"saveRedactionProfile(String, NamedEntityRedactionResults, NamedEntityRedactionSettings)","url":"saveRedactionProfile(java.lang.String,com.nuix.superutilities.namedentities.NamedEntityRedactionResults,com.nuix.superutilities.namedentities.NamedEntityRedactionSettings)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"saveSystemLevelDigestList(String)","url":"saveSystemLevelDigestList(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"saveUserLevelDigestList(String)","url":"saveUserLevelDigestList(java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"scanItems(Collection)","url":"scanItems(java.util.Collection)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"scanItems(Collection, Consumer)","url":"scanItems(java.util.Collection,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"scanItemsParallel(Collection, Consumer)","url":"scanItemsParallel(java.util.Collection,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"scanItemsParallel(Collection, Consumer, int)","url":"scanItemsParallel(java.util.Collection,java.util.function.Consumer,int)"},{"p":"com.nuix.superutilities.reporting","c":"ScriptedColumnValueGenerator","l":"ScriptedColumnValueGenerator(String, BiFunction)","url":"%3Cinit%3E(java.lang.String,java.util.function.BiFunction)"},{"p":"com.nuix.superutilities.reporting","c":"ScriptedColumnValueGenerator","l":"ScriptedColumnValueGenerator(String, String, BiFunction)","url":"%3Cinit%3E(java.lang.String,java.lang.String,java.util.function.BiFunction)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"secondsToElapsedString(Double)","url":"secondsToElapsedString(java.lang.Double)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"secondsToElapsedString(long)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"set(int, String)","url":"set(int,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"set(String, String)","url":"set(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"setAllowCaseMigration(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"setAlwaysCreateTagOnImport(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setApplyHighLights(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setApplyRedactions(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setAsposeSourcePageRectangle(Rectangle)","url":"setAsposeSourcePageRectangle(com.aspose.pdf.Rectangle)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setBatchLoadMaxDate(DateTime)","url":"setBatchLoadMaxDate(org.joda.time.DateTime)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setBatchLoadMinDate(DateTime)","url":"setBatchLoadMinDate(org.joda.time.DateTime)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setBox(String)","url":"setBox(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"setBugfix(int)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"setBuild(int)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setCaptureContextualText(boolean)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"setCaseInfo(CaseInfo)","url":"setCaseInfo(com.nuix.superutilities.cases.CaseInfo)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setCaseSensitive(boolean)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setChunkSize(int)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"setColCategoryColorRing(ColorRing)","url":"setColCategoryColorRing(com.nuix.superutilities.reporting.ColorRing)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setColCriteria(List)","url":"setColCriteria(java.util.List)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setColPrimaryCategoryLabel(String)","url":"setColPrimaryCategoryLabel(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"setColumnLabel(String)","url":"setColumnLabel(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setColumnRemovals(Collection)","url":"setColumnRemovals(java.util.Collection)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setConcurrency(int)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setContextSize(int)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"setCurrent(int)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"setCurrentRow(int)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setCustomMetadataFieldPrefix(String)","url":"setCustomMetadataFieldPrefix(java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setCustomMetadataToScan(List)","url":"setCustomMetadataToScan(java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"setDigestCustomField(String)","url":"setDigestCustomField(java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setDotall(boolean)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setDynamicPlaceholder(String, BiFunction)","url":"setDynamicPlaceholder(java.lang.String,java.util.function.BiFunction)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setExportDirectory(File)","url":"setExportDirectory(java.io.File)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setExportDirectory(String)","url":"setExportDirectory(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setExportXlsx(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setExpressions(Collection)","url":"setExpressions(java.util.Collection)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setFilenamePrefix(String)","url":"setFilenamePrefix(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setFirstPage(boolean)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setFolder(String)","url":"setFolder(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setFreezePanes(boolean)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"setFromItem(Item)","url":"setFromItem(nuix.Item)"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"setFuzzyResolutionAlgorithm(SimilarityCalculation)","url":"setFuzzyResolutionAlgorithm(com.nuix.superutilities.misc.SimilarityCalculation)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setGuidRefInsertBatchSize(int)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setHeaderRenames(Map)","url":"setHeaderRenames(java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setHeadersOnFirstChunkOnly(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setHeight(double)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"setHost(String)","url":"setHost(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setId(String)","url":"setId(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setImagingOptions(Map)","url":"setImagingOptions(java.util.Map)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeChildGuids(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeCustomMetadata(boolean)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"setIncludeItemText(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeParentGuid(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludePathGuids(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeProperties(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeTags(boolean)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setIncludeText(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setIntegerInfo(String, Long)","url":"setIntegerInfo(java.lang.String,java.lang.Long)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setItem(Item)","url":"setItem(nuix.Item)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setKeepOriginalDat(boolean)"},{"p":"com.nuix.superutilities.reporting","c":"ColumnValueGenerator","l":"setLabel(String)","url":"setLabel(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"setMajor(int)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setMarkupSetName(String)","url":"setMarkupSetName(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"setMatchedTerm(String)","url":"setMatchedTerm(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"setMatches(int)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setMatchNamedEntityValues(boolean)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setMaxToStringLength(int)"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"setMinor(int)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setMultiline(boolean)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"setName(String)","url":"setName(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"setName(String)","url":"setName(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setNamedEntityTypes(Collection)","url":"setNamedEntityTypes(java.util.Collection)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setNamedEntityTypes(Collection)","url":"setNamedEntityTypes(java.util.Collection)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"setOcurrences(long)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setOnlyRecordChanges(boolean)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"setOriginalTerm(String)","url":"setOriginalTerm(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setPageNumber(int)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setPages(int)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setParallelProcessingSettings(Map)","url":"setParallelProcessingSettings(java.util.Map)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setPath(String)","url":"setPath(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"PlaceholderResolver","l":"setPath(String, String)","url":"setPath(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setPatterns(List)","url":"setPatterns(java.util.List)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setPrettyPrint(boolean)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"setProduct(String)","url":"setProduct(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"ChunkedDATExporter","l":"setProfile(MetadataProfile)","url":"setProfile(nuix.MetadataProfile)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setProfile(MetadataProfile)","url":"setProfile(nuix.MetadataProfile)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"setProfile(MetadataProfile)","url":"setProfile(nuix.MetadataProfile)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setPropertiesToScan(List)","url":"setPropertiesToScan(java.util.List)"},{"p":"com.nuix.superutilities.reporting","c":"NamedQuery","l":"setQuery(String)","url":"setQuery(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"setReaction(CaseIssueReaction)","url":"setReaction(com.nuix.superutilities.cases.CaseIssueReaction)"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"setReaction(CaseIssueReaction)","url":"setReaction(com.nuix.superutilities.cases.CaseIssueReaction)"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"setReaction(CaseIssueReaction)","url":"setReaction(com.nuix.superutilities.cases.CaseIssueReaction)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"setRecordDigest(boolean)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"setRecords(List)","url":"setRecords(java.util.List)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setRecordTimeOfRedaction(boolean)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setRedactContentText(boolean)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setRedactionReplacementTemplate(String)","url":"setRedactionReplacementTemplate(java.lang.String)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setRedactProperties(boolean)"},{"p":"com.nuix.superutilities.export","c":"PdfWorkCache","l":"setRegenerateStored(boolean)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setRowCategoryLabel(String)","url":"setRowCategoryLabel(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setRowCriteria(List)","url":"setRowCriteria(java.util.List)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setScanContent(boolean)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setScanCustomMetadata(boolean)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"setScanProperties(boolean)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setScopeQuery(String)","url":"setScopeQuery(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"JsonExporter","l":"setSerializeNulls(boolean)"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"setSimilarity(float)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setSnapshotFirstSync(boolean)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setSpecificProperties(Collection)","url":"setSpecificProperties(java.util.Collection)"},{"p":"com.nuix.superutilities.export","c":"CustomExporter","l":"setStampingOptions(Map)","url":"setStampingOptions(java.util.Map)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"setStyle(int, int, Style)","url":"setStyle(int,int,com.aspose.cells.Style)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncCustodianEvents(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncCustomMetadataEvents(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncExclusionEvents(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncItemSetEvents(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setSyncPoint(DateTime)","url":"setSyncPoint(org.joda.time.DateTime)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setSyncPointFromDestinationCaseLastEvent(Case)","url":"setSyncPointFromDestinationCaseLastEvent(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setSyncPointToNow()"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncProductionSetEvents(boolean)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationSyncSettings","l":"setSyncTagEvents(boolean)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"setTargetSimilarity(float)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setTempDirectory(File)","url":"setTempDirectory(java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"setTempDirectory(String)","url":"setTempDirectory(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FuzzyTermInfo","l":"setTerm(String)","url":"setTerm(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setText(String)","url":"setText(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"setTextInfo(String, String)","url":"setTextInfo(java.lang.String,java.lang.String)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionSettings","l":"setTimeOfRedactionFieldName(String)","url":"setTimeOfRedactionFieldName(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorProgressInfo","l":"setTotal(int)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"setUseExistingValueWhenPresent(boolean)"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"setUser(String)","url":"setUser(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"setUseSIUnits(boolean)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleWorksheet","l":"setValue(int, int, Object)","url":"setValue(int,int,java.lang.Object)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReportSheetConfiguration","l":"setValueGenerators(List)","url":"setValueGenerators(java.util.List)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"setVolume(String)","url":"setVolume(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setWidth(double)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setX(double)"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"setY(double)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"shutdownMonitoring()"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"signalAbort()"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileReader","l":"SimpleTextFileReader()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileWriter","l":"SimpleTextFileWriter(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"SimpleXlsx(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.reporting","c":"SimpleXlsx","l":"SimpleXlsx(String)","url":"%3Cinit%3E(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"DigestList","l":"size()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"size()"},{"p":"com.nuix.superutilities.cases","c":"CaseIssueReaction","l":"SkipCase"},{"p":"com.nuix.superutilities.cases","c":"CaseLockedEventInfo","l":"skipCase()"},{"p":"com.nuix.superutilities.cases","c":"CaseOpenErrorEvent","l":"skipCase()"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"skipCase()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"sort(Comparator)","url":"sort(java.util.Comparator)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"splitAndMaintainFamilies(Collection, int, Consumer>)","url":"splitAndMaintainFamilies(java.util.Collection,int,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"spliterator()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"splitLine(String)","url":"splitLine(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"splitPhrase(String)","url":"splitPhrase(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"SQLiteBacked","l":"SQLiteBacked(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"storeAllMarkupSets(Case)","url":"storeAllMarkupSets(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"storeAllTags(Case)","url":"storeAllTags(nuix.Case)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"storeMarkupSet(Case, MarkupSet)","url":"storeMarkupSet(nuix.Case,nuix.MarkupSet)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"storeTag(Case, String)","url":"storeTag(nuix.Case,java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"stream()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"subList(int, int)","url":"subList(int,int)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepository","l":"syncHistory(Case, AnnotationSyncSettings)","url":"syncHistory(nuix.Case,com.nuix.superutilities.annotations.AnnotationSyncSettings)"},{"p":"com.nuix.superutilities.annotations","c":"TagEvent","l":"TagEvent()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"tallyContentTextUdpated()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"tallyUpdatedItem()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"tallyUpdatedProperty(String)","url":"tallyUpdatedProperty(java.lang.String)"},{"p":"com.nuix.superutilities.export","c":"TemplateExporter","l":"TemplateExporter(File)","url":"%3Cinit%3E(java.io.File)"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"TermExpander()","url":"%3Cinit%3E()"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactorSettings","l":"termToRegex(String)","url":"termToRegex(java.lang.String)"},{"p":"com.nuix.superutilities.reporting","c":"AsposeCellsColorHelper","l":"tintChannel(int, float)","url":"tintChannel(int,float)"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"toArray()"},{"p":"com.nuix.superutilities.misc","c":"NamedStringList","l":"toArray(T[])"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"toFile(File)","url":"toFile(java.io.File)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"toHeaderLine(LinkedHashMap)","url":"toHeaderLine(java.util.LinkedHashMap)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"toHeaderLine(List)","url":"toHeaderLine(java.util.List)"},{"p":"com.nuix.superutilities.misc","c":"FormatUtility","l":"tokenizeText(String)","url":"tokenizeText(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptRecord","l":"toLine()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"toLine(LinkedHashMap)","url":"toLine(java.util.LinkedHashMap)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"toLine(String[])","url":"toLine(java.lang.String[])"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationHistoryRepositorySummary","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"CustodianEvent","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"CustomMetadataEvent","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"ExclusionEvent","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"ItemSetEvent","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"NuixImageAnnotationRegion","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"ProductionSetEvent","l":"toString()"},{"p":"com.nuix.superutilities.annotations","c":"TagEvent","l":"toString()"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"toString()"},{"p":"com.nuix.superutilities.cases","c":"CaseLockInfo","l":"toString()"},{"p":"com.nuix.superutilities.misc","c":"DriveSpaceInfo","l":"toString()"},{"p":"com.nuix.superutilities.misc","c":"ExpandedTermInfo","l":"toString()"},{"p":"com.nuix.superutilities.misc","c":"NuixVersion","l":"toString()"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityRedactionResults","l":"toString()"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFile","l":"transpose(File, File, Consumer>)","url":"transpose(java.io.File,java.io.File,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.loadfiles","c":"OptLoadFile","l":"transpose(File, File, Consumer)","url":"transpose(java.io.File,java.io.File,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.items","c":"SuperItemUtility","l":"unionMany(List>)","url":"unionMany(java.util.List)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationMatchingMethod","l":"valueOf(String)","url":"valueOf(java.lang.String)"},{"p":"com.nuix.superutilities.cases","c":"CaseIssueReaction","l":"valueOf(String)","url":"valueOf(java.lang.String)"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"valueOf(String)","url":"valueOf(java.lang.String)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationMatchingMethod","l":"values()"},{"p":"com.nuix.superutilities.cases","c":"CaseIssueReaction","l":"values()"},{"p":"com.nuix.superutilities.misc","c":"SimilarityCalculation","l":"values()"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"waterMarkPrintedImages(File, Collection, String, int, float, float, BiConsumer)","url":"waterMarkPrintedImages(java.io.File,java.util.Collection,java.lang.String,int,float,float,java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.misc","c":"PdfUtility","l":"waterMarkPrintedImages(String, Collection, String, int, float, float, BiConsumer)","url":"waterMarkPrintedImages(java.lang.String,java.util.Collection,java.lang.String,int,float,float,java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"whenErrorLogged(BiConsumer)","url":"whenErrorLogged(java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"whenErrorOccurs(Consumer)","url":"whenErrorOccurs(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"whenErrorOccurs(FreeSpaceMonitorEventCallback)","url":"whenErrorOccurs(com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"whenFreeSpaceBelowThreshold(FreeSpaceMonitorEventCallback)","url":"whenFreeSpaceBelowThreshold(com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback)"},{"p":"com.nuix.superutilities.misc","c":"FreeSpaceMonitor","l":"whenFreeSpaceIssueResolved(FreeSpaceMonitorEventCallback)","url":"whenFreeSpaceIssueResolved(com.nuix.superutilities.misc.FreeSpaceMonitorEventCallback)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"whenMessageGenerated(Consumer)","url":"whenMessageGenerated(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"whenMessageGenerated(Consumer)","url":"whenMessageGenerated(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"whenMessageLogged(Consumer)","url":"whenMessageLogged(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactor","l":"whenMessageLogged(Consumer)","url":"whenMessageLogged(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"whenMessageLogged(Consumer)","url":"whenMessageLogged(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.annotations","c":"AnnotationRepository","l":"whenProgressUpdated(BiConsumer)","url":"whenProgressUpdated(java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.misc","c":"ProfileDigester","l":"whenProgressUpdated(BiConsumer)","url":"whenProgressUpdated(java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.misc","c":"TermExpander","l":"whenProgressUpdated(BiConsumer)","url":"whenProgressUpdated(java.util.function.BiConsumer)"},{"p":"com.nuix.superutilities.annotations","c":"BulkRedactor","l":"whenProgressUpdated(Consumer)","url":"whenProgressUpdated(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.regex","c":"RegexScanner","l":"whenProgressUpdated(Consumer)","url":"whenProgressUpdated(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.reporting","c":"IntersectionReport","l":"whenProgressUpdated(IntersectionReportProgressCallback)","url":"whenProgressUpdated(com.nuix.superutilities.reporting.IntersectionReportProgressCallback)"},{"p":"com.nuix.superutilities.namedentities","c":"NamedEntityUtility","l":"whenProgressUpdated(NamedEntityRedactionProgressCallback)","url":"whenProgressUpdated(com.nuix.superutilities.namedentities.NamedEntityRedactionProgressCallback)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"withCase(boolean, Consumer)","url":"withCase(boolean,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.cases","c":"CaseInfo","l":"withCase(Consumer)","url":"withCase(java.util.function.Consumer)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"withEachCase(Case, CaseConsumer)","url":"withEachCase(nuix.Case,com.nuix.superutilities.cases.CaseConsumer)"},{"p":"com.nuix.superutilities.cases","c":"BulkCaseProcessor","l":"withEachCase(CaseConsumer)","url":"withEachCase(com.nuix.superutilities.cases.CaseConsumer)"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileReader","l":"withEachLine(File, Consumer)","url":"withEachLine(java.io.File,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileReader","l":"withEachRecord(File, Consumer>)","url":"withEachRecord(java.io.File,java.util.function.Consumer)"},{"p":"com.nuix.superutilities.cases","c":"WorkFunctionErrorEvent","l":"WorkFunctionErrorEvent(CaseInfo, Exception)","url":"%3Cinit%3E(com.nuix.superutilities.cases.CaseInfo,java.lang.Exception)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileWriter","l":"writeDatLine(String[])","url":"writeDatLine(java.lang.String[])"},{"p":"com.nuix.superutilities.loadfiles","c":"SimpleTextFileWriter","l":"writeLine(String)","url":"writeLine(java.lang.String)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileWriter","l":"writeRecordKeys(LinkedHashMap)","url":"writeRecordKeys(java.util.LinkedHashMap)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileWriter","l":"writeRecordValues(LinkedHashMap)","url":"writeRecordValues(java.util.LinkedHashMap)"},{"p":"com.nuix.superutilities.loadfiles","c":"DatLoadFileWriter","l":"writeValues(List)","url":"writeValues(java.util.List)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"yearMonthRangeQuery(int, int)","url":"yearMonthRangeQuery(int,int)"},{"p":"com.nuix.superutilities.query","c":"QueryHelper","l":"yearRangeQuery(int)"},{"p":"com.nuix.superutilities.misc","c":"ZipHelper","l":"ZipHelper()","url":"%3Cinit%3E()"}] \ No newline at end of file diff --git a/docs/member-search-index.zip b/docs/member-search-index.zip new file mode 100644 index 0000000..143c852 Binary files /dev/null and b/docs/member-search-index.zip differ diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 1ccdcf1..bb38d94 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -1,174 +1,25 @@ - + -Overview +Generated Documentation (Untitled) + + + + - + + - - + +
    - -
    - - -
    Skip navigation links
    - - - - -
    -
    -
      -
    • Prev
      • -
    • Next
      • -
    - - -
    - -
    - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Packages 
    PackageDescription
    com.nuix.superutilities 
    com.nuix.superutilities.annotations 
    com.nuix.superutilities.cases 
    com.nuix.superutilities.export 
    com.nuix.superutilities.items 
    com.nuix.superutilities.loadfiles 
    com.nuix.superutilities.misc 
    com.nuix.superutilities.namedentities 
    com.nuix.superutilities.query 
    com.nuix.superutilities.regex 
    com.nuix.superutilities.reporting 
    -
    - -
    - - -
    Skip navigation links
    - - - - -
    -
    -
      -
    • Prev
      • -
    • Next
      • -
    - - -
    - -
    - - -
    - +

    index.html

    +
    diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 4b4df86..4e35d17 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -1,36 +1,42 @@ - + Class Hierarchy + + + + + + + + + - - + + +
    + +
    +

    Hierarchy For All Packages

    Package Hierarchies: @@ -86,129 +78,138 @@

    Hierarchy For All Packages

    +

    Class Hierarchy

    +
    +

    Interface Hierarchy

    +
    +

    Enum Hierarchy

    +
    +
    +
    + +
    +
    +
    diff --git a/docs/package-search-index.js b/docs/package-search-index.js new file mode 100644 index 0000000..d0148b0 --- /dev/null +++ b/docs/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"com.nuix.superutilities"},{"l":"com.nuix.superutilities.annotations"},{"l":"com.nuix.superutilities.cases"},{"l":"com.nuix.superutilities.export"},{"l":"com.nuix.superutilities.items"},{"l":"com.nuix.superutilities.loadfiles"},{"l":"com.nuix.superutilities.misc"},{"l":"com.nuix.superutilities.namedentities"},{"l":"com.nuix.superutilities.query"},{"l":"com.nuix.superutilities.regex"},{"l":"com.nuix.superutilities.reporting"}] \ No newline at end of file diff --git a/docs/package-search-index.zip b/docs/package-search-index.zip new file mode 100644 index 0000000..89f216e Binary files /dev/null and b/docs/package-search-index.zip differ diff --git a/docs/resources/glass.png b/docs/resources/glass.png new file mode 100644 index 0000000..a7f591f Binary files /dev/null and b/docs/resources/glass.png differ diff --git a/docs/resources/x.png b/docs/resources/x.png new file mode 100644 index 0000000..30548a7 Binary files /dev/null and b/docs/resources/x.png differ diff --git a/docs/script-dir/external/jquery/jquery.js b/docs/script-dir/external/jquery/jquery.js new file mode 100644 index 0000000..5b16efa --- /dev/null +++ b/docs/script-dir/external/jquery/jquery.js @@ -0,0 +1,10598 @@ +/*! + * jQuery JavaScript Library v3.4.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2019-05-01T21:04Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.4.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code, options ) { + DOMEval( code, { nonce: options && options.nonce } ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.4 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2019-04-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) && + + // Support: IE 8 only + // Exclude object elements + (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && rdescend.test( selector ) ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = (elem.ownerDocument || elem).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( typeof elem.contentDocument !== "undefined" ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
    " ], + col: [ 2, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + } ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + // Support: IE 9-11 only + // Also use offsetWidth/offsetHeight for when box sizing is unreliable + // We use getClientRects() to check for hidden/disconnected. + // In those cases, the computed value can be trusted to be border-box + if ( ( !support.boxSizingReliable() && isBorderBox || + val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url, options ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/docs/script-dir/jszip-utils/dist/jszip-utils-ie.min.js b/docs/script-dir/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 0000000..93d8bc8 --- /dev/null +++ b/docs/script-dir/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/docs/script-dir/jszip-utils/dist/jszip-utils.js b/docs/script-dir/jszip-utils/dist/jszip-utils.js new file mode 100644 index 0000000..775895e --- /dev/null +++ b/docs/script-dir/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var DataLengthProbe = require('./stream/DataLengthProbe'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker : function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if(this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker : function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compresion. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":58}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":59}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with informations about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing informations + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emited metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + this.files = {}; + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.1.5"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var utils = require('./utils'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function(data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function(data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment : input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions : input.unixPermissions, + dosPermissions : input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + // XXX We can't use `Buffer.from` which comes from `Uint8Array.from` + // in nodejs v4 (< v.4.5). It's not the expected implementation (and + // has a different signature). + // see https://github.com/nodejs/node/issues/8053 + // A condition on nodejs' version won't solve the issue as we don't + // control the Buffer polyfills that may or may not be used. + return new Buffer(data, encoding); + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + return new Buffer(size); + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + for (filename in this.files) { + if (!this.files.hasOwnProperty(filename)) { + continue; + } + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is prefered but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('core-js/library/fn/set-immediate'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static informations and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"core-js/library/fn/set-immediate":36}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough informations from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +require('../modules/web.immediate'); +module.exports = require('../modules/_core').setImmediate; +},{"../modules/_core":40,"../modules/web.immediate":56}],37:[function(require,module,exports){ +module.exports = function(it){ + if(typeof it != 'function')throw TypeError(it + ' is not a function!'); + return it; +}; +},{}],38:[function(require,module,exports){ +var isObject = require('./_is-object'); +module.exports = function(it){ + if(!isObject(it))throw TypeError(it + ' is not an object!'); + return it; +}; +},{"./_is-object":51}],39:[function(require,module,exports){ +var toString = {}.toString; + +module.exports = function(it){ + return toString.call(it).slice(8, -1); +}; +},{}],40:[function(require,module,exports){ +var core = module.exports = {version: '2.3.0'}; +if(typeof __e == 'number')__e = core; // eslint-disable-line no-undef +},{}],41:[function(require,module,exports){ +// optional / simple context binding +var aFunction = require('./_a-function'); +module.exports = function(fn, that, length){ + aFunction(fn); + if(that === undefined)return fn; + switch(length){ + case 1: return function(a){ + return fn.call(that, a); + }; + case 2: return function(a, b){ + return fn.call(that, a, b); + }; + case 3: return function(a, b, c){ + return fn.call(that, a, b, c); + }; + } + return function(/* ...args */){ + return fn.apply(that, arguments); + }; +}; +},{"./_a-function":37}],42:[function(require,module,exports){ +// Thank's IE8 for his funny defineProperty +module.exports = !require('./_fails')(function(){ + return Object.defineProperty({}, 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_fails":45}],43:[function(require,module,exports){ +var isObject = require('./_is-object') + , document = require('./_global').document + // in old IE typeof document.createElement is 'object' + , is = isObject(document) && isObject(document.createElement); +module.exports = function(it){ + return is ? document.createElement(it) : {}; +}; +},{"./_global":46,"./_is-object":51}],44:[function(require,module,exports){ +var global = require('./_global') + , core = require('./_core') + , ctx = require('./_ctx') + , hide = require('./_hide') + , PROTOTYPE = 'prototype'; + +var $export = function(type, name, source){ + var IS_FORCED = type & $export.F + , IS_GLOBAL = type & $export.G + , IS_STATIC = type & $export.S + , IS_PROTO = type & $export.P + , IS_BIND = type & $export.B + , IS_WRAP = type & $export.W + , exports = IS_GLOBAL ? core : core[name] || (core[name] = {}) + , expProto = exports[PROTOTYPE] + , target = IS_GLOBAL ? global : IS_STATIC ? global[name] : (global[name] || {})[PROTOTYPE] + , key, own, out; + if(IS_GLOBAL)source = name; + for(key in source){ + // contains in native + own = !IS_FORCED && target && target[key] !== undefined; + if(own && key in exports)continue; + // export native or passed + out = own ? target[key] : source[key]; + // prevent global pollution for namespaces + exports[key] = IS_GLOBAL && typeof target[key] != 'function' ? source[key] + // bind timers to global for call from export context + : IS_BIND && own ? ctx(out, global) + // wrap global constructors for prevent change them in library + : IS_WRAP && target[key] == out ? (function(C){ + var F = function(a, b, c){ + if(this instanceof C){ + switch(arguments.length){ + case 0: return new C; + case 1: return new C(a); + case 2: return new C(a, b); + } return new C(a, b, c); + } return C.apply(this, arguments); + }; + F[PROTOTYPE] = C[PROTOTYPE]; + return F; + // make static versions for prototype methods + })(out) : IS_PROTO && typeof out == 'function' ? ctx(Function.call, out) : out; + // export proto methods to core.%CONSTRUCTOR%.methods.%NAME% + if(IS_PROTO){ + (exports.virtual || (exports.virtual = {}))[key] = out; + // export proto methods to core.%CONSTRUCTOR%.prototype.%NAME% + if(type & $export.R && expProto && !expProto[key])hide(expProto, key, out); + } + } +}; +// type bitmap +$export.F = 1; // forced +$export.G = 2; // global +$export.S = 4; // static +$export.P = 8; // proto +$export.B = 16; // bind +$export.W = 32; // wrap +$export.U = 64; // safe +$export.R = 128; // real proto method for `library` +module.exports = $export; +},{"./_core":40,"./_ctx":41,"./_global":46,"./_hide":47}],45:[function(require,module,exports){ +module.exports = function(exec){ + try { + return !!exec(); + } catch(e){ + return true; + } +}; +},{}],46:[function(require,module,exports){ +// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028 +var global = module.exports = typeof window != 'undefined' && window.Math == Math + ? window : typeof self != 'undefined' && self.Math == Math ? self : Function('return this')(); +if(typeof __g == 'number')__g = global; // eslint-disable-line no-undef +},{}],47:[function(require,module,exports){ +var dP = require('./_object-dp') + , createDesc = require('./_property-desc'); +module.exports = require('./_descriptors') ? function(object, key, value){ + return dP.f(object, key, createDesc(1, value)); +} : function(object, key, value){ + object[key] = value; + return object; +}; +},{"./_descriptors":42,"./_object-dp":52,"./_property-desc":53}],48:[function(require,module,exports){ +module.exports = require('./_global').document && document.documentElement; +},{"./_global":46}],49:[function(require,module,exports){ +module.exports = !require('./_descriptors') && !require('./_fails')(function(){ + return Object.defineProperty(require('./_dom-create')('div'), 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_descriptors":42,"./_dom-create":43,"./_fails":45}],50:[function(require,module,exports){ +// fast apply, http://jsperf.lnkit.com/fast-apply/5 +module.exports = function(fn, args, that){ + var un = that === undefined; + switch(args.length){ + case 0: return un ? fn() + : fn.call(that); + case 1: return un ? fn(args[0]) + : fn.call(that, args[0]); + case 2: return un ? fn(args[0], args[1]) + : fn.call(that, args[0], args[1]); + case 3: return un ? fn(args[0], args[1], args[2]) + : fn.call(that, args[0], args[1], args[2]); + case 4: return un ? fn(args[0], args[1], args[2], args[3]) + : fn.call(that, args[0], args[1], args[2], args[3]); + } return fn.apply(that, args); +}; +},{}],51:[function(require,module,exports){ +module.exports = function(it){ + return typeof it === 'object' ? it !== null : typeof it === 'function'; +}; +},{}],52:[function(require,module,exports){ +var anObject = require('./_an-object') + , IE8_DOM_DEFINE = require('./_ie8-dom-define') + , toPrimitive = require('./_to-primitive') + , dP = Object.defineProperty; + +exports.f = require('./_descriptors') ? Object.defineProperty : function defineProperty(O, P, Attributes){ + anObject(O); + P = toPrimitive(P, true); + anObject(Attributes); + if(IE8_DOM_DEFINE)try { + return dP(O, P, Attributes); + } catch(e){ /* empty */ } + if('get' in Attributes || 'set' in Attributes)throw TypeError('Accessors not supported!'); + if('value' in Attributes)O[P] = Attributes.value; + return O; +}; +},{"./_an-object":38,"./_descriptors":42,"./_ie8-dom-define":49,"./_to-primitive":55}],53:[function(require,module,exports){ +module.exports = function(bitmap, value){ + return { + enumerable : !(bitmap & 1), + configurable: !(bitmap & 2), + writable : !(bitmap & 4), + value : value + }; +}; +},{}],54:[function(require,module,exports){ +var ctx = require('./_ctx') + , invoke = require('./_invoke') + , html = require('./_html') + , cel = require('./_dom-create') + , global = require('./_global') + , process = global.process + , setTask = global.setImmediate + , clearTask = global.clearImmediate + , MessageChannel = global.MessageChannel + , counter = 0 + , queue = {} + , ONREADYSTATECHANGE = 'onreadystatechange' + , defer, channel, port; +var run = function(){ + var id = +this; + if(queue.hasOwnProperty(id)){ + var fn = queue[id]; + delete queue[id]; + fn(); + } +}; +var listener = function(event){ + run.call(event.data); +}; +// Node.js 0.9+ & IE10+ has setImmediate, otherwise: +if(!setTask || !clearTask){ + setTask = function setImmediate(fn){ + var args = [], i = 1; + while(arguments.length > i)args.push(arguments[i++]); + queue[++counter] = function(){ + invoke(typeof fn == 'function' ? fn : Function(fn), args); + }; + defer(counter); + return counter; + }; + clearTask = function clearImmediate(id){ + delete queue[id]; + }; + // Node.js 0.8- + if(require('./_cof')(process) == 'process'){ + defer = function(id){ + process.nextTick(ctx(run, id, 1)); + }; + // Browsers with MessageChannel, includes WebWorkers + } else if(MessageChannel){ + channel = new MessageChannel; + port = channel.port2; + channel.port1.onmessage = listener; + defer = ctx(port.postMessage, port, 1); + // Browsers with postMessage, skip WebWorkers + // IE8 has postMessage, but it's sync & typeof its postMessage is 'object' + } else if(global.addEventListener && typeof postMessage == 'function' && !global.importScripts){ + defer = function(id){ + global.postMessage(id + '', '*'); + }; + global.addEventListener('message', listener, false); + // IE8- + } else if(ONREADYSTATECHANGE in cel('script')){ + defer = function(id){ + html.appendChild(cel('script'))[ONREADYSTATECHANGE] = function(){ + html.removeChild(this); + run.call(id); + }; + }; + // Rest old browsers + } else { + defer = function(id){ + setTimeout(ctx(run, id, 1), 0); + }; + } +} +module.exports = { + set: setTask, + clear: clearTask +}; +},{"./_cof":39,"./_ctx":41,"./_dom-create":43,"./_global":46,"./_html":48,"./_invoke":50}],55:[function(require,module,exports){ +// 7.1.1 ToPrimitive(input [, PreferredType]) +var isObject = require('./_is-object'); +// instead of the ES6 spec version, we didn't implement @@toPrimitive case +// and the second argument - flag - preferred type is a string +module.exports = function(it, S){ + if(!isObject(it))return it; + var fn, val; + if(S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + if(typeof (fn = it.valueOf) == 'function' && !isObject(val = fn.call(it)))return val; + if(!S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + throw TypeError("Can't convert object to primitive value"); +}; +},{"./_is-object":51}],56:[function(require,module,exports){ +var $export = require('./_export') + , $task = require('./_task'); +$export($export.G + $export.B, { + setImmediate: $task.set, + clearImmediate: $task.clear +}); +},{"./_export":44,"./_task":54}],57:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + + + + + +
    + +
    +
    +
    +

    System Properties

    +
    +
    +
    + + + + + + + + +
    System Properties Summary 
    PropertyReferenced In
    +
    +
    +
    + + + diff --git a/docs/type-search-index.js b/docs/type-search-index.js new file mode 100644 index 0000000..f5b108c --- /dev/null +++ b/docs/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes","url":"allclasses-index.html"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationEvent"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationHistoryRepository"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationHistoryRepositorySummary"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationMatchingMethod"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationRepository"},{"p":"com.nuix.superutilities.annotations","l":"AnnotationSyncSettings"},{"p":"com.nuix.superutilities.reporting","l":"AsposeCellsColorHelper"},{"p":"com.nuix.superutilities.reporting","l":"AsposeCellsStyleHelper"},{"p":"com.nuix.superutilities.cases","l":"BulkCaseProcessor"},{"p":"com.nuix.superutilities.annotations","l":"BulkRedactor"},{"p":"com.nuix.superutilities.annotations","l":"BulkRedactorProgressInfo"},{"p":"com.nuix.superutilities.annotations","l":"BulkRedactorSettings"},{"p":"com.nuix.superutilities.cases","l":"CaseConsumer"},{"p":"com.nuix.superutilities.cases","l":"CaseHistoryHelper"},{"p":"com.nuix.superutilities.cases","l":"CaseInfo"},{"p":"com.nuix.superutilities.cases","l":"CaseIssueReaction"},{"p":"com.nuix.superutilities.cases","l":"CaseLockedEventInfo"},{"p":"com.nuix.superutilities.cases","l":"CaseLockInfo"},{"p":"com.nuix.superutilities.cases","l":"CaseOpenErrorEvent"},{"p":"com.nuix.superutilities.cases","l":"CaseUtility"},{"p":"com.nuix.superutilities.export","l":"ChunkedDATExporter"},{"p":"com.nuix.superutilities.export","l":"ChunkedDATExporter.ChunkInfo"},{"p":"com.nuix.superutilities.reporting","l":"ColorRing"},{"p":"com.nuix.superutilities.reporting","l":"ColumnValueGenerator"},{"p":"com.nuix.superutilities.annotations","l":"CustodianEvent"},{"p":"com.nuix.superutilities.export","l":"CustomExporter"},{"p":"com.nuix.superutilities.annotations","l":"CustomMetadataEvent"},{"p":"com.nuix.superutilities.loadfiles","l":"DatLoadFile"},{"p":"com.nuix.superutilities.loadfiles","l":"DatLoadFileReader"},{"p":"com.nuix.superutilities.loadfiles","l":"DatLoadFileWriter"},{"p":"com.nuix.superutilities.misc","l":"DigestList"},{"p":"com.nuix.superutilities.misc","l":"DriveSpaceInfo"},{"p":"com.nuix.superutilities.annotations","l":"ExclusionEvent"},{"p":"com.nuix.superutilities.misc","l":"ExpandedTermInfo"},{"p":"com.nuix.superutilities.misc","l":"FormatUtility"},{"p":"com.nuix.superutilities.misc","l":"FreeSpaceMonitor"},{"p":"com.nuix.superutilities.misc","l":"FreeSpaceMonitorEventCallback"},{"p":"com.nuix.superutilities.misc","l":"FuzzyTermInfo"},{"p":"com.nuix.superutilities.reporting","l":"IntersectionReport"},{"p":"com.nuix.superutilities.reporting","l":"IntersectionReportProgressCallback"},{"p":"com.nuix.superutilities.reporting","l":"IntersectionReportSheetConfiguration"},{"p":"com.nuix.superutilities.regex","l":"ItemRegexMatchCollection"},{"p":"com.nuix.superutilities.annotations","l":"ItemSetEvent"},{"p":"com.nuix.superutilities.export","l":"JsonExporter"},{"p":"com.nuix.superutilities.misc","l":"LevenshteinDistance"},{"p":"com.nuix.superutilities.namedentities","l":"NamedEntityRedactionProgressCallback"},{"p":"com.nuix.superutilities.namedentities","l":"NamedEntityRedactionResults"},{"p":"com.nuix.superutilities.namedentities","l":"NamedEntityRedactionSettings"},{"p":"com.nuix.superutilities.namedentities","l":"NamedEntityUtility"},{"p":"com.nuix.superutilities.reporting","l":"NamedQuery"},{"p":"com.nuix.superutilities.misc","l":"NamedStringList"},{"p":"com.nuix.superutilities.annotations","l":"NuixImageAnnotationRegion"},{"p":"com.nuix.superutilities.misc","l":"NuixVersion"},{"p":"com.nuix.superutilities.loadfiles","l":"OptLoadFile"},{"p":"com.nuix.superutilities.loadfiles","l":"OptRecord"},{"p":"com.nuix.superutilities.regex","l":"PatternInfo"},{"p":"com.nuix.superutilities.misc","l":"PdfUtility"},{"p":"com.nuix.superutilities.export","l":"PdfWorkCache"},{"p":"com.nuix.superutilities.misc","l":"PlaceholderResolver"},{"p":"com.nuix.superutilities.annotations","l":"ProductionSetEvent"},{"p":"com.nuix.superutilities.misc","l":"ProfileDigester"},{"p":"com.nuix.superutilities.query","l":"QueryHelper"},{"p":"com.nuix.superutilities.regex","l":"RegexMatch"},{"p":"com.nuix.superutilities.regex","l":"RegexScanError"},{"p":"com.nuix.superutilities.regex","l":"RegexScanner"},{"p":"com.nuix.superutilities.reporting","l":"ScriptedColumnValueGenerator"},{"p":"com.nuix.superutilities.misc","l":"SimilarityCalculation"},{"p":"com.nuix.superutilities.loadfiles","l":"SimpleTextFileReader"},{"p":"com.nuix.superutilities.loadfiles","l":"SimpleTextFileWriter"},{"p":"com.nuix.superutilities.reporting","l":"SimpleWorksheet"},{"p":"com.nuix.superutilities.reporting","l":"SimpleXlsx"},{"p":"com.nuix.superutilities.misc","l":"SQLiteBacked"},{"p":"com.nuix.superutilities.items","l":"SuperItemUtility"},{"p":"com.nuix.superutilities","l":"SuperUtilities"},{"p":"com.nuix.superutilities.annotations","l":"TagEvent"},{"p":"com.nuix.superutilities.export","l":"TemplateExporter"},{"p":"com.nuix.superutilities.misc","l":"TermExpander"},{"p":"com.nuix.superutilities.cases","l":"WorkFunctionErrorEvent"},{"p":"com.nuix.superutilities.misc","l":"ZipHelper"}] \ No newline at end of file diff --git a/docs/type-search-index.zip b/docs/type-search-index.zip new file mode 100644 index 0000000..3e7f2a5 Binary files /dev/null and b/docs/type-search-index.zip differ