diff --git a/.gitignore b/.gitignore index 5177869..46488d6 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,9 @@ Ignored .classpath .project +TestData +TestOutput + # ============= # Maven entries # ============= diff --git a/Java/.gitignore b/Java/.gitignore deleted file mode 100644 index b83d222..0000000 --- a/Java/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/target/ diff --git a/Java/SuperUtilities/.gitignore b/Java/SuperUtilities/.gitignore new file mode 100644 index 0000000..b63da45 --- /dev/null +++ b/Java/SuperUtilities/.gitignore @@ -0,0 +1,42 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/Java/SuperUtilities/.idea/.gitignore b/Java/SuperUtilities/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/Java/SuperUtilities/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/Java/SuperUtilities/.idea/encodings.xml b/Java/SuperUtilities/.idea/encodings.xml new file mode 100644 index 0000000..2241378 --- /dev/null +++ b/Java/SuperUtilities/.idea/encodings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Java/SuperUtilities/.idea/gradle.xml b/Java/SuperUtilities/.idea/gradle.xml new file mode 100644 index 0000000..14746e7 --- /dev/null +++ b/Java/SuperUtilities/.idea/gradle.xml @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Java/SuperUtilities/.idea/misc.xml b/Java/SuperUtilities/.idea/misc.xml new file mode 100644 index 0000000..5d98256 --- /dev/null +++ b/Java/SuperUtilities/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/Java/SuperUtilities/.idea/vcs.xml b/Java/SuperUtilities/.idea/vcs.xml new file mode 100644 index 0000000..b2bdec2 --- /dev/null +++ b/Java/SuperUtilities/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Java/SuperUtilities/build.gradle.kts b/Java/SuperUtilities/build.gradle.kts new file mode 100644 index 0000000..9c6a17d --- /dev/null +++ b/Java/SuperUtilities/build.gradle.kts @@ -0,0 +1,277 @@ +import java.nio.file.Paths +import kotlin.io.path.pathString + +/* +External Configuration Properties +================================= +Below values can be overridden when invoking gradle build using property arguments, for example: + +./gradlew build -Pversion=2.0 + + group => The group ID + version => The version + nuixEngineDir => Overrides value to engine release otherwise pulled from ENV var NUIX_ENGINE_DIR + tempDir => Used to override temp directory for testing which would otherwise default to dir in localappdata + testDataDir => Directory tests can load test data they depend on from + testOutputDirectory => Root directory where tests may write data while running. Each test run will create a timestamp subdirectory + nuixUsername => Username used to authenticate with CLS (Cloud License Server). + Otherwise, would be pulled from ENV var NUIX_USERNAME + nuixPassword => Password used to authenticate with CLS (Cloud License Server). + Otherwise, would be pulled from ENV var NUIX_PASSWORD + gpr.user => GitHub username for retrieving engine wrapper package used in tests. + Otherwise, would be pulled from ENV var GITHUB_USERNAME + gpr.key => GitHub classic token for retrieving engine wrapper package used in tests, needs at least "read:packages" permission. + Otherwise, would be pulled from ENV var GITHUB_TOKEN +*/ + +plugins { + id("java") +} + +// So we don't get "unmappable character for encoding windows-1252" errors on a Windows machine +tasks.compileJava.get().options.encoding = "UTF-8" +tasks.compileTestJava.get().options.encoding = "UTF-8" + +group = findProperty("group") ?: "com.nuix.innovation" +version = findProperty("version") ?: "1.23.0" + +project.extra["nuixEngineDirectory"] = findProperty("nuixEngineDirectory") ?: System.getenv("NUIX_ENGINE_DIR") +if (project.extra["nuixEngineDirectory"].toString().isBlank()) { + throw InvalidUserDataException("Please populate the environment variable 'NUIX_ENGINE_DIR' with directory containing a Nuix Engine release") +} +System.out.println("Resolved 'nuixEngineDirectory': " + project.extra["nuixEngineDirectory"].toString()) + +// Determines where Nuix dependencies can be found and where JARs will be copied to for tasks: +// - copyDependencyJarsToEngine +// - copyJarToEngine +// - copyJarsToEngine (test execution invokes this) +project.extra["engineLibDir"] = Paths.get(project.extra["nuixEngineDirectory"].toString(), "lib").pathString + +// Necessary to be on PATH when test is ran which makes use of Nuix engine +project.extra["engineBinDir"] = Paths.get(project.extra["nuixEngineDirectory"].toString(), "bin").pathString +project.extra["engineBinX86Dir"] = Paths.get(project.extra["nuixEngineDirectory"].toString(), "bin", "x86").pathString + +// Determines destination for tasks: +// - copyDependencyJarsToApp +// - copyJarToApp +// - copyJarsToApp +project.extra["nuixAppLibDir"] = findProperty("nuixAppLibDir") + +// Configures temp directory used in several places during test execution: +// - System property 'java.io.tmpdir' +// - ENV variable 'TEMP' +// - ENV variable 'TMP' +project.extra["nuixTempDirectory"] = findProperty("tempDir") + ?: Paths.get(System.getenv("LOCALAPPDATA"), "Temp", "Nuix").pathString + +// Directory used to store data a test may rely on (like sample data) +project.extra["testDataDirectory"] = findProperty("testDataDirectory") + ?: Paths.get("${projectDir}", "..", "..", "TestData").pathString + +// Directory that tests may write data to, unique to each test invocation +project.extra["testOutputDirectory"] = findProperty("testOutputDirectory") + ?: Paths.get("${projectDir}", "..", "..", "TestOutput", "${System.currentTimeMillis()}") + +repositories { + mavenCentral() + + val github_username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_USERNAME") + val github_token = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN") + + maven { + url = uri("https://maven.pkg.github.com/nuix/nuix-java-engine-baseline") + credentials { + username = github_username + password = github_token + } + } +} + +// Dependencies referenced using this configuration will be copied as part these tasks: +// - CopyDependencyJarsToApp +// - CopyDependencyJarsToEngine +// - copyJarsToApp +// - copyJarsToEngine (Note this is used to get JARs in place before test run) +val deployedDependency: Configuration by configurations.creating { + isTransitive = true +} + +dependencies { + implementation("org.jetbrains.kotlin:kotlin-stdlib:+") + implementation("org.jetbrains:annotations:24.0.1") + compileOnly("org.projectlombok:lombok:1.18.26") + annotationProcessor("org.projectlombok:lombok:1.18.26") + testCompileOnly("org.projectlombok:lombok:1.18.26") + testAnnotationProcessor("org.projectlombok:lombok:1.18.26") + testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.2") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.9.2") + + // Wrapper class for running tests in engine, pulled from public facing GitHub repository + testImplementation("com.nuix.innovation:enginewrapper:Nuix9.10-v1.1.4") + + // Used to extract test data + testImplementation("net.lingala.zip4j:zip4j:2.11.5") + + // Dependencies from engine lib referenced during compile time + + val compileDependencies = arrayOf( + "*joda*.jar", + "nuix-api*.jar", + "nuix-util-*.jar", + "nuix-data-*.jar", + "nuix-scripting-*.jar", + "aspose-cells-*.jar", + "aspose-pdf-*.jar", + "*slf4j*.jar", + "*log4j*.jar", + "*commons-io*.jar", + "*commons-csv*.jar", + "*commons-math*.jar", + "*commons-lang*.jar", + "*commons-text*.jar", + "*commons-compress*.jar", + "RoaringBitmap-*.jar", + "sqlite*.jar", + "guava*.jar", + "gson*.jar", + "jruby*.jar", + "flying-saucer*.jar", + "jaxb*.jar", + "lucene*.jar", + "jsoup*.jar", + "itext*.jar", + "sevenzip*.jar" + ) + val lib = project.extra["engineLibDir"].toString() + compileOnly(fileTree(baseDir = lib) { include(*compileDependencies) }) + testCompileOnly(fileTree(baseDir = lib) { include(*compileDependencies) }) + + // When tests run which make use of NuixEngine wrapper class, it will need to have the + // Nuix Engine dependencies in the lib folder present on the class path + testRuntimeOnly(fileTree(baseDir = project.extra["engineLibDir"].toString()) { + include("*.jar") + }) +} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(11)) + } +} + +fun configureTestEnvironment(test: Test) { + // Args passed to JVM running tests + test.jvmArgs( + "--add-exports=java.base/jdk.internal.loader=ALL-UNNAMED", // Engine 9.6(?) and later require this + "-Xmx4G", + "-Djava.io.tmpdir=\"${project.extra["nuixTempDirectory"]}\"", + // "-verbose:class" // Can help troubleshoot weird dependency issues + ) + + // Configure ENV vars for JVM tests run in + test.setEnvironment( + // Add our engine release's bin and bin/x86 to PATH env var of test JVM process + Pair("PATH", "${System.getenv("PATH")};${project.extra["engineBinDir"]};${project.extra["engineBinX86Dir"]}"), + + // Define where tests can place re-usable test data + Pair("TEST_DATA_DIRECTORY", project.extra["testDataDirectory"]), + + // Define where tests can write output produce for later review + Pair("TEST_OUTPUT_DIRECTORY", project.extra["testOutputDirectory"]), + + // Forward ENV username and password + Pair("NUIX_USERNAME", System.getenv("NUIX_USERNAME")), + Pair("NUIX_PASSWORD", System.getenv("NUIX_PASSWORD")), + + // Forward LOCALAPPDATA and APPDATA + Pair("LOCALAPPDATA", System.getenv("LOCALAPPDATA")), + Pair("APPDATA", System.getenv("APPDATA")), + Pair("PROGRAMDATA", System.getenv("PROGRAMDATA")), + + // Important to have in some instances, otherwise some code may resolve a local + // path in project tree rather than actual system drive + Pair("SYSTEMDRIVE", System.getenv("SYSTEMDRIVE")), + + // We need to make sure we set these so workers will properly resolve temp dir + // (when using a worker based operation via EngineWrapper). + Pair("TEMP", project.extra["nuixTempDirectory"]), + Pair("TMP", project.extra["nuixTempDirectory"]), + + Pair("NUIX_ENGINE_DIR", project.extra["nuixEngineDirectory"]) + ) +} + +// Copies compiled JAR to engine lib directory +tasks.register("copyJarToEngine") { + dependsOn(tasks.jar) + // You will receive implicit dependency errors without this + mustRunAfter(tasks.compileJava, tasks.compileTestJava) + val jarName = "${rootProject.name}.jar" + duplicatesStrategy = DuplicatesStrategy.INCLUDE + from(tasks.jar) + into(Paths.get(project.extra["engineLibDir"].toString()).toFile()) + rename(".*\\.jar", jarName) +} + +// Copies 'deployedDependency' JARs and their transitive JARs to engine lib directory +tasks.register("copyDependencyJarsToEngine") { + // You will receive implicit dependency errors without this + mustRunAfter(tasks.compileJava, tasks.compileTestJava) + duplicatesStrategy = DuplicatesStrategy.INCLUDE + from(configurations.findByName("deployedDependency")) + into(Paths.get(project.extra["engineLibDir"].toString()).toFile()) + rename("(.*)\\.jar", "${rootProject.name}-Dependency-$1.jar") +} + +// Copies JAR and 'deployedDependency' JARs to engine lib directory +// Invoked before tests are ran +tasks.register("copyJarsToEngine") { + println("Copying files to engine lib dir...") + dependsOn("copyJarToEngine") + dependsOn("copyDependencyJarsToEngine") +} + +// Copies compiled JAR to Nuix Workstation lib directory +// as defined by project.extra["nuixAppLibDir"] +tasks.register("copyJarToApp") { + dependsOn(tasks.jar) + val jarName = "${rootProject.name}.jar" + duplicatesStrategy = DuplicatesStrategy.INCLUDE + from(tasks.jar) + into(Paths.get(project.extra["nuixAppLibDir"].toString()).toFile()) + rename(".*\\.jar", jarName) +} + +// Copies 'deployedDependency' JARs and their transitive JARs to Nuix Workstation lib directory +// as defined by project.extra["nuixAppLibDir"] +tasks.register("copyDependencyJarsToApp") { + duplicatesStrategy = DuplicatesStrategy.INCLUDE + from(configurations.findByName("deployedDependency")) + into(Paths.get(project.extra["nuixAppLibDir"].toString()).toFile()) + rename("(.*)\\.jar", "${rootProject.name}-Dependency-$1.jar") +} + +// Copies JAR and 'deployedDependency' JARs to Nuix Workstation lib directory +// as defined by project.extra["nuixAppLibDir"] +tasks.register("copyJarsToApp") { + println("Copying files to app lib dir...") + dependsOn("copyinJarToApp") + dependsOn("copyDependencyJarsToApp") +} + +// Before tests are ran we need to make sure a few things are done: +// - JAR and 'deployedDependency' JARs have been copied to engine lib dir +// - IDE executes our test using JUnit +// - Environment configuration is performed which sets up ENV vars, properties, etc +tasks.test { + dependsOn(tasks.findByName("copyJarsToEngine")) + mustRunAfter("copyDependencyJarsToEngine", "copyJarToEngine") + useJUnitPlatform() + configureTestEnvironment(this) +} + +// Customize where Javadoc output is written to +tasks.getByName("javadoc") { + options.encoding = "UTF-8" + setDestinationDir(Paths.get("$projectDir", "..", "..", "docs").toFile()) +} \ No newline at end of file diff --git a/Java/SuperUtilities/gradle.properties b/Java/SuperUtilities/gradle.properties new file mode 100644 index 0000000..abc009a --- /dev/null +++ b/Java/SuperUtilities/gradle.properties @@ -0,0 +1,2 @@ +nuixEngineDirectory=C:\\EngineRelease\\100.6 +nuixAppLibDir=C:\\Program Files\\Nuix\\Nuix 100.6\\lib \ No newline at end of file diff --git a/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.jar b/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.jar differ diff --git a/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.properties b/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..df6d795 --- /dev/null +++ b/Java/SuperUtilities/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Jan 29 09:34:15 PST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/Java/SuperUtilities/gradlew b/Java/SuperUtilities/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/Java/SuperUtilities/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/Java/SuperUtilities/gradlew.bat b/Java/SuperUtilities/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/Java/SuperUtilities/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/Java/SuperUtilities/settings.gradle.kts b/Java/SuperUtilities/settings.gradle.kts new file mode 100644 index 0000000..b3e46c2 --- /dev/null +++ b/Java/SuperUtilities/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "SuperUtilities" + diff --git a/Java/src/main/java/com/nuix/superutilities/SuperUtilities.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/SuperUtilities.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/SuperUtilities.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/SuperUtilities.java diff --git a/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationEvent.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/annotations/AnnotationEvent.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/annotations/AnnotationEvent.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/annotations/AnnotationEvent.java diff --git a/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java similarity index 99% rename from Java/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java index 621535c..da35517 100644 --- a/Java/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java +++ b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/annotations/AnnotationHistoryRepository.java @@ -855,7 +855,7 @@ private void recordProductionSetEvent(Case nuixCase, HistoryEvent event, Map([a-z0-9]+))~(?([0-1]\\.?[0-9]*)?)",Pattern.CASE_INSENSITIVE); - private static LuceneLevenshteinDistance luceneLevDist = new LuceneLevenshteinDistance(); +// private static LuceneLevenshteinDistance luceneLevDist = new LuceneLevenshteinDistance(); private static JaroWinklerDistance jaroDist = new JaroWinklerDistance(); - private static NGramDistance ngramDist = new NGramDistance(); +// private static NGramDistance ngramDist = new NGramDistance(); public static boolean isFuzzyTerm(String term) { return fuzzyPattern.matcher(term.trim()).find(); @@ -44,16 +42,8 @@ public static FuzzyTermInfo parseFuzzyTerm(String term) { return f; } - public float calculateLuceneLevenshteinSimilarityTo(String otherTerm) { - return luceneLevDist.getDistance(this.term, otherTerm); - } - - public float calculateJaroWinklerSimilarityTo(String otherTerm) { - return jaroDist.getDistance(this.term, otherTerm); - } - - public float calculateNGramSimilarityTo(String otherTerm) { - return ngramDist.getDistance(this.term, otherTerm); + public Double calculateJaroWinklerSimilarityTo(String otherTerm) { + return jaroDist.apply(this.term, otherTerm); } private String term = ""; diff --git a/Java/src/main/java/com/nuix/superutilities/misc/LevenshteinDistance.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/LevenshteinDistance.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/LevenshteinDistance.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/LevenshteinDistance.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/NamedStringList.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/NamedStringList.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/NamedStringList.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/NamedStringList.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/NuixVersion.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/NuixVersion.java similarity index 98% rename from Java/src/main/java/com/nuix/superutilities/misc/NuixVersion.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/NuixVersion.java index 8a5c905..db41423 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/NuixVersion.java +++ b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/NuixVersion.java @@ -78,7 +78,7 @@ public NuixVersion(int majorVersion, int minorVersion, int bugfixVersion, int bu * When providing a version string such as "6.2.1-preview6", "-preview6" will be trimmed off before parsing. * @param versionString The version string to parse. * @return 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 + * an instance representing 900.0.0.0 */ public static NuixVersion parse(String versionString){ try { @@ -101,8 +101,8 @@ public static NuixVersion parse(String versionString){ } }catch(Exception exc){ System.out.println("Error while parsing version: "+versionString); - System.out.println("Pretending version is 100.0.0.0"); - return new NuixVersion(100,0,0,0); + System.out.println("Pretending version is 900.0.0.0"); + return new NuixVersion(900,0,0,0); } } diff --git a/Java/src/main/java/com/nuix/superutilities/misc/PdfUtility.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/PdfUtility.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/PdfUtility.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/PdfUtility.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/PlaceholderResolver.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/PlaceholderResolver.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/PlaceholderResolver.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/PlaceholderResolver.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/SQLiteBacked.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/SQLiteBacked.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/SQLiteBacked.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/SQLiteBacked.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/SimilarityCalculation.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/SimilarityCalculation.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/misc/SimilarityCalculation.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/SimilarityCalculation.java diff --git a/Java/src/main/java/com/nuix/superutilities/misc/TermExpander.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/TermExpander.java similarity index 97% rename from Java/src/main/java/com/nuix/superutilities/misc/TermExpander.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/TermExpander.java index 8158652..f2c3ce0 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/TermExpander.java +++ b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/TermExpander.java @@ -137,7 +137,7 @@ public List expandTerm(Case nuixCase, boolean content, boolean eti.setOriginalTerm(term); eti.setMatchedTerm(termStat.getKey()); eti.setOcurrences(termStat.getValue()); - eti.setSimilarity(0.0f); + eti.setSimilarity(0.0d); result.add(eti); } } else if(FuzzyTermInfo.isFuzzyTerm(term)) { @@ -171,7 +171,7 @@ private void expandWildcardsWithRegex(String term, List result eti.setOriginalTerm(term); eti.setMatchedTerm(termStat.getKey()); eti.setOcurrences(termStat.getValue()); - eti.setSimilarity(0.0f); + eti.setSimilarity(0.0d); result.add(eti); } } @@ -191,13 +191,9 @@ private void expandFuzzyWithSimilarityFiltering(String term, List termStat : allTermStats.entrySet()) { current++; fireProgressUpdated(current, allTermStats.size()); - float similarity = 0.0f; + Double similarity = 0.0d; if(fuzzyResolutionAlgorithm == SimilarityCalculation.JaroWinkler) { similarity = f.calculateJaroWinklerSimilarityTo(termStat.getKey()); - } else if(fuzzyResolutionAlgorithm == SimilarityCalculation.LuceneLevenshstein) { - similarity = f.calculateLuceneLevenshteinSimilarityTo(termStat.getKey()); - } else if(fuzzyResolutionAlgorithm == SimilarityCalculation.NGram) { - similarity = f.calculateNGramSimilarityTo(termStat.getKey()); } if(similarity >= f.getTargetSimilarity()) { @@ -261,7 +257,7 @@ private void expandFuzzyWithNuix(Case nuixCase, boolean content, boolean propert eti.setOriginalTerm(term); eti.setMatchedTerm(distinctTerm); eti.setOcurrences(allTermStats.get(distinctTerm)); - eti.setSimilarity(f.calculateLuceneLevenshteinSimilarityTo(distinctTerm)); + eti.setSimilarity(f.calculateJaroWinklerSimilarityTo(distinctTerm)); result.add(eti); } } diff --git a/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/ZipHelper.java similarity index 95% rename from Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/ZipHelper.java index abf89c6..3c02a00 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/ZipHelper.java +++ b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/ZipHelper.java @@ -14,7 +14,6 @@ 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 { @@ -66,12 +65,17 @@ public static void compressDirectoryToZipFile(String directory, String zipFile, fileOutStream = new FileOutputStream(zipFile); bufferedOutStream = new BufferedOutputStream(fileOutStream); zipStream = new ZipOutputStream(bufferedOutStream); - zipStream.setLevel(Ints.constrainToRange(compressionLevel, 0, 9)); - compressDirectoryToZipfile(directory,directory,zipStream); + zipStream.setLevel(clamp(compressionLevel, 0, 9)); + + compressDirectoryToZipfile(directory,directory,zipStream); } finally { IOUtils.closeQuietly(zipStream); } } + + private static int clamp(int value, int min, int max){ + return Math.max(min, Math.min(max, value)); + } /*** * Recursively adds contents of a directory to a zip file. Based on: diff --git a/Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionProgressCallback.java diff --git a/Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionResults.java diff --git a/Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityRedactionSettings.java diff --git a/Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityUtility.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityUtility.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/namedentities/NamedEntityUtility.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/namedentities/NamedEntityUtility.java diff --git a/Java/src/main/java/com/nuix/superutilities/query/QueryHelper.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/query/QueryHelper.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/query/QueryHelper.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/query/QueryHelper.java diff --git a/Java/src/main/java/com/nuix/superutilities/regex/ItemRegexMatchCollection.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/ItemRegexMatchCollection.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/regex/ItemRegexMatchCollection.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/ItemRegexMatchCollection.java diff --git a/Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/PatternInfo.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/regex/PatternInfo.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/PatternInfo.java diff --git a/Java/src/main/java/com/nuix/superutilities/regex/RegexMatch.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexMatch.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/regex/RegexMatch.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexMatch.java diff --git a/Java/src/main/java/com/nuix/superutilities/regex/RegexScanError.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexScanError.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/regex/RegexScanError.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexScanError.java diff --git a/Java/src/main/java/com/nuix/superutilities/regex/RegexScanner.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexScanner.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/regex/RegexScanner.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/regex/RegexScanner.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/AsposeCellsColorHelper.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/AsposeCellsColorHelper.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/AsposeCellsColorHelper.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/AsposeCellsColorHelper.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/AsposeCellsStyleHelper.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/ColorRing.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ColorRing.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/ColorRing.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ColorRing.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/ColumnValueGenerator.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ColumnValueGenerator.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/ColumnValueGenerator.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ColumnValueGenerator.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReport.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReportProgressCallback.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/IntersectionReportSheetConfiguration.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/NamedQuery.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/NamedQuery.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/NamedQuery.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/NamedQuery.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/SimpleWorksheet.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/SimpleWorksheet.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/SimpleWorksheet.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/SimpleWorksheet.java diff --git a/Java/src/main/java/com/nuix/superutilities/reporting/SimpleXlsx.java b/Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/SimpleXlsx.java similarity index 100% rename from Java/src/main/java/com/nuix/superutilities/reporting/SimpleXlsx.java rename to Java/SuperUtilities/src/main/java/com/nuix/superutilities/reporting/SimpleXlsx.java diff --git a/Java/SuperUtilities/src/test/java/RegexScannerTests.java b/Java/SuperUtilities/src/test/java/RegexScannerTests.java new file mode 100644 index 0000000..69a3b92 --- /dev/null +++ b/Java/SuperUtilities/src/test/java/RegexScannerTests.java @@ -0,0 +1,77 @@ +import com.nuix.innovation.enginewrapper.NuixEngine; +import com.nuix.superutilities.regex.RegexMatch; +import com.nuix.superutilities.regex.RegexScanner; +import nuix.Case; +import nuix.Item; +import nuix.Utilities; +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVPrinter; +import org.junit.jupiter.api.Test; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.Map; + +public class RegexScannerTests extends TestFoundation { + @Test + public void test() throws Exception { + extractTestDataZip("TestCase.zip"); + File testCaseDir = new File(testOutputDirectory, "TestCase"); + File outputCsv = new File(testOutputDirectory, "RegexScannerTest.csv"); + CSVFormat csvFormat = CSVFormat.EXCEL; + + try (NuixEngine nuixEngine = constructNuixEngine()) { + Utilities utilities = nuixEngine.getUtilities(); + try (Case nuixCase = utilities.getCaseFactory().open(testCaseDir, Map.of("migrate", true))) { + List items = nuixCase.search(""); + + RegexScanner scanner = new RegexScanner(); + scanner.setScanProperties(true); + scanner.setScanContent(true); + scanner.setCaseSensitive(false); + scanner.setCaptureContextualText(true); + scanner.setContextSize(30); + + scanner.addPattern("Computer","computer[s]?"); + + try ( + FileWriter fileWriter = new FileWriter(outputCsv, StandardCharsets.UTF_8); + CSVPrinter csvPrinter = new CSVPrinter(fileWriter, csvFormat) + ) { + csvPrinter.printRecord( + "GUID", + "Item Name", + "ItemKind", + "Expression", + "Location", + "Value", + "ValueContext", + "Match Start", + "Match End"); + + scanner.scanItemsParallel(items, itemRegexMatchCollection -> { + Item item = itemRegexMatchCollection.getItem(nuixCase); + for(RegexMatch match : itemRegexMatchCollection.getMatches()) { + try { + csvPrinter.printRecord(item.getGuid(), + item.getLocalisedName(), + item.getType().getKind().getName(), + match.getExpression(), + match.getLocation(), + match.getValue(), + match.getValueContext(), + match.getMatchStart(), + match.getMatchEnd()); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + }); + } + } + } + } +} diff --git a/Java/SuperUtilities/src/test/java/TestFoundation.java b/Java/SuperUtilities/src/test/java/TestFoundation.java new file mode 100644 index 0000000..33b37c6 --- /dev/null +++ b/Java/SuperUtilities/src/test/java/TestFoundation.java @@ -0,0 +1,102 @@ +import com.nuix.innovation.enginewrapper.NuixEngine; +import com.nuix.innovation.enginewrapper.NuixLicenseResolver; +import net.lingala.zip4j.ZipFile; +import nuix.Case; +import nuix.Item; +import nuix.itemtype.ItemTypeBuilder; +import org.apache.logging.log4j.Level; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.core.LoggerContext; +import org.apache.logging.log4j.core.config.Configuration; +import org.apache.logging.log4j.core.config.LoggerConfig; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.IOException; +import java.lang.management.ManagementFactory; +import java.lang.management.RuntimeMXBean; +import java.util.List; +import java.util.Map; + + +public class TestFoundation { + protected static Logger log; + protected static File testOutputDirectory; + protected static File testDataDirectory; + + public boolean isDebuggerAttached() { + boolean debuggerAttached = ManagementFactory.getRuntimeMXBean().getInputArguments().stream() + .anyMatch(arg -> arg.contains("jdwp=") && arg.contains("suspend=y")); + System.out.println("Debugger Attached: " + debuggerAttached); + return debuggerAttached; + } + + public void extractTestDataZip(String fileName) throws Exception { + File testDataZip = new File(testDataDirectory, fileName); + if (!testDataZip.exists()) { + throw new IOException(String.format("Missing '%s', please download from %s and place in the directory %s", + testDataZip.getName(), "TODO", testDataDirectory)); + } + + System.out.println(String.format("Extracting %s to %s", testDataZip, testOutputDirectory)); + new ZipFile(testDataZip).extractAll(testOutputDirectory.getAbsolutePath()); + System.out.println("Extraction completed"); + } + + @BeforeAll + public static void setup() throws Exception { + // Set default level to INFO + LoggerContext ctx = (LoggerContext) LogManager.getContext(false); + Configuration config = ctx.getConfiguration(); + LoggerConfig loggerConfig = config.getLoggerConfig(LogManager.ROOT_LOGGER_NAME); + loggerConfig.setLevel(Level.INFO); + ctx.updateLoggers(); + + log = LoggerFactory.getLogger("Connector Tests"); + + System.out.println("JVM Arguments:"); + RuntimeMXBean bean = ManagementFactory.getRuntimeMXBean(); + List jvmArgs = bean.getInputArguments(); + for (String arg : jvmArgs) { + System.out.println(arg); + } + + System.out.println("Environment Variables:"); + for (Map.Entry entry : System.getenv().entrySet()) { + String varName = entry.getKey(); + String varNameLower = varName.toLowerCase(); + String varValue = entry.getValue(); + if(varNameLower.contains("password") || varNameLower.contains("secret") || varNameLower.contains("token")) { + varValue = varValue.replaceAll(".","*"); + } + System.out.println(String.format("%s => %s", varName, varValue)); + } + + testOutputDirectory = new File(System.getenv("TEST_OUTPUT_DIRECTORY")); + testDataDirectory = new File(System.getenv("TEST_DATA_DIRECTORY")); + } + + @AfterAll + public static void breakdown() { + NuixEngine.closeGlobalContainer(); + } + + public NuixEngine constructNuixEngine(String... additionalRequiredFeatures) { + List features = List.of("CASE_CREATION"); + if (additionalRequiredFeatures != null && additionalRequiredFeatures.length > 0) { + features.addAll(List.of(additionalRequiredFeatures)); + } + + NuixLicenseResolver caseCreationCloud = NuixLicenseResolver.fromCloud() + .withLicenseCredentialsResolvedFromEnvVars() + .withMinWorkerCount(4) + .withRequiredFeatures(features); + + return NuixEngine.usingFirstAvailableLicense(caseCreationCloud) + .setEngineDistributionDirectoryFromEnvVar() + .setLogDirectory(new File(testOutputDirectory, "Logs_" + System.currentTimeMillis())); + } +} diff --git a/Java/pom.xml b/Java/pom.xml deleted file mode 100644 index 88dac8d..0000000 --- a/Java/pom.xml +++ /dev/null @@ -1,8 +0,0 @@ - - 4.0.0 - com.nuix.superutilities - SuperUtilities - 1.0.0 - SuperUtilities - A library of helper methods built on top of the Nuix API - \ No newline at end of file diff --git a/README.MD b/README.MD index bf27a0a..d5086fd 100644 --- a/README.MD +++ b/README.MD @@ -1,7 +1,7 @@ SuperUtilities ============== - + # Overview @@ -13,7 +13,7 @@ View the GitHub project [here](https://github.com/Nuix/SuperUtilities) or downlo View the Java docs [here](https://nuix.github.io/SuperUtilities/). -This is a small library of functionality which is a companion to the functionality already present in the Nuix API. Over the years as I have workendon Nuix scripts, there were certain pieces of functionality I had noticed I was re-writing over and over. With this project my aim was to codify some of that functionality in such a manner that it was reusable and hopefully generic enough that it would be applicable to other scripts down the line. I've also since added some functionality that was needed just in a specific instance but I envisioned it may have usefulness later on as well. Examples of the functionality include: +This is a small library of functionality which is a companion to the functionality already present in the Nuix API. Over the years as I have worked on Nuix scripts, there were certain pieces of functionality I had noticed I was re-writing over and over. With this project my aim was to codify some of that functionality in such a manner that it was reusable and hopefully generic enough that it would be applicable to other scripts down the line. I've also since added some functionality that was needed just in a specific instance but I envisioned it may have usefulness later on as well. Examples of the functionality include: - [NuixVersion](https://nuix.github.io/SuperUtilities/com/nuix/superutilities/misc/NuixVersion.html): Provides a way to test the version of Nuix being ran, allowing you to have code which reacts differently depending on the version of Nuix in use. - [CaseUtility](https://nuix.github.io/SuperUtilities/com/nuix/superutilities/cases/CaseUtility.html): Provides methods for finding case directories and parsing case FBI2 files. @@ -88,12 +88,12 @@ $current_case.close # Building From Source -Load up the code in your favorite IDE and make sure you reference the `\lib\*.jar` from your Nuix install in the build path. +Open the directory `/Java/SuperUtilities` in [IntelliJ IDEA](https://www.jetbrains.com/idea/download). Tests in this project rely on [Nuix Java Engine Baseline](https://github.com/Nuix/Nuix-Java-Engine-Baseline) on GitHub. For details on setting things up, see its [README.MD](https://github.com/Nuix/Nuix-Java-Engine-Baseline?tab=readme-ov-file#nuix-java-engine-baseline). # License ``` -Copyright 2021 Nuix +Copyright 2024 Nuix Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html deleted file mode 100644 index 63952f8..0000000 --- a/docs/allclasses-frame.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -All Classes - - - - -All Classes - - -AnnotationEvent -AnnotationHistoryRepository -AnnotationHistoryRepositorySummary -AnnotationMatchingMethod -AnnotationRepository -AnnotationSyncSettings -AsposeCellsColorHelper -AsposeCellsStyleHelper -BulkCaseProcessor -BulkRedactor -BulkRedactorProgressInfo -BulkRedactorSettings -CaseConsumer -CaseHistoryHelper -CaseInfo -CaseIssueReaction -CaseLockedEventInfo -CaseLockInfo -CaseOpenErrorEvent -CaseUtility -ChunkedDATExporter -ColorRing -ColumnValueGenerator -CustodianEvent -CustomExporter -CustomMetadataEvent -DatLoadFile -DatLoadFileReader -DatLoadFileWriter -DigestList -DriveSpaceInfo -ExclusionEvent -ExpandedTermInfo -FormatUtility -FreeSpaceMonitor -FreeSpaceMonitorEventCallback -FuzzyTermInfo -IntersectionReport -IntersectionReportProgressCallback -IntersectionReportSheetConfiguration -ItemRegexMatchCollection -ItemSetEvent -JsonExporter -LevenshteinDistance -NamedEntityRedactionProgressCallback -NamedEntityRedactionResults -NamedEntityRedactionSettings -NamedEntityUtility -NamedQuery -NamedStringList -NuixImageAnnotationRegion -NuixVersion -OptLoadFile -OptRecord -PatternInfo -PdfUtility -PdfWorkCache -PlaceholderResolver -ProductionSetEvent -ProfileDigester -QueryHelper -RegexMatch -RegexScanError -RegexScanner -ScriptedColumnValueGenerator -SimilarityCalculation -SimpleTextFileReader -SimpleTextFileWriter -SimpleWorksheet -SimpleXlsx -SQLiteBacked -SuperItemUtility -SuperUtilities -TagEvent -TemplateExporter -TermExpander -WorkFunctionErrorEvent -ZipHelper - - - - diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index 73ff2d8..5283966 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -3,36 +3,45 @@ -All Classes - - - +All Classes (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,291 +54,311 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help -SEARCH: + +All Classes + + +SEARCH: + + + + + +JavaScript is disabled on your browser. + - - - + + + + + - All Classes - -All ClassesInterface SummaryClass SummaryEnum Summary - - - + + + +All Classes Interface Summary Class Summary Enum Summary Class Description - - - + 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 @@ -338,178 +367,177 @@ All Classes 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/allclasses-noframe.html b/docs/allclasses.html similarity index 93% rename from docs/allclasses-noframe.html rename to docs/allclasses.html index 391b177..15b36ea 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses.html @@ -1,13 +1,24 @@ - + -All Classes +All Classes (SuperUtilities API) + + + + + + + + + All Classes @@ -91,5 +102,6 @@ All Classes ZipHelper + diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html index 42ef7c1..a6c3f14 100644 --- a/docs/allpackages-index.html +++ b/docs/allpackages-index.html @@ -3,30 +3,39 @@ -All Packages - - - +All Packages (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -39,40 +48,62 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help -SEARCH: + +All Classes + + +SEARCH: + + + + + +JavaScript is disabled on your browser. + - - - + + + + + - All Packages - - + + + Package Summary - Package Description - com.nuix.superutilities @@ -120,7 +151,8 @@ All Packages - + + - - diff --git a/docs/com/nuix/superutilities/SuperUtilities.html b/docs/com/nuix/superutilities/SuperUtilities.html index daa98ad..5d390e5 100644 --- a/docs/com/nuix/superutilities/SuperUtilities.html +++ b/docs/com/nuix/superutilities/SuperUtilities.html @@ -3,36 +3,45 @@ -SuperUtilities - - - +SuperUtilities (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,278 +54,353 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: Nested | Field | -Constr | +Constr | Method Detail: Field | -Constr | +Constr | Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities -Class 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 object with methods to obtain the various other objects. - -Author: -Jason Wells - - - + + + + - - + + + + + + +Constructor Summary + +Constructors + +Modifier +Constructor +Description + + +protected +SuperUtilities() + + + + + + + + + + -Method Summary - -All MethodsStatic MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description - - - + BulkCaseProcessor createBulkCaseProcessor() Creates a new instance of BulkCaseProcessor. - + CaseHistoryHelper createCaseHistoryHelper(nuix.Case nuixCase, -java.util.List<java.lang.String> eventTypes, -org.joda.time.DateTime minStart, -org.joda.time.DateTime maxStart) + java.util.List<java.lang.String> eventTypes, + org.joda.time.DateTime minStart, + org.joda.time.DateTime maxStart) Creates a new instance of CaseHistoryHelper. - + FreeSpaceMonitor createFreeSpaceMonitor() Creates a new instance of FreeSpaceMonitor. - + JsonExporter createJsonExporter() Creates a new instance of JsonExporter - + RegexScanner createRegexScanner() Creates a new instance of RegexScanner - + TemplateExporter createTemplateExporter(java.io.File erbTemplateFile) Creates a new instance of TemplateExporter with a template based on the specified file. - + TemplateExporter createTemplateExporter(java.lang.String erbTemplateFile) Creates a new instance of TemplateExporter with a template based on the specified file. - + static nuix.BulkAnnotater getBulkAnnotater() Convenience method to obtain Nuix BulkAnnotater - + CaseUtility getCaseUtility() Gets singleton of CaseUtility - + static NuixVersion getCurrentVersion() Gets NuixVersion object representing version of Nuix passed into init(Utilities, String) - + FormatUtility getFormatUtility() Gets singleton of FormatUtility - + static SuperUtilities getInstance() Obtains singleton of this class. - + static nuix.ItemUtility getItemUtility() Convenience method to obtain Nuix ItemUtility - + java.io.File getJarDirectory() Get file path of directory in which SuperUtilities.jar resides - + java.lang.String getJarDirectoryPath() Get file path of directory in which SuperUtilities.jar resides - + java.io.File getJarFile() Get file path of SuperUtilities.jar - + java.lang.String getJarFilePath() Get file path of SuperUtilities.jar - + nuix.Utilities getNuixUtilities() Gets the underlying regular API utilities object - + SuperItemUtility getSuperItemUtility() Gets singleton of SuperItemUtility - + static SuperUtilities init(nuix.Utilities util, -java.lang.String nuixVersionString) + java.lang.String nuixVersionString) Initializes this class. - + void saveDiagnostics(java.io.File zipFile) Saves a diagnostics zip file (similar to same operation in the workbench GUI) - + void saveDiagnostics(java.lang.String zipFile) Saves a diagnostics zip file (similar to same operation in the GUI) - - - - -Methods inherited from class java.lang.Object - + + -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - + +Methods inherited from class java.lang.Object +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait + - + + + + - - + + + + + + +Constructor Detail + + + + + +SuperUtilities +protected SuperUtilities() + + + + + + + + + + + +Method Detail + -Method Details - -getInstance -public static SuperUtilities getInstance() +getInstance +public static SuperUtilities getInstance() Obtains singleton of this class. Returns: Singleton of this class - + + + + + - -init -public static SuperUtilities init(nuix.Utilities util, -java.lang.String nuixVersionString) +init +public static SuperUtilities init(nuix.Utilities util, + java.lang.String nuixVersionString) Initializes this class. Parameters: @@ -325,79 +409,100 @@ 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 - + + + + + - -getCaseUtility -public CaseUtility getCaseUtility() +getCaseUtility +public CaseUtility getCaseUtility() Gets singleton of CaseUtility Returns: singleton of CaseUtility - + + + + + - -getSuperItemUtility -public SuperItemUtility getSuperItemUtility() +getSuperItemUtility +public SuperItemUtility getSuperItemUtility() Gets singleton of SuperItemUtility Returns: singleton of SuperItemUtility - + + + + + - -getFormatUtility -public FormatUtility getFormatUtility() +getFormatUtility +public FormatUtility getFormatUtility() Gets singleton of FormatUtility Returns: singleton of FormatUtility - + + + + + - -createRegexScanner -public RegexScanner createRegexScanner() +createRegexScanner +public RegexScanner createRegexScanner() Creates a new instance of RegexScanner Returns: a new instance of RegexScanner - + + + + + - -createJsonExporter -public JsonExporter createJsonExporter() +createJsonExporter +public JsonExporter createJsonExporter() Creates a new instance of JsonExporter Returns: a new instance of JsonExporter - + + + + + - -createTemplateExporter -public TemplateExporter createTemplateExporter(java.io.File erbTemplateFile) - throws java.lang.Exception +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: @@ -407,13 +512,16 @@ createTemplateExporter Throws: java.lang.Exception - if there is an error - + + + + + - -createTemplateExporter -public TemplateExporter createTemplateExporter(java.lang.String erbTemplateFile) - throws java.lang.Exception +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: @@ -423,115 +531,145 @@ createTemplateExporter< Throws: java.lang.Exception - if there is an error - + + + + + - -getCurrentVersion -public static NuixVersion getCurrentVersion() +getCurrentVersion +public static NuixVersion getCurrentVersion() Gets NuixVersion object representing version of Nuix passed into init(Utilities, String) Returns: object representing current version of Nuix - + + + + + - -getJarFilePath -public java.lang.String getJarFilePath() +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 - + + + + + - -createBulkCaseProcessor -public BulkCaseProcessor createBulkCaseProcessor() +createBulkCaseProcessor +public BulkCaseProcessor createBulkCaseProcessor() Creates a new instance of BulkCaseProcessor. Returns: a new instance of BulkCaseProcessor - + + + + + - -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. - + + + + + - -createFreeSpaceMonitor -public FreeSpaceMonitor createFreeSpaceMonitor() +createFreeSpaceMonitor +public FreeSpaceMonitor createFreeSpaceMonitor() Creates a new instance of FreeSpaceMonitor. Returns: a new instance of FreeSpaceMonitor - + + + + + - -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 +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: @@ -546,38 +684,45 @@ See Also: HistoryEvent.getTypeString - + + + + + - -getBulkAnnotater -public static nuix.BulkAnnotater getBulkAnnotater() +getBulkAnnotater +public static nuix.BulkAnnotater getBulkAnnotater() Convenience method to obtain Nuix BulkAnnotater Returns: Nuix BulkAnnotater obtained from Utilities object - + + + + + - -getItemUtility -public static nuix.ItemUtility getItemUtility() +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 3cb18e3..93d5d8d 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationEvent.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationEvent.html @@ -3,36 +3,45 @@ -AnnotationEvent - - - +AnnotationEvent (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,29 +100,36 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class AnnotationEvent +Class AnnotationEvent -java.lang.Object -com.nuix.superutilities.annotations.AnnotationEvent - - + +java.lang.Object + + +com.nuix.superutilities.annotations.AnnotationEvent + + + + + + Direct Known Subclasses: CustodianEvent, CustomMetadataEvent, ExclusionEvent, ItemSetEvent, ProductionSetEvent, TagEvent @@ -98,163 +137,179 @@ Class AnnotationEvent public abstract class AnnotationEvent extends java.lang.Object - - + + + + - - + + + + -Constructor Summary - - +Constructor Summary + Constructors - Constructor Description - - AnnotationEvent() - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsAbstract MethodsConcrete Methods - - - +Method Summary + +All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description - - - + java.util.Collection<nuix.Item> getAssociatedItems(nuix.Case nuixCase) - + java.lang.Integer getExpectedItemCount() - + AnnotationHistoryRepository getSourceRepo() - + org.joda.time.DateTime getTimeStamp() - + abstract void replay(nuix.Case nuixCase) - - - - -Methods inherited from class java.lang.Object - + + -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - + +Methods inherited from class java.lang.Object +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait + - + + + + - - + + + + -Constructor Details - +Constructor Detail + + + + - -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() + + + + + - -getSourceRepo -public AnnotationHistoryRepository getSourceRepo() - +getSourceRepo +public AnnotationHistoryRepository getSourceRepo() + + + + + - -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 77725d7..cb9f4f1 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepository.html @@ -3,36 +3,45 @@ -AnnotationHistoryRepository - - - +AnnotationHistoryRepository (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,29 +100,36 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class AnnotationHistoryRepository +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 @@ -101,29 +140,25 @@ Class AnnotationHist implements java.io.Closeable Class for recording annotation in a source case and replaying on a destination case. GUID is used to record items in source case and match items in destination case. - -Author: -Jason Wells - - - + + + + - - + + + + -Constructor Summary - - +Constructor Summary + Constructors - Constructor Description - - AnnotationHistoryRepository(java.io.File databaseFile) @@ -136,301 +171,301 @@ Constructor Summary Creates a new instance against the given and database file. - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods Instance Methods Concrete Methods Modifier and Type Method Description - - - + AnnotationHistoryRepositorySummary buildSummary() - + org.joda.time.DateTime calculateLastDbEventStart() - + void close() - + void eachRecordedCustodianEvent(long startedAfter, -java.util.function.Consumer<CustodianEvent> callback) + java.util.function.Consumer<CustodianEvent> callback) - + void eachRecordedCustodianEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<CustodianEvent> callback) + java.util.function.Consumer<CustodianEvent> callback) - + void eachRecordedCustomMetadataEvent(long startedAfter, -java.util.function.Consumer<CustomMetadataEvent> callback) + java.util.function.Consumer<CustomMetadataEvent> callback) - + void eachRecordedCustomMetadataEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<CustomMetadataEvent> callback) + java.util.function.Consumer<CustomMetadataEvent> callback) - + void eachRecordedExclusionEvent(long startedAfter, -java.util.function.Consumer<ExclusionEvent> callback) + java.util.function.Consumer<ExclusionEvent> callback) - + void eachRecordedExclusionEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ExclusionEvent> callback) + java.util.function.Consumer<ExclusionEvent> callback) - + void eachRecordedItemSetEvent(long startedAfter, -java.util.function.Consumer<ItemSetEvent> callback) + java.util.function.Consumer<ItemSetEvent> callback) - + void eachRecordedItemSetEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ItemSetEvent> callback) + java.util.function.Consumer<ItemSetEvent> callback) - + void eachRecordedProductionSetEvent(long startedAfter, -java.util.function.Consumer<ProductionSetEvent> callback) + java.util.function.Consumer<ProductionSetEvent> callback) - + void eachRecordedProductionSetEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ProductionSetEvent> callback) + java.util.function.Consumer<ProductionSetEvent> callback) - + void eachRecordedTagEvent(long startedAfter, -java.util.function.Consumer<TagEvent> callback) + java.util.function.Consumer<TagEvent> callback) - + void eachRecordedTagEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<TagEvent> callback) + java.util.function.Consumer<TagEvent> callback) - + void executeInsert(java.lang.String sql, -java.lang.Object... data) + java.lang.Object... data) - + void executeInsert(java.lang.String sql, -java.util.List<java.lang.Object> data) + java.util.List<java.lang.Object> data) Executes an insert query against the SQLite database file - + java.lang.Long executeLongScalar(java.lang.String sql) - + java.lang.Long executeLongScalar(java.lang.String sql, -java.lang.Object... data) + java.lang.Object... data) - + java.lang.Long executeLongScalar(java.lang.String sql, -java.util.List<java.lang.Object> data) + java.util.List<java.lang.Object> data) - + void executeQuery(java.lang.String sql, -java.util.List<java.lang.Object> data, -java.util.function.Consumer<java.sql.ResultSet> resultConsumer) + 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> T executeScalar(java.lang.String sql, -java.lang.Object... data) + java.lang.Object... data) - + java.lang.String executeStringScalar(java.lang.String sql) - + java.lang.String executeStringScalar(java.lang.String sql, -java.lang.Object... data) + java.lang.Object... data) - + java.lang.String executeStringScalar(java.lang.String sql, -java.util.List<java.lang.Object> data) + java.util.List<java.lang.Object> data) - + int executeUpdate(java.lang.String sql) - + int executeUpdate(java.lang.String sql, -java.lang.Object... data) + java.lang.Object... data) - + int executeUpdate(java.lang.String sql, -java.util.List<java.lang.Object> data) + java.util.List<java.lang.Object> data) Executes an update query against the SQLite database file - + int getGuidRefInsertBatchSize() - + java.lang.Long getIntegerInfo(java.lang.String name) - + boolean getSnapshotFirstSync() Gets whether a more succinct snapshot should be created in a new database. - + java.lang.String getTextInfo(java.lang.String name) - + long getTotalEventCount() Returns the total number of event entries in the database file - + void setGuidRefInsertBatchSize(int guidRefInsertBatchSize) - + void setIntegerInfo(java.lang.String name, -java.lang.Long value) + java.lang.Long value) - + void setSnapshotFirstSync(boolean snapshotFirstSync) Sets whether a more succinct snapshot should be created in a new database. - + void setSyncPoint(org.joda.time.DateTime dateTime) - + void setSyncPointFromDestinationCaseLastEvent(nuix.Case nuixCase) - + void setSyncPointToNow() - + void setTextInfo(java.lang.String name, -java.lang.String value) + java.lang.String value) - + void syncHistory(nuix.Case nuixCase, -AnnotationSyncSettings settings) + AnnotationSyncSettings settings) Records annotation event data to the database file. - - - - -Methods inherited from class java.lang.Object - + + -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - + +Methods inherited from class java.lang.Object +clone, equals, finalize, 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. @@ -439,13 +474,16 @@ 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. @@ -454,103 +492,127 @@ 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: @@ -561,37 +623,46 @@ executeUpdateThrows: 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,109 +671,136 @@ executeInsertThrows: 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: @@ -712,13 +810,16 @@ 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: @@ -726,26 +827,32 @@ 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 @@ -764,204 +871,258 @@ + + + - -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) + + + + + - -buildSummary -public AnnotationHistoryRepositorySummary buildSummary() - throws java.sql.SQLException +buildSummary +public AnnotationHistoryRepositorySummary buildSummary() + throws java.sql.SQLException Throws: java.sql.SQLException - + + + + + - -close -public void close() - throws java.io.IOException +close +public void close() + throws java.io.IOException Specified by: close in interface java.lang.AutoCloseable @@ -970,16 +1131,17 @@ close Throws: java.io.IOException - - + + + - + - - diff --git a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html index ddbb8e9..762f348 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationHistoryRepositorySummary.html @@ -3,36 +3,45 @@ -AnnotationHistoryRepositorySummary - - - +AnnotationHistoryRepositorySummary (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,139 +100,150 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class AnnotationHistoryRepositorySummary +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 - - + + + + - - + + + + -Constructor Summary - - +Constructor Summary + Constructors - Constructor Description - - AnnotationHistoryRepositorySummary() - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods Instance Methods Concrete Methods Modifier and Type Method Description - - - + java.lang.String toString() - - - - -Methods inherited from class java.lang.Object - + + -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait - + +Methods inherited from class java.lang.Object +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait + - + + + + - - + + + + -Constructor Details - +Constructor Detail + + + + - -AnnotationHistoryRepositorySummary -public AnnotationHistoryRepositorySummary() - +AnnotationHistoryRepositorySummary +public AnnotationHistoryRepositorySummary() - + + - - + + + -Method Details - +Method Detail + + + + - -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 7c661a8..2776bde 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationMatchingMethod.html @@ -3,36 +3,45 @@ -AnnotationMatchingMethod - - - +AnnotationMatchingMethod (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,18 +54,41 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: -Nested | +Nested | Enum Constants | Field | Method @@ -68,70 +100,67 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Enum AnnotationMatchingMethod +Enum AnnotationMatchingMethod -java.lang.Object -java.lang.Enum<AnnotationMatchingMethod> -com.nuix.superutilities.annotations.AnnotationMatchingMethod - - - + +java.lang.Object + + +java.lang.Enum<AnnotationMatchingMethod> + + +com.nuix.superutilities.annotations.AnnotationMatchingMethod + + + + + + + + All Implemented Interfaces: -java.io.Serializable, java.lang.Comparable<AnnotationMatchingMethod>, java.lang.constant.Constable +java.io.Serializable, java.lang.Comparable<AnnotationMatchingMethod> public enum AnnotationMatchingMethod 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 Description - - GUID @@ -140,37 +169,32 @@ Enum Constant Summary MD5 - - - + + - - + + + -Method Summary - -All MethodsStatic MethodsConcrete Methods - - - +Method Summary + +All Methods Static Methods Concrete Methods Modifier and Type Method Description - - - + static AnnotationMatchingMethod valueOf(java.lang.String name) Returns the enum constant of this type with the specified name. - + static AnnotationMatchingMethod[] values() @@ -178,71 +202,92 @@ Method Summary the order they are declared. - - - - + + + + Methods inherited from class java.lang.Enum - +clone, compareTo, equals, finalize, 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 + - + + + + - - + + + + + + +Enum Constant Detail + -Enum Constant Details - -GUID -public static final AnnotationMatchingMethod GUID - +GUID +public static final AnnotationMatchingMethod GUID + + + + + - -MD5 -public static final AnnotationMatchingMethod MD5 - +MD5 +public static final AnnotationMatchingMethod MD5 - + + - - + + + + + +Method Detail + -Method Details - -values -public static AnnotationMatchingMethod[] values() +values +public static AnnotationMatchingMethod[] values() Returns an array containing the constants of this enum type, in -the order they are declared. +the order they are declared. This method may be used to iterate +over the constants as follows: + +for (AnnotationMatchingMethod c : AnnotationMatchingMethod.values()) + System.out.println(c); + 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 @@ -256,16 +301,17 @@ valueOf java.lang.IllegalArgumentException - if this enum type has no constant with the specified name java.lang.NullPointerException - if the argument is null - - + + + - + + +All Classes + + + + +JavaScript is disabled on your browser. + + Summary: -Nested | +Nested | Enum Constants | Field | Method @@ -303,14 +366,11 @@ valueOf Method - - + - - diff --git a/docs/com/nuix/superutilities/annotations/AnnotationRepository.html b/docs/com/nuix/superutilities/annotations/AnnotationRepository.html index ee2917b..2da0f53 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationRepository.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationRepository.html @@ -3,36 +3,45 @@ -AnnotationRepository - - - +AnnotationRepository (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,31 +100,41 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class AnnotationRepository +Class AnnotationRepository -java.lang.Object -com.nuix.superutilities.misc.SQLiteBacked -com.nuix.superutilities.annotations.AnnotationRepository - - - + +java.lang.Object + + +com.nuix.superutilities.misc.SQLiteBacked + + +com.nuix.superutilities.annotations.AnnotationRepository + + + + + + + + All Implemented Interfaces: java.io.Closeable, java.lang.AutoCloseable @@ -101,29 +143,25 @@ Class AnnotationRepository< public class AnnotationRepository 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 Description - - AnnotationRepository(java.io.File databaseFile) @@ -136,185 +174,187 @@ Constructor Summary Creates a new instance associated to the specified SQLite DB file. - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods Instance Methods Concrete Methods Modifier and Type Method Description - - - + void abort() Signals that you wish to abort. - + void applyMarkupsFromDatabaseToCase(nuix.Case nuixCase, -boolean addToExistingMarkupSet, -AnnotationMatchingMethod matchingMethod) + boolean addToExistingMarkupSet, + AnnotationMatchingMethod matchingMethod) Applies markups present in the SQLite DB file associated to this instance to the provided Nuix case. - + void applyTagsFromDatabaseToCase(nuix.Case nuixCase, -AnnotationMatchingMethod matchingMethod) + AnnotationMatchingMethod matchingMethod) Applies tags to items in the provided case based on tag records in the DB file associated to this instance. - + boolean getAlwaysCreateTagOnImport() Gets whether a tag should always be created even when the source case had no items associated to that tag. - + long getItemId(nuix.Item item) Gets the sequentially assigned ID value from the Item table for a given item based on its GUID. - + long getItemMarkupCount() Gets the number of markups present in the ItemMarkup table. - + long getMarkupSetId(nuix.MarkupSet markupSet) Gets the sequentially assigned ID value from the MarkupSet table for a given markup. - + long getTagId(java.lang.String tagName) Gets the sequentially assigned ID value from the Tag table for a given tag name. - + java.util.List<java.lang.String> getTagsForGuid(java.lang.String guid) Queries the DB for the names of tags associated with the provided GUID. - + java.util.List<java.lang.String> getTagsForMd5(java.lang.String md5) Queries the DB for the names of tags associated with the provided MD5. - + void setAlwaysCreateTagOnImport(boolean alwaysCreateTagOnImport) Sets whether a tag should always be created even when the source case had no items associated to that tag. - + void storeAllMarkupSets(nuix.Case nuixCase) Stores all markup sets found in the provided case to the SQLite DB file. - + void storeAllTags(nuix.Case nuixCase) Stores all tags present in the provided case as records in the DB file. - + void storeMarkupSet(nuix.Case nuixCase, -nuix.MarkupSet markupSet) + nuix.MarkupSet markupSet) Stores a particular markup set present in the provided Nuix case. - + void storeTag(nuix.Case nuixCase, -java.lang.String tagName) + java.lang.String tagName) Stores a specific tag present in the provided case as records in the DB file. - + void whenMessageLogged(java.util.function.Consumer<java.lang.String> callback) Allows you to provide a callback which will be invoked when this instance emits a log message. - + void whenProgressUpdated(java.util.function.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. - - - - + + + + Methods inherited from class com.nuix.superutilities.misc.SQLiteBacked - +close, executeInsert, executeInsert, executeLongScalar, executeLongScalar, executeLongScalar, executeQuery, executeScalar, executeStringScalar, executeStringScalar, executeStringScalar, executeUpdate, executeUpdate, executeUpdate + + + -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 - +clone, equals, finalize, 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: @@ -322,13 +362,16 @@ 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: @@ -336,46 +379,55 @@ 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: @@ -384,13 +436,16 @@ 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: @@ -400,13 +455,16 @@ 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: @@ -416,13 +474,16 @@ 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: @@ -432,15 +493,18 @@ 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: @@ -450,14 +514,17 @@ 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: @@ -466,14 +533,17 @@ 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: @@ -482,15 +552,18 @@ 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: @@ -500,15 +573,18 @@ 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: @@ -518,13 +594,16 @@ 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: @@ -534,13 +613,16 @@ 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: @@ -550,13 +632,16 @@ 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: @@ -564,46 +649,56 @@ 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() +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) +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 3f03e25..9807789 100644 --- a/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html +++ b/docs/com/nuix/superutilities/annotations/AnnotationSyncSettings.html @@ -3,36 +3,45 @@ -AnnotationSyncSettings - - - +AnnotationSyncSettings (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,267 +100,314 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class AnnotationSyncSettings +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 - - + + + + - - + + + + -Constructor Summary - - +Constructor Summary + Constructors - Constructor Description - - AnnotationSyncSettings() - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods Instance Methods Concrete Methods Modifier and Type Method Description - - - + java.lang.String buildSettingsSummary() - + boolean getSyncCustodianEvents() - + boolean getSyncCustomMetadataEvents() - + boolean getSyncExclusionEvents() - + boolean getSyncItemSetEvents() - + boolean getSyncProductionSetEvents() - + boolean getSyncTagEvents() - + void setSyncCustodianEvents(boolean syncCustodianEvents) - + void setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents) - + void setSyncExclusionEvents(boolean syncExclusionEvents) - + void setSyncItemSetEvents(boolean syncItemSetEvents) - + void setSyncProductionSetEvents(boolean syncProductionSetEvents) - + void setSyncTagEvents(boolean syncTagEvents) - - - - -Methods inherited from class java.lang.Object - + + -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait - + +Methods inherited from class java.lang.Object +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait + - + + + + - - + + + + -Constructor Details - +Constructor Detail + + + + - -AnnotationSyncSettings -public AnnotationSyncSettings() - +AnnotationSyncSettings +public AnnotationSyncSettings() - + + - - + + + + + +Method Detail + -Method Details - -getSyncCustomMetadataEvents -public boolean getSyncCustomMetadataEvents() - +getSyncCustomMetadataEvents +public boolean getSyncCustomMetadataEvents() + + + + + - -setSyncCustomMetadataEvents -public void setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents) - +setSyncCustomMetadataEvents +public void setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents) + + + + + - -getSyncTagEvents -public boolean getSyncTagEvents() - +getSyncTagEvents +public boolean getSyncTagEvents() + + + + + - -setSyncTagEvents -public void setSyncTagEvents(boolean syncTagEvents) - +setSyncTagEvents +public void setSyncTagEvents(boolean syncTagEvents) + + + + + - -getSyncItemSetEvents -public boolean getSyncItemSetEvents() - +getSyncItemSetEvents +public boolean getSyncItemSetEvents() + + + + + - -setSyncItemSetEvents -public void setSyncItemSetEvents(boolean syncItemSetEvents) - +setSyncItemSetEvents +public void setSyncItemSetEvents(boolean syncItemSetEvents) + + + + + - -getSyncExclusionEvents -public boolean getSyncExclusionEvents() - +getSyncExclusionEvents +public boolean getSyncExclusionEvents() + + + + + - -setSyncExclusionEvents -public void setSyncExclusionEvents(boolean syncExclusionEvents) - +setSyncExclusionEvents +public void setSyncExclusionEvents(boolean syncExclusionEvents) + + + + + - -getSyncCustodianEvents -public boolean getSyncCustodianEvents() - +getSyncCustodianEvents +public boolean getSyncCustodianEvents() + + + + + - -setSyncCustodianEvents -public void setSyncCustodianEvents(boolean syncCustodianEvents) - +setSyncCustodianEvents +public void setSyncCustodianEvents(boolean syncCustodianEvents) + + + + + - -getSyncProductionSetEvents -public boolean getSyncProductionSetEvents() - +getSyncProductionSetEvents +public boolean getSyncProductionSetEvents() + + + + + - -setSyncProductionSetEvents -public void setSyncProductionSetEvents(boolean syncProductionSetEvents) - +setSyncProductionSetEvents +public void setSyncProductionSetEvents(boolean syncProductionSetEvents) + + + + + - -buildSettingsSummary -public java.lang.String buildSettingsSummary() - +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 4bd378c..fbc0e3f 100644 --- a/docs/com/nuix/superutilities/annotations/BulkRedactor.html +++ b/docs/com/nuix/superutilities/annotations/BulkRedactor.html @@ -3,36 +3,45 @@ -BulkRedactor - - - +BulkRedactor (SuperUtilities API) + - + + - - + + - - + + - - JavaScript is disabled on your browser. - - + + @@ -45,14 +54,37 @@ Overview Package Class -Use Tree Deprecated -Index +Index Help + +All Classes + + +SEARCH: + + + + + + + +JavaScript is disabled on your browser. + + Summary: @@ -68,180 +100,192 @@ Method -SEARCH: - - - - - - + + + + + - - + Package com.nuix.superutilities.annotations -Class BulkRedactor +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. - -Author: -Jason Wells - - - + + + + - - + + + + -Constructor Summary - - +Constructor Summary + Constructors - Constructor Description - - BulkRedactor() - - - + + - - + + + -Method Summary - -All MethodsInstance MethodsConcrete Methods - - - +Method Summary + +All Methods
BulkRedactor.findAndMarkup(Case, BulkRedactorSettings, Collection, int)
BulkCaseProcessor
FreeSpaceMonitor
TermExpander
NamedEntityUtility
NamedEntityUtility.recordRedactedCopies(nuix.Case, NamedEntityRedactionSettings)
RegexScanner
ColumnValueGenerator
public class SuperUtilities extends java.lang.Object
protected
SuperUtilities()
createBulkCaseProcessor()
CaseHistoryHelper
createCaseHistoryHelper(nuix.Case nuixCase, -java.util.List<java.lang.String> eventTypes, -org.joda.time.DateTime minStart, -org.joda.time.DateTime maxStart)
createFreeSpaceMonitor()
JsonExporter
createJsonExporter()
createRegexScanner()
TemplateExporter
createTemplateExporter(java.io.File erbTemplateFile)
createTemplateExporter(java.lang.String erbTemplateFile)
static nuix.BulkAnnotater
getBulkAnnotater()
CaseUtility
getCaseUtility()
static NuixVersion
getCurrentVersion()
NuixVersion
init(Utilities, String)
FormatUtility
getFormatUtility()
static SuperUtilities
getInstance()
static nuix.ItemUtility
getItemUtility()
java.io.File
getJarDirectory()
java.lang.String
getJarDirectoryPath()
getJarFile()
getJarFilePath()
nuix.Utilities
getNuixUtilities()
SuperItemUtility
getSuperItemUtility()
init(nuix.Utilities util, -java.lang.String nuixVersionString)
void
saveDiagnostics(java.io.File zipFile)
saveDiagnostics(java.lang.String zipFile)
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
protected SuperUtilities()
public static SuperUtilities getInstance()
public static SuperUtilities init(nuix.Utilities util, + java.lang.String nuixVersionString)
public nuix.Utilities getNuixUtilities()
public CaseUtility getCaseUtility()
public SuperItemUtility getSuperItemUtility()
public FormatUtility getFormatUtility()
public RegexScanner createRegexScanner()
public JsonExporter createJsonExporter()
public TemplateExporter createTemplateExporter(java.io.File erbTemplateFile) + throws java.lang.Exception
java.lang.Exception
public TemplateExporter createTemplateExporter(java.lang.String erbTemplateFile) + throws java.lang.Exception
public static NuixVersion getCurrentVersion()
public java.lang.String getJarFilePath()
public java.io.File getJarFile()
public java.io.File getJarDirectory()
public java.lang.String getJarDirectoryPath()
public BulkCaseProcessor createBulkCaseProcessor()
public void saveDiagnostics(java.io.File zipFile)
zipFile
public FreeSpaceMonitor createFreeSpaceMonitor()
public void saveDiagnostics(java.lang.String zipFile)
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
public static nuix.BulkAnnotater getBulkAnnotater()
public static nuix.ItemUtility getItemUtility()
CustodianEvent
CustomMetadataEvent
ExclusionEvent
ItemSetEvent
ProductionSetEvent
TagEvent
public abstract class AnnotationEvent extends java.lang.Object
AnnotationEvent()
java.util.Collection<nuix.Item>
getAssociatedItems(nuix.Case nuixCase)
java.lang.Integer
getExpectedItemCount()
AnnotationHistoryRepository
getSourceRepo()
org.joda.time.DateTime
getTimeStamp()
abstract void
replay(nuix.Case nuixCase)
public AnnotationEvent()
public abstract void replay(nuix.Case nuixCase) + throws java.lang.Exception
public java.util.Collection<nuix.Item> getAssociatedItems(nuix.Case nuixCase) + throws java.lang.Exception
public org.joda.time.DateTime getTimeStamp()
public AnnotationHistoryRepository getSourceRepo()
public java.lang.Integer getExpectedItemCount()
java.io.Closeable
java.lang.AutoCloseable
AnnotationHistoryRepository(java.io.File databaseFile)
AnnotationHistoryRepositorySummary
buildSummary()
calculateLastDbEventStart()
close()
eachRecordedCustodianEvent(long startedAfter, -java.util.function.Consumer<CustodianEvent> callback)
eachRecordedCustodianEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<CustodianEvent> callback)
eachRecordedCustomMetadataEvent(long startedAfter, -java.util.function.Consumer<CustomMetadataEvent> callback)
eachRecordedCustomMetadataEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<CustomMetadataEvent> callback)
eachRecordedExclusionEvent(long startedAfter, -java.util.function.Consumer<ExclusionEvent> callback)
eachRecordedExclusionEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ExclusionEvent> callback)
eachRecordedItemSetEvent(long startedAfter, -java.util.function.Consumer<ItemSetEvent> callback)
eachRecordedItemSetEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ItemSetEvent> callback)
eachRecordedProductionSetEvent(long startedAfter, -java.util.function.Consumer<ProductionSetEvent> callback)
eachRecordedProductionSetEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<ProductionSetEvent> callback)
eachRecordedTagEvent(long startedAfter, -java.util.function.Consumer<TagEvent> callback)
eachRecordedTagEvent(org.joda.time.DateTime startedAfter, -java.util.function.Consumer<TagEvent> callback)
executeInsert(java.lang.String sql, -java.lang.Object... data)
executeInsert(java.lang.String sql, -java.util.List<java.lang.Object> data)
java.lang.Long
executeLongScalar(java.lang.String sql)
executeLongScalar(java.lang.String sql, -java.lang.Object... data)
executeLongScalar(java.lang.String sql, -java.util.List<java.lang.Object> data)
executeQuery(java.lang.String sql, -java.util.List<java.lang.Object> data, -java.util.function.Consumer<java.sql.ResultSet> resultConsumer)
<T> T
executeScalar(java.lang.String sql, -java.lang.Object... data)
executeStringScalar(java.lang.String sql)
executeStringScalar(java.lang.String sql, -java.lang.Object... data)
executeStringScalar(java.lang.String sql, -java.util.List<java.lang.Object> data)
int
executeUpdate(java.lang.String sql)
executeUpdate(java.lang.String sql, -java.lang.Object... data)
executeUpdate(java.lang.String sql, -java.util.List<java.lang.Object> data)
getGuidRefInsertBatchSize()
getIntegerInfo(java.lang.String name)
boolean
getSnapshotFirstSync()
getTextInfo(java.lang.String name)
long
getTotalEventCount()
setGuidRefInsertBatchSize(int guidRefInsertBatchSize)
setIntegerInfo(java.lang.String name, -java.lang.Long value)
setSnapshotFirstSync(boolean snapshotFirstSync)
setSyncPoint(org.joda.time.DateTime dateTime)
setSyncPointFromDestinationCaseLastEvent(nuix.Case nuixCase)
setSyncPointToNow()
setTextInfo(java.lang.String name, -java.lang.String value)
syncHistory(nuix.Case nuixCase, -AnnotationSyncSettings settings)
public AnnotationHistoryRepository(java.io.File databaseFile) + throws java.sql.SQLException
java.sql.SQLException
public AnnotationHistoryRepository(java.lang.String databaseFile) + throws java.sql.SQLException
public java.lang.Long getIntegerInfo(java.lang.String name) + throws java.sql.SQLException
public void setIntegerInfo(java.lang.String name, + java.lang.Long value) + throws java.sql.SQLException
public java.lang.String getTextInfo(java.lang.String name) + throws java.sql.SQLException
public void setTextInfo(java.lang.String name, + java.lang.String value) + throws java.sql.SQLException
public void setSyncPointToNow() + throws java.sql.SQLException
public void setSyncPointFromDestinationCaseLastEvent(nuix.Case nuixCase) + throws java.lang.Exception
public void setSyncPoint(org.joda.time.DateTime dateTime) + throws java.lang.Exception
public int executeUpdate(java.lang.String sql, + java.util.List<java.lang.Object> data) + throws java.sql.SQLException
public int executeUpdate(java.lang.String sql, + java.lang.Object... data) + throws java.sql.SQLException
public int executeUpdate(java.lang.String sql) + throws java.sql.SQLException
public void executeInsert(java.lang.String sql, + java.util.List<java.lang.Object> data) + throws java.sql.SQLException
public void executeInsert(java.lang.String sql, + java.lang.Object... data) + throws java.sql.SQLException
public java.lang.Long executeLongScalar(java.lang.String sql, + java.lang.Object... data) + throws java.sql.SQLException
public java.lang.Long executeLongScalar(java.lang.String sql, + java.util.List<java.lang.Object> data) + throws java.sql.SQLException
public java.lang.Long executeLongScalar(java.lang.String sql) + throws java.sql.SQLException
public java.lang.String executeStringScalar(java.lang.String sql, + java.lang.Object... data) + throws java.sql.SQLException
public java.lang.String executeStringScalar(java.lang.String sql, + java.util.List<java.lang.Object> data) + throws java.sql.SQLException
public java.lang.String executeStringScalar(java.lang.String sql) + throws java.sql.SQLException
public <T> T executeScalar(java.lang.String sql, + java.lang.Object... data) + throws java.sql.SQLException
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
public long getTotalEventCount() + throws java.sql.SQLException
public org.joda.time.DateTime calculateLastDbEventStart() + throws java.sql.SQLException
public void syncHistory(nuix.Case nuixCase, + AnnotationSyncSettings settings) + throws java.io.IOException, + java.sql.SQLException
public void eachRecordedTagEvent(long startedAfter, + java.util.function.Consumer<TagEvent> callback) + throws java.sql.SQLException
public void eachRecordedTagEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<TagEvent> callback) + throws java.sql.SQLException
public void eachRecordedExclusionEvent(long startedAfter, + java.util.function.Consumer<ExclusionEvent> callback) + throws java.sql.SQLException
public void eachRecordedExclusionEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<ExclusionEvent> callback) + throws java.sql.SQLException
public void eachRecordedCustomMetadataEvent(long startedAfter, + java.util.function.Consumer<CustomMetadataEvent> callback) + throws java.sql.SQLException
public void eachRecordedCustomMetadataEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<CustomMetadataEvent> callback) + throws java.sql.SQLException
public void eachRecordedItemSetEvent(long startedAfter, + java.util.function.Consumer<ItemSetEvent> callback) + throws java.sql.SQLException
public void eachRecordedItemSetEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<ItemSetEvent> callback) + throws java.sql.SQLException
public void eachRecordedCustodianEvent(long startedAfter, + java.util.function.Consumer<CustodianEvent> callback) + throws java.sql.SQLException
public void eachRecordedCustodianEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<CustodianEvent> callback) + throws java.sql.SQLException
public void eachRecordedProductionSetEvent(long startedAfter, + java.util.function.Consumer<ProductionSetEvent> callback) + throws java.sql.SQLException
public void eachRecordedProductionSetEvent(org.joda.time.DateTime startedAfter, + java.util.function.Consumer<ProductionSetEvent> callback) + throws java.sql.SQLException
public boolean getSnapshotFirstSync()
public void setSnapshotFirstSync(boolean snapshotFirstSync)
snapshotFirstSync
public int getGuidRefInsertBatchSize()
public void setGuidRefInsertBatchSize(int guidRefInsertBatchSize)
public AnnotationHistoryRepositorySummary buildSummary() + throws java.sql.SQLException
public void close() + throws java.io.IOException
close
java.io.IOException
public class AnnotationHistoryRepositorySummary extends java.lang.Object
AnnotationHistoryRepositorySummary()
toString()
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public AnnotationHistoryRepositorySummary()
public java.lang.String toString()
toString
java.lang.Object
java.io.Serializable
java.lang.Comparable<AnnotationMatchingMethod>
java.lang.constant.Constable
public enum AnnotationMatchingMethod extends java.lang.Enum<AnnotationMatchingMethod>
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
GUID
MD5
static AnnotationMatchingMethod
valueOf(java.lang.String name)
static AnnotationMatchingMethod[]
values()
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
getClass, notify, notifyAll, wait, wait, wait
public static final AnnotationMatchingMethod GUID
public static final AnnotationMatchingMethod MD5
public static AnnotationMatchingMethod[] values()
+for (AnnotationMatchingMethod c : AnnotationMatchingMethod.values()) + System.out.println(c); +
public static AnnotationMatchingMethod valueOf(java.lang.String name)
java.lang.IllegalArgumentException
java.lang.NullPointerException
public class AnnotationRepository extends SQLiteBacked
AnnotationRepository(java.io.File databaseFile)
abort()
applyMarkupsFromDatabaseToCase(nuix.Case nuixCase, -boolean addToExistingMarkupSet, -AnnotationMatchingMethod matchingMethod)
applyTagsFromDatabaseToCase(nuix.Case nuixCase, -AnnotationMatchingMethod matchingMethod)
getAlwaysCreateTagOnImport()
getItemId(nuix.Item item)
getItemMarkupCount()
getMarkupSetId(nuix.MarkupSet markupSet)
getTagId(java.lang.String tagName)
java.util.List<java.lang.String>
getTagsForGuid(java.lang.String guid)
getTagsForMd5(java.lang.String md5)
setAlwaysCreateTagOnImport(boolean alwaysCreateTagOnImport)
storeAllMarkupSets(nuix.Case nuixCase)
storeAllTags(nuix.Case nuixCase)
storeMarkupSet(nuix.Case nuixCase, -nuix.MarkupSet markupSet)
storeTag(nuix.Case nuixCase, -java.lang.String tagName)
whenMessageLogged(java.util.function.Consumer<java.lang.String> callback)
whenProgressUpdated(java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> callback)
close, executeInsert, executeInsert, executeLongScalar, executeLongScalar, executeLongScalar, executeQuery, executeScalar, executeStringScalar, executeStringScalar, executeStringScalar, executeUpdate, executeUpdate, executeUpdate
public AnnotationRepository(java.lang.String databaseFile) + throws java.sql.SQLException
public AnnotationRepository(java.io.File databaseFile) + throws java.sql.SQLException
public void whenMessageLogged(java.util.function.Consumer<java.lang.String> callback)
callback
public void whenProgressUpdated(java.util.function.BiConsumer<java.lang.Integer,java.lang.Integer> callback)
public void storeAllMarkupSets(nuix.Case nuixCase) + throws java.io.IOException, + java.sql.SQLException
public long getItemId(nuix.Item item) + throws java.sql.SQLException
public long getMarkupSetId(nuix.MarkupSet markupSet) + throws java.sql.SQLException
public long getTagId(java.lang.String tagName) + throws java.sql.SQLException
public void storeTag(nuix.Case nuixCase, + java.lang.String tagName) + throws java.io.IOException, + java.sql.SQLException
public void storeAllTags(nuix.Case nuixCase) + throws java.io.IOException, + java.sql.SQLException
public void applyTagsFromDatabaseToCase(nuix.Case nuixCase, + AnnotationMatchingMethod matchingMethod) + throws java.sql.SQLException
public void storeMarkupSet(nuix.Case nuixCase, + nuix.MarkupSet markupSet) + throws java.io.IOException, + java.sql.SQLException
public void applyMarkupsFromDatabaseToCase(nuix.Case nuixCase, + boolean addToExistingMarkupSet, + AnnotationMatchingMethod matchingMethod) + throws java.sql.SQLException
public java.util.List<java.lang.String> getTagsForMd5(java.lang.String md5) + throws java.sql.SQLException
public java.util.List<java.lang.String> getTagsForGuid(java.lang.String guid) + throws java.sql.SQLException
public long getItemMarkupCount() + throws java.sql.SQLException
public void abort()
public boolean getAlwaysCreateTagOnImport()
public void setAlwaysCreateTagOnImport(boolean alwaysCreateTagOnImport)
alwaysCreateTagOnImport
public class AnnotationSyncSettings extends java.lang.Object
AnnotationSyncSettings()
buildSettingsSummary()
getSyncCustodianEvents()
getSyncCustomMetadataEvents()
getSyncExclusionEvents()
getSyncItemSetEvents()
getSyncProductionSetEvents()
getSyncTagEvents()
setSyncCustodianEvents(boolean syncCustodianEvents)
setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents)
setSyncExclusionEvents(boolean syncExclusionEvents)
setSyncItemSetEvents(boolean syncItemSetEvents)
setSyncProductionSetEvents(boolean syncProductionSetEvents)
setSyncTagEvents(boolean syncTagEvents)
public AnnotationSyncSettings()
public boolean getSyncCustomMetadataEvents()
public void setSyncCustomMetadataEvents(boolean syncCustomMetadataEvents)
public boolean getSyncTagEvents()
public void setSyncTagEvents(boolean syncTagEvents)
public boolean getSyncItemSetEvents()
public void setSyncItemSetEvents(boolean syncItemSetEvents)
public boolean getSyncExclusionEvents()
public void setSyncExclusionEvents(boolean syncExclusionEvents)
public boolean getSyncCustodianEvents()
public void setSyncCustodianEvents(boolean syncCustodianEvents)
public boolean getSyncProductionSetEvents()
public void setSyncProductionSetEvents(boolean syncProductionSetEvents)
public java.lang.String buildSettingsSummary()
public class BulkRedactor extends java.lang.Object
BulkRedactor()