core/org.gnit.lucenekmp.search/NamedMatches

NamedMatches

class NamedMatches(val name: String, in: Matches) : 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], and the matching queries for a particular document can then be pulled from the parent [Query]'s [Matches] object by calling [findNamedMatches].

Constructors

NamedMatches

constructor(name: String, in: Matches)

Types

Companion

object Companion

Properties

name

val name: String

Returns the name of this Matches

subMatches

open override val subMatches: MutableCollection<Matches>

Returns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty list

Functions

getMatches

open override fun getMatches(field: String): MatchesIterator?

Returns a MatchesIterator over the matches for a single field, or null if there are no matches in that field.

iterator

open operator override fun iterator(): Iterator<String>