Interface Matches

  • All Superinterfaces:
    All Known Implementing Classes:

    public interface Matches
    extends Iterable<String>
    Reports the positions and optionally offsets of all matching terms in a query for a single document

    To obtain a MatchesIterator for a particular field, call getMatches(String). Note that you can call getMatches(String) multiple times to retrieve new iterators, but it is not thread-safe.

    WARNING: This API is experimental and might change in incompatible ways in the next release.
    • Method Detail

      • getSubMatches

        Collection<Matches> getSubMatches()
        Returns a collection of Matches that make up this instance; if it is not a composite, then this returns an empty list