Package org.codelibs.fess.opensearch.client

Class SearchEngineClient.SearchConditionBuilder

java.lang.Object
org.codelibs.fess.opensearch.client.SearchEngineClient.SearchConditionBuilder
Enclosing class:
SearchEngineClient
public static class SearchEngineClient.SearchConditionBuilder extends Object
Builder class for constructing search conditions and parameters.

  • Field Details

    • searchRequestBuilder

      protected final org.opensearch.action.search.SearchRequestBuilder searchRequestBuilder
      The search request builder being configured

    • query

      protected String query
      The search query string

    • responseFields

      protected String[] responseFields
      Fields to include in the response

    • offset

      protected int offset
      Search result offset (number of results to skip)

    • size

      protected int size
      Maximum number of results to return

    • geoInfo

      protected GeoInfo geoInfo
      Geographic search information

    • facetInfo

      protected FacetInfo facetInfo
      Facet configuration for aggregations

    • highlightInfo

      protected HighlightInfo highlightInfo
      Highlighting configuration

    • similarDocHash

      protected String similarDocHash
      Hash of document for similarity search

    • searchRequestType

      protected SearchRequestParams.SearchRequestType searchRequestType
      Type of search request

    • isScroll

      protected boolean isScroll
      Whether scroll mode is enabled for large result sets

    • trackTotalHits

      protected String trackTotalHits
      Track total hits configuration

    • minScore

      protected Float minScore
      Minimum score threshold for results

  • Method Details

    • builder

      public static SearchEngineClient.SearchConditionBuilder builder(org.opensearch.action.search.SearchRequestBuilder searchRequestBuilder)
      Creates a new SearchConditionBuilder instance.
      Parameters:
      searchRequestBuilder - the search request builder to configure
      Returns:
      a new SearchConditionBuilder instance

    • condition

      public Map<String,Object> condition()
      Gets the current search condition as a map.
      Returns:
      a map containing the search condition parameters

    • query

      public SearchEngineClient.SearchConditionBuilder query(String query)
      Sets the search query string.
      Parameters:
      query - the query string
      Returns:
      this builder for method chaining

    • searchRequestType

      public SearchEngineClient.SearchConditionBuilder searchRequestType(SearchRequestParams.SearchRequestType searchRequestType)
      Sets the search request type.
      Parameters:
      searchRequestType - the search request type
      Returns:
      this builder for method chaining

    • responseFields

      public SearchEngineClient.SearchConditionBuilder responseFields(String[] responseFields)
      Sets the fields to include in the response.
      Parameters:
      responseFields - the fields to include in the response
      Returns:
      this builder for method chaining

    • offset

      public SearchEngineClient.SearchConditionBuilder offset(int offset)
      Sets the search result offset.
      Parameters:
      offset - the number of results to skip
      Returns:
      this builder for method chaining

    • size

      public SearchEngineClient.SearchConditionBuilder size(int size)
      Sets the maximum number of results to return.
      Parameters:
      size - the maximum number of results
      Returns:
      this builder for method chaining

    • geoInfo

      public SearchEngineClient.SearchConditionBuilder geoInfo(GeoInfo geoInfo)
      Sets the geographic search information.
      Parameters:
      geoInfo - the geographic search information
      Returns:
      this builder for method chaining

    • highlightInfo

      public SearchEngineClient.SearchConditionBuilder highlightInfo(HighlightInfo highlightInfo)
      Sets the highlighting information.
      Parameters:
      highlightInfo - the highlighting configuration
      Returns:
      this builder for method chaining

    • similarDocHash

      public SearchEngineClient.SearchConditionBuilder similarDocHash(String similarDocHash)
      Sets the similar document hash for similarity search.
      Parameters:
      similarDocHash - the hash of the document to find similar documents to
      Returns:
      this builder for method chaining

    • facetInfo

      public SearchEngineClient.SearchConditionBuilder facetInfo(FacetInfo facetInfo)
      Sets the facet information for aggregations.
      Parameters:
      facetInfo - the facet configuration
      Returns:
      this builder for method chaining

    • scroll

      public SearchEngineClient.SearchConditionBuilder scroll()
      Enables scroll mode for large result sets.
      Returns:
      this builder for method chaining

    • trackTotalHits

      public SearchEngineClient.SearchConditionBuilder trackTotalHits(String trackTotalHits)
      Sets the track total hits configuration.
      Parameters:
      trackTotalHits - the track total hits setting
      Returns:
      this builder for method chaining

    • minScore

      public SearchEngineClient.SearchConditionBuilder minScore(Float minScore)
      Sets the minimum score threshold for results.
      Parameters:
      minScore - the minimum score threshold
      Returns:
      this builder for method chaining

    • build

      public boolean build()
      Builds the search request with all configured parameters.
      Returns:
      true if the build was successful, false if the query is blank
      Throws:
      ResultOffsetExceededException - if the offset exceeds the maximum allowed
      SearchQueryException - if facet fields are invalid

    • buildMinScore

      protected void buildMinScore(org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the minimum score configuration.
      Parameters:
      fessConfig - the Fess configuration

    • buildTrackTotalHits

      protected void buildTrackTotalHits(org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the track total hits configuration.
      Parameters:
      fessConfig - the Fess configuration

    • buildFacet

      protected void buildFacet(QueryHelper queryHelper, QueryFieldConfig queryFieldConfig, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the facet aggregations.
      Parameters:
      queryHelper - the query helper
      queryFieldConfig - the query field configuration
      fessConfig - the Fess configuration
      Throws:
      SearchQueryException - if facet fields are invalid

    • buildHighlighter

      protected void buildHighlighter(QueryHelper queryHelper, QueryFieldConfig queryFieldConfig, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the highlighting configuration.
      Parameters:
      queryHelper - the query helper
      queryFieldConfig - the query field configuration
      fessConfig - the Fess configuration

    • buildSort

      protected void buildSort(QueryContext queryContext, QueryFieldConfig queryFieldConfig, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the sort configuration.
      Parameters:
      queryContext - the query context
      queryFieldConfig - the query field configuration
      fessConfig - the Fess configuration

    • buildRescorer

      protected void buildRescorer(QueryHelper queryHelper, QueryFieldConfig queryFieldConfig, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the rescorer configuration.
      Parameters:
      queryHelper - the query helper
      queryFieldConfig - the query field configuration
      fessConfig - the Fess configuration

    • buildQueryContext

      protected QueryContext buildQueryContext(QueryHelper queryHelper, QueryFieldConfig queryFieldConfig, org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Builds the query context with all search parameters.
      Parameters:
      queryHelper - the query helper
      queryFieldConfig - the query field configuration
      fessConfig - the Fess configuration
      Returns:
      the built query context

    • getCollapseBuilder

      protected org.opensearch.search.collapse.CollapseBuilder getCollapseBuilder(org.codelibs.fess.mylasta.direction.FessConfig fessConfig)
      Gets the collapse builder for result grouping.
      Parameters:
      fessConfig - the Fess configuration
      Returns:
      the collapse builder