Package org.codelibs.fess.entity

Class SearchRequestParams

java.lang.Object
org.codelibs.fess.entity.SearchRequestParams
Direct Known Subclasses:
ChatClient.ChatSearchRequestParams, ListForm, RankFusionProcessor.SearchRequestParamsWrapper, SearchForm, V2JsonRequestParams
public abstract class SearchRequestParams extends Object
The search request parameters.

  • Field Details

  • Constructor Details

    • SearchRequestParams

      protected SearchRequestParams()
      Default constructor.

  • Method Details

    • getQuery

      public abstract String getQuery()
      Returns the query.
      Returns:
      The query.

    • getFields

      public abstract Map<String,String[]> getFields()
      Returns the fields.
      Returns:
      The fields.

    • getConditions

      public abstract Map<String,String[]> getConditions()
      Returns the conditions.
      Returns:
      The conditions.

    • getLanguages

      public abstract String[] getLanguages()
      Returns the languages.
      Returns:
      The languages.

    • getGeoInfo

      public abstract GeoInfo getGeoInfo()
      Returns the geo info.
      Returns:
      The geo info.

    • getFacetInfo

      public abstract FacetInfo getFacetInfo()
      Returns the facet info.
      Returns:
      The facet info.

    • getHighlightInfo

      public abstract HighlightInfo getHighlightInfo()
      Returns the highlight info.
      Returns:
      The highlight info.

    • getSort

      public abstract String getSort()
      Returns the sort.
      Returns:
      The sort.

    • getStartPosition

      public abstract int getStartPosition()
      Returns the start position.
      Returns:
      The start position.

    • getPageSize

      public abstract int getPageSize()
      Returns the page size.
      Returns:
      The page size.

    • getOffset

      public abstract int getOffset()
      Returns the offset.
      Returns:
      The offset.

    • getExtraQueries

      public abstract String[] getExtraQueries()
      Returns the extra queries.
      Returns:
      The extra queries.

    • getAttribute

      public abstract Object getAttribute(String name)
      Returns the attribute.
      Parameters:
      name - The name of the attribute.
      Returns:
      The attribute.

    • getLocale

      public abstract Locale getLocale()
      Returns the locale.
      Returns:
      The locale.

    • getType

      public abstract SearchRequestParams.SearchRequestType getType()
      Returns the search request type.
      Returns:
      The search request type.

    • getSimilarDocHash

      public abstract String getSimilarDocHash()
      Returns the similar document hash.
      Returns:
      The similar document hash.

    • getTrackTotalHits

      public String getTrackTotalHits()
      Returns the track total hits.
      Returns:
      The track total hits.

    • getMinScore

      public Float getMinScore()
      Returns the min score.
      Returns:
      The min score.

    • hasConditionQuery

      public boolean hasConditionQuery()
      Returns true if the request has a condition query, otherwise false.
      Returns:
      True if the request has a condition query, otherwise false.

    • isEmptyArray

      protected boolean isEmptyArray(String[] values)
      Returns true if the array is empty, otherwise false.
      Parameters:
      values - The array.
      Returns:
      True if the array is empty, otherwise false.

    • simplifyArray

      protected static String[] simplifyArray(String[] values)
      Simplifies the array.
      Parameters:
      values - The array.
      Returns:
      The simplified array.

    • getParamValueArray

      public static String[] getParamValueArray(jakarta.servlet.http.HttpServletRequest request, String param)
      Returns the parameter value array.
      Parameters:
      request - The request.
      param - The parameter.
      Returns:
      The parameter value array.

    • createFacetInfo

      protected FacetInfo createFacetInfo(jakarta.servlet.http.HttpServletRequest request)
      Creates a facet info.
      Parameters:
      request - The request.
      Returns:
      The facet info.

    • createGeoInfo

      protected GeoInfo createGeoInfo(jakarta.servlet.http.HttpServletRequest request)
      Creates a geo info.
      Parameters:
      request - The request.
      Returns:
      The geo info.

    • getResponseFields

      public String[] getResponseFields()
      Returns the response fields.
      Returns:
      The response fields.