QueryElevationComponent.ElevationProvider (Solr 10.0.0 core API)

All Known Implementing Classes:: QueryElevationComponent.DefaultElevationProvider

Enclosing class:: QueryElevationComponent

protected static interface QueryElevationComponent.ElevationProvider

Provides the elevations defined for queries.

Method Summary

Modifier and Type

Method

Description

QueryElevationComponent.Elevation

getElevationForQuery(String queryString)

Gets the elevation associated to the provided query.

int

size()

Gets the number of query elevations in this QueryElevationComponent.ElevationProvider.

Method Details
- getElevationForQuery
  
  QueryElevationComponent.Elevation getElevationForQuery(String queryString)
  
  Gets the elevation associated to the provided query.
  By contract and by design, only one elevation may be associated to a given query (this can be safely verified by an assertion).
  
  Parameters:
  
  queryString - The query string (not analyzed yet, this QueryElevationComponent.ElevationProvider is in charge of analyzing it).
  
  Returns:
  
  The elevation associated with the query; or null if none.
- size
  
  int size()
  
  Gets the number of query elevations in this QueryElevationComponent.ElevationProvider.