FieldQuery.QueryPhraseMap (Lucene 10.5.0 highlighter API)
Description: declaration: package: org.apache.lucene.search.vectorhighlight, class: FieldQuery, class: QueryPhraseMap

Package org.apache.lucene.search.vectorhighlight

# Class FieldQuery.QueryPhraseMap

java.lang.Object
org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

Enclosing class:
  `FieldQuery`

public static class FieldQuery.QueryPhraseMap extends Object
Internal structure of a query for highlighting: represents a nested query structure

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `QueryPhraseMap(FieldQuery fieldQuery)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `float`
  `getBoost()`
  `int`
  `getSlop()`
  `FieldQuery.QueryPhraseMap`
  `getTermMap(String term)`
  `int`
  `getTermOrPhraseNumber()`
  `boolean`
  `isTerminal()`
  `boolean`
  `isValidTermOrPhrase(List<FieldTermStack.TermInfo> phraseCandidate)`
  `FieldQuery.QueryPhraseMap`
  `searchPhrase(List<FieldTermStack.TermInfo> phraseCandidate)`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### QueryPhraseMap

    public QueryPhraseMap(FieldQuery fieldQuery)

- ## Method Details

  - ### getTermMap

    public FieldQuery.QueryPhraseMap getTermMap(String term)

  - ### isTerminal

    public boolean isTerminal()

  - ### getSlop

    public int getSlop()

  - ### getBoost

    public float getBoost()

  - ### getTermOrPhraseNumber

    public int getTermOrPhraseNumber()

  - ### searchPhrase

    public FieldQuery.QueryPhraseMap searchPhrase(List<FieldTermStack.TermInfo> phraseCandidate)

  - ### isValidTermOrPhrase

    public boolean isValidTermOrPhrase(List<FieldTermStack.TermInfo> phraseCandidate)