Interface TurSearchEnginePlugin

All Known Implementing Classes:
TurElasticsearchSearchEnginePlugin, TurSolrSearchEnginePlugin
public interface TurSearchEnginePlugin
Interface for search engine plugins that can be used by Turing. Implementations include Solr, Elasticsearch, etc.
Since:
2025.4.4
Author:
Alexandre Oliveira

  • Method Details

    • retrieveSearchResults

      Optional<TurSEResults> retrieveSearchResults(TurSNSiteSearchContext context)
      Retrieves search results from the search engine based on the given context.
      Parameters:
      context - the search context containing site name, locale, and search parameters
      Returns:
      Optional containing search results if successful, empty otherwise

    • retrieveFacetResults

      Optional<TurSEResults> retrieveFacetResults(TurSNSiteSearchContext context, String facetName)
      Retrieves facet results for a specific facet field.
      Parameters:
      context - the search context containing site name, locale, and search parameters
      facetName - the name of the facet to retrieve
      Returns:
      Optional containing search results with facets if successful, empty otherwise

    • getPluginType

      String getPluginType()
      Gets the type identifier of this search engine plugin.
      Returns:
      the plugin type (e.g., "solr", "elasticsearch")