Package com.nuix.superutilities.regex

Class ItemRegexMatchCollection

  • public class ItemRegexMatchCollection
extends java.lang.Object
    Represents an item and the associated regular expression matches made against it.

    • Constructor Summary

      Constructors 
      Constructor Description
      ItemRegexMatchCollection​(nuix.Item item)
      Creates a new empty instance against the specified item.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMatch​(PatternInfo patternInfo, java.lang.String location, boolean isContentMatch, java.lang.String value, java.lang.String valueContext, int matchStart, int matchEnd)
      Adds a match to this instance.
      java.util.List<RegexMatch> getContentMatches()
      Get the matches associated specifically to the item's content text.
      nuix.Item getItem​(nuix.Case nuixCase)
      Gets the associated item.
      int getMatchCount()
      Gets the number of matches currently associated with this instance.
      java.util.List<RegexMatch> getMatches()
      Gets the matches associated.
      java.util.List<RegexMatch> getPropertyMatches()
      Gets the matches associated specifically to the item's property text.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ItemRegexMatchCollection

        public ItemRegexMatchCollection​(nuix.Item item)
        Creates a new empty instance against the specified item.
        Parameters:
        item - The item to associated.

    • Method Detail

      • getItem

        public nuix.Item getItem​(nuix.Case nuixCase)
        Gets the associated item.
        Parameters:
        nuixCase - The case in which the item resides.
        Returns:
        The associated item.

      • getMatches

        public java.util.List<RegexMatch> getMatches()
        Gets the matches associated.
        Returns:
        The matches associated.

      • getContentMatches

        public java.util.List<RegexMatch> getContentMatches()
        Get the matches associated specifically to the item's content text.
        Returns:
        The matches associated specifically to the item's content text.

      • getPropertyMatches

        public java.util.List<RegexMatch> getPropertyMatches()
        Gets the matches associated specifically to the item's property text.
        Returns:
        The matches associated specifically to the item's property text.

      • addMatch

        public void addMatch​(PatternInfo patternInfo,
                     java.lang.String location,
                     boolean isContentMatch,
                     java.lang.String value,
                     java.lang.String valueContext,
                     int matchStart,
                     int matchEnd)
        Adds a match to this instance.
        Parameters:
        patternInfo - The pattern info which made this match
        location - Location match was made (ex: Content, Property Name)
        isContentMatch - True is this match was made against the item's content text
        value - Value text of the match made.
        valueContext - Contextual text associated with this match (can be empty)
        matchStart - Offset in source text where this match begins
        matchEnd - Offset in source text where this match ends

      • getMatchCount

        public int getMatchCount()
        Gets the number of matches currently associated with this instance.
        Returns:
        The number of matches associated with this instance.