Package org.apache.lucene.search
Class NamedMatches
java.lang.Object
org.apache.lucene.search.NamedMatches
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)
-
Constructor Summary
ConstructorDescriptionNamedMatches
(String name, Matches in) Wraps aMatches
object and associates a name with it -
Method Summary
Modifier and TypeMethodDescriptionstatic List<NamedMatches>
findNamedMatches
(Matches matches) Finds allNamedMatches
in aMatches
treegetMatches
(String field) Returns aMatchesIterator
over the matches for a single field, ornull
if there are no matches in that field.getName()
Returns the name of thisMatches
Returns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty listiterator()
static Query
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
-
Constructor Details
-
NamedMatches
Wraps aMatches
object and associates a name with it
-
-
Method Details
-
getName
Returns the name of thisMatches
-
getMatches
Description copied from interface:Matches
Returns aMatchesIterator
over the matches for a single field, ornull
if there are no matches in that field.- Specified by:
getMatches
in interfaceMatches
- Throws:
IOException
-
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 interfaceMatches
-
iterator
-
wrapQuery
Wrap a Query so that it associates a name with itsMatches
-
findNamedMatches
Finds allNamedMatches
in aMatches
tree
-