Package org.apache.lucene.search
Class NamedMatches
- java.lang.Object
-
- org.apache.lucene.search.NamedMatches
-
public class NamedMatches extends 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'sMatchesobject by callingfindNamedMatches(Matches)
-
-
Constructor Summary
Constructors Constructor Description NamedMatches(String name, Matches in)Wraps aMatchesobject and associates a name with it
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static List<NamedMatches>findNamedMatches(Matches matches)Finds allNamedMatchesin aMatchestreeMatchesIteratorgetMatches(String field)Returns aMatchesIteratorover the matches for a single field, ornullif there are no matches in that field.StringgetName()Returns the name of thisMatchesCollection<Matches>getSubMatches()Returns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty listIterator<String>iterator()static QuerywrapQuery(String name, Query in)Wrap a Query so that it associates a name with itsMatches-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
getMatches
public MatchesIterator getMatches(String field) throws IOException
Description copied from interface:MatchesReturns aMatchesIteratorover the matches for a single field, ornullif there are no matches in that field.- Specified by:
getMatchesin interfaceMatches- Throws:
IOException
-
getSubMatches
public Collection<Matches> getSubMatches()
Description copied from interface:MatchesReturns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty list- Specified by:
getSubMatchesin interfaceMatches
-
wrapQuery
public static Query wrapQuery(String name, Query in)
Wrap a Query so that it associates a name with itsMatches
-
findNamedMatches
public static List<NamedMatches> findNamedMatches(Matches matches)
Finds allNamedMatchesin aMatchestree
-
-