Class NamedMatches

  • All Implemented Interfaces:
    java.lang.Iterable<java.lang.String>, Matches

    public class NamedMatches
    extends java.lang.Object
    implements Matches
    Utility class to help extract the set of sub queries that have matched from a larger query.

    Individual subqueries may be wrapped using wrapQuery(String, Query), and the matching queries for a particular document can then be pulled from the parent Query's Matches object by calling findNamedMatches(Matches)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  NamedMatches.NamedQuery  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Matches in  
      private java.lang.String name  
    • Constructor Summary

      Constructors 
      Constructor Description
      NamedMatches​(java.lang.String name, Matches in)
      Wraps a Matches object and associates a name with it
    • Field Detail

      • name

        private final java.lang.String name
    • Constructor Detail

      • NamedMatches

        public NamedMatches​(java.lang.String name,
                            Matches in)
        Wraps a Matches object and associates a name with it
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of this Matches
      • getMatches

        public MatchesIterator getMatches​(java.lang.String field)
                                   throws java.io.IOException
        Description copied from interface: Matches
        Returns a MatchesIterator over the matches for a single field, or null if there are no matches in that field.
        Specified by:
        getMatches in interface Matches
        Throws:
        java.io.IOException
      • getSubMatches

        public java.util.Collection<Matches> getSubMatches()
        Description copied from interface: Matches
        Returns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty list
        Specified by:
        getSubMatches in interface Matches
      • iterator

        public java.util.Iterator<java.lang.String> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>
      • wrapQuery

        public static Query wrapQuery​(java.lang.String name,
                                      Query in)
        Wrap a Query so that it associates a name with its Matches