全部產品
Search
文件中心

OpenSearch:SearchParams類

更新時間:Jul 13, 2024

功能簡介

用於設定參數或添加參數對象

建構函式(1)

有參建構函式,在建立對象時指定Config參數對象
SearchParams(Config config)

建構函式(2)

無參建構函式
SearchParams()

設定指定索引欄位範圍的搜尋關鍵詞(query)

介面定義

設定查詢詞
SearchParams    setQuery(String query)

參數描述

參數名稱

類型

描述

query

String

查詢詞


擷取當前指定的查詢詞內容(query)

介面定義

擷取當前指定的查詢詞內容
String    getQuery()

返回結果

  • String 查詢詞


添加查詢過濾規則

介面定義

設定查詢過濾條件
SearchParams    setFilter(String filter)

參數描述

參數名稱

類型

描述

filter

String

查詢過濾條件


介面定義

設定下拉提示對象參數

設定下拉對象
SearchParams    setSuggest(Suggest suggest)

參數描述

參數名稱

類型

描述

suggest

Suggest

下拉提示參數對象


擷取下拉提示對象參數

擷取下拉對象
Suggest    getSuggest()

返回結果

  • Suggest 下拉提示對象


添加Config 對象參數

介面定義

設定查詢Config對象參數
SearchParams    setConfig(Config config)

參數描述

參數名稱

類型

描述

config

Config

Config配置參數對象


擷取Config 對象參數

介面定義

擷取Config對象參數
Config    getConfig()

返回結果

  • Config 配置參數對象


添加查詢分析規則名稱

介面定義

添加查詢分析
void    addToQueryProcessorNames(String qpName)

參數描述

參數名稱

類型

描述

qpName

String

查詢分析名稱


設定查詢分析規則名稱列表

介面定義

添加查詢分析
SearchParams    setQueryProcessorNames(List<String> queryProcessorNames)

參數描述

參數名稱

類型

描述

queryProcessorNames

List<String>

查詢分析名稱列表


擷取查詢分析規則列表

介面定義

添加查詢分析
List<String>    getQueryProcessorNames()

返回結果

  • List<String> 查詢分析規則列表


添加統計對象參數

介面定義

設定下拉對象
void    addToAggregates(Aggregate aggregate)

參數描述

參數名稱

類型

描述

aggregate

Aggregate

統計對象參數


添加統計參數集合對象

介面定義

設定統計參數
SearchParams    setAggregates(Set<Aggregate> aggreates)

參數描述

參數名稱

類型

描述

aggreates

Set<Aggregate>

aggreate對象集合


擷取統計參數對象集合

介面定義

擷取統計參數對象集合
Set<Aggregate>    getAggregates()

返回結果

  • Set<Aggregate> 統計參數對象集合


添加打散參數對象集合

介面定義

設定打散條件
SearchParams    setDistincts(Set<Distinct> distincts)

參數描述

參數名稱

類型

描述

distincts

Set<Distinct>

distinct對象集合


添加打散參數對象

介面定義

設定打散條件
void    addToDistincts(Distinct distinct)

參數描述

參數名稱

類型

描述

distinct

Distinct

distinct對象


擷取打散參數對象集合

介面定義

擷取打散參數對象集合
Set<Distinct>    getDistincts()

返回結果

  • Set<Distinct> 打散參數對象集合


添加粗精排規則對象

介面定義

設定Rank粗精排規則對象
SearchParams    setRank(Rank rank)

參數描述

參數名稱

類型

描述

rank

Rank

Rank粗精排規則對象


擷取粗精排規則對象

介面定義

擷取Rank粗精排規則對象
Rank    getRank()

返回結果

  • Rank 粗精排規則對象


添加排序對象

介面定義

設定排序參數
SearchParams    setSort(Sort sort)

參數描述

參數名稱

類型

描述

sort

Sort

sort排序對象


擷取排序對象

介面定義

擷取排序對象
Sort    getSort()

返回結果

  • Sort 排序對象


添加摘要參數集合對象

介面定義

設定摘要參數
void    addToSummaries(Summary summary)

參數描述

參數名稱

類型

描述

summary

Summary

摘要參數對象


設定摘要參數集合對象集合

介面定義

設定摘要參數
SearchParams    setSummaries(Set<Summary> summaries)

參數描述

參數名稱

類型

描述

summaries

Set<Summary>

摘要參數對象集合


擷取摘要參數對象

介面定義

擷取摘要參數
Set<Summary>    getSummaries()

返回結果

  • Set<Summary> 摘要參數對象集合


設定DeepPaging參數對象

介面定義

設定DeepPaging參數對象
SearchParams    setDeepPaging(DeepPaging deepPaging)

參數描述

參數名稱

類型

描述

deepPaging

DeepPaging

DeepPaging對象


擷取DeepPaging參數對象

介面定義

擷取DeepPaging參數對象
DeepPaging    getDeepPaging()

返回結果

  • DeepPaging 參數對象