Package com.nuix.superutilities.namedentities

Class NamedEntityRedactionResults

  • public class NamedEntityRedactionResults
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getContentTextUpdatedCount()
      Gets a count of items which had a redacted custom metadata field recorded for the item's content text.
      int getUpdatedItemCount()
      Gets the number of items which had at least one redaction recorded to a custom metadata field.
      java.util.Map<java.lang.String,​java.lang.Integer> getUpdatedProperties()
      Gets a map of properties by name and how many times each property had a redacted custom metadata field recorded for it.
      java.util.Set<java.lang.String> getUpdatedPropertyNames()
      Gets a listing of metadata properties that had a redacted custom metadat field recorded for them at least once.
      void mergeOther​(NamedEntityRedactionResults other)
      Combines counts from another instance into this instance.
      void tallyContentTextUdpated()
      Adds 1 to count of items which had their content text redacted, as obtained by calling getContentTextUpdatedCount().
      void tallyUpdatedItem()
      Adds 1 to updated item count, as obtained by calling getUpdatedItemCount().
      void tallyUpdatedProperty​(java.lang.String propertyName)
      Records that a particular property was recorded and adds 1 to count of times that property was updated.
      java.lang.String toString()
      Generates a string with a handy summary of the results represented by this instance.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NamedEntityRedactionResults

        public NamedEntityRedactionResults()

    • Method Detail

      • tallyUpdatedItem

        public void tallyUpdatedItem()
        Adds 1 to updated item count, as obtained by calling getUpdatedItemCount().

      • tallyContentTextUdpated

        public void tallyContentTextUdpated()
        Adds 1 to count of items which had their content text redacted, as obtained by calling getContentTextUpdatedCount().

      • tallyUpdatedProperty

        public void tallyUpdatedProperty​(java.lang.String propertyName)
        Records that a particular property was recorded and adds 1 to count of times that property was updated. Count of updated properties can later be obtained by calling getUpdatedProperties(). If you are just looking for list of poperty names which were updated you can call getUpdatedPropertyNames().
        Parameters:
        propertyName - The property name to increment the tally for

      • getUpdatedItemCount

        public int getUpdatedItemCount()
        Gets the number of items which had at least one redaction recorded to a custom metadata field.
        Returns:
        The number of items which had at least one redaction recorded to a custom metadata field.

      • getUpdatedProperties

        public java.util.Map<java.lang.String,​java.lang.Integer> getUpdatedProperties()
        Gets a map of properties by name and how many times each property had a redacted custom metadata field recorded for it.
        Returns:
        A map of properties by name and how many times each property had a redacted custom metadata field recorded for it.

      • getUpdatedPropertyNames

        public java.util.Set<java.lang.String> getUpdatedPropertyNames()
        Gets a listing of metadata properties that had a redacted custom metadat field recorded for them at least once.
        Returns:
        A listing of metadata properties that had a redacted custom metadat field recorded for them at least once.

      • getContentTextUpdatedCount

        public int getContentTextUpdatedCount()
        Gets a count of items which had a redacted custom metadata field recorded for the item's content text.
        Returns:
        A count of items which had a redacted custom metadata field recorded for the item's content text.

      • toString

        public java.lang.String toString()
        Generates a string with a handy summary of the results represented by this instance.
        Overrides:
        toString in class java.lang.Object