diff --git a/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java b/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java index a31bf71..85d232c 100644 --- a/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java +++ b/Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java @@ -19,6 +19,11 @@ import nuix.ItemEventCallback; import nuix.ItemEventInfo; +/*** + * 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. + * @author Jason Wells + * + */ public class ProfileDigester { private static Logger logger = Logger.getLogger(ProfileDigester.class); @@ -70,7 +75,7 @@ public void whenMessageLogged(Consumer callback) { /*** * Invoked when an error occurs in {@link #addItemsToItemSet(Case, String, String, Collection)}. Provides a message String and the item being processed when * the error occurred. If callback is not provided, message will instead be sent to Nuix log. - * @param callback + * @param callback Callback invoked when an error occurs. If a callback is not provided, message is instead sent to Nuix log as an error. */ public void whenErrorLogged(BiConsumer callback) { errorCallback = callback; @@ -88,7 +93,7 @@ public ProfileDigester() {} * @param itemSetName Name of item set. If item set already exists, existing item set will be used, if not one will be created. Important: when * adding items to an existing item set, it is important that items previously added to that item set were added using this method, the same metadata profile * and same setting for includeItemText, otherwise deduplication results are undefined. - * @param deduplicateBy Valid options are "INDIVIDUAL" and "FAMILY", these settings correspond to the behaviors noted in addItems(Collection items, Map options). + * @param deduplicateBy Valid options are "INDIVIDUAL" and "FAMILY", these settings correspond to the behaviors noted in addItems(Collection<Item> items, Map<?,?> options). * @param items The items to add to the item set. * @return The item set the items were added to. */ diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index a41a226..fb5ad38 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -69,6 +69,7 @@

All Classes

  • PdfWorkCache
  • PlaceholderResolver
  • ProductionSetEvent
  • +
  • ProfileDigester
  • QueryHelper
  • RegexMatch
  • RegexScanError
  • diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index f2c76cf..c12f3b7 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -69,6 +69,7 @@

    All Classes

  • PdfWorkCache
  • PlaceholderResolver
  • ProductionSetEvent
  • +
  • ProfileDigester
  • QueryHelper
  • RegexMatch
  • RegexScanError
  • diff --git a/docs/com/nuix/superutilities/misc/FormatUtility.html b/docs/com/nuix/superutilities/misc/FormatUtility.html index f6c7172..0f95411 100644 --- a/docs/com/nuix/superutilities/misc/FormatUtility.html +++ b/docs/com/nuix/superutilities/misc/FormatUtility.html @@ -175,7 +175,7 @@

    Method Summary

    java.lang.String convertToString(java.lang.Object value)
    Attempts to convert data types, which may be values of metadata properties - or custom meta data, to a String.
    + or custom metadata, to a String. @@ -345,7 +345,7 @@

    bytesToHex

    convertToString

    public java.lang.String convertToString(java.lang.Object value)
    Attempts to convert data types, which may be values of metadata properties - or custom meta data, to a String. Data types supported: + or custom metadata, to a String. Data types supported: - String - Integer - Long Integer diff --git a/docs/com/nuix/superutilities/misc/PlaceholderResolver.html b/docs/com/nuix/superutilities/misc/PlaceholderResolver.html index ee0c8f8..afcd126 100644 --- a/docs/com/nuix/superutilities/misc/PlaceholderResolver.html +++ b/docs/com/nuix/superutilities/misc/PlaceholderResolver.html @@ -49,7 +49,7 @@
    convertWorkerItemToJsonString(WorkerItem) - Method in class com.nuix.superutilities.export.JsonExporter
    diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 734a02e..c0fdf70 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -77,6 +77,14 @@

    G

    Generates a new report sheet using the row criteria, column criteria and value generators currently assigned to this instance
    +
    generateMd5Bytes(Item) - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    +
    Generates MD5 digest byte array for a given item.
    +
    +
    generateMd5String(Item) - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    +
    Generates MD5 digest hex string for a given item.
    +
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ColumnValueGenerator
     
    generateValue(Case, String) - Method in class com.nuix.superutilities.reporting.ScriptedColumnValueGenerator
    @@ -343,6 +351,10 @@

    G

    Gets whether item custom metadata will be included in generated JSON
    +
    getIncludeItemText() - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    +
    Gets whether this instance should include the item's content text when calculating a digest.
    +
    getIncludeParentGuid() - Method in class com.nuix.superutilities.export.JsonExporter
    @@ -557,6 +569,10 @@

    G

    Gets the metadata profile which will be used during export.
    +
    getProfile() - Method in class com.nuix.superutilities.misc.ProfileDigester
    +
    +
    Gets the metadata profile used to obtain the values provided to the hash computation.
    +
    getPropertiesToScan() - Method in class com.nuix.superutilities.regex.RegexScanner
     
    getPropertyMatches() - Method in class com.nuix.superutilities.regex.ItemRegexMatchCollection
    diff --git a/docs/overview-tree.html b/docs/overview-tree.html index d22c2e1..74f921b 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -149,6 +149,7 @@

    Class Hierarchy

  • com.nuix.superutilities.misc.PdfUtility
  • com.nuix.superutilities.export.PdfWorkCache
  • com.nuix.superutilities.misc.PlaceholderResolver
  • +
  • com.nuix.superutilities.misc.ProfileDigester
  • com.nuix.superutilities.query.QueryHelper
  • com.nuix.superutilities.regex.RegexMatch
  • com.nuix.superutilities.regex.RegexScanError