概要
SearchParams クラスは、パラメーターの設定やパラメーターオブジェクトの追加に使用されます。
コンストラクター (1)
This constructor requires you to specify a Config object.
SearchParams(Config config)コンストラクター (2)
This constructor requires no parameter.
SearchParams()setQuery
メソッド定義
Specifies a query keyword.
SearchParams setQuery(String query)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
query | String | クエリキーワード。 |
getQuery
メソッド定義
Obtains the specified query keyword.
String getQuery()戻り値
指定されたクエリキーワード。型: String。
setFilter
メソッド定義
Specifies a filter condition.
SearchParams setFilter(String filter)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
filter | String | フィルター条件。 |
メソッド定義
setSuggest
Specifies a Suggest object as a query parameter.
SearchParams setSuggest(Suggest suggest)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
suggest | Suggest | Suggest オブジェクト。 |
getSuggest
Obtains the Suggest object that is specified as a query parameter.
Suggest getSuggest()戻り値
クエリパラメーターとして指定された Suggest オブジェクト。型: Suggest。
setConfig
メソッド定義
Specifies a Config object as a query parameter.
SearchParams setConfig(Config config)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
config | Config | Config オブジェクト。 |
getConfig
メソッド定義
Obtains the Config object that is specified as a query parameter.
Config getConfig()戻り値
クエリパラメーターとして指定された Config オブジェクト。型: Config。
addToQueryProcessorNames
メソッド定義
Adds a query analyzer.
void addToQueryProcessorNames(String qpName)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
qpName | String | 追加するクエリアナライザー。 |
setQueryProcessorNames
メソッド定義
Specifies a list of query analyzers as a query parameter.
SearchParams setQueryProcessorNames(List<String> queryProcessorNames)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
queryProcessorNames | List<String> | クエリアナライザーのリスト。 |
getQueryProcessorNames
メソッド定義
Obtains the list of query analyzers that are specified as a query parameter.
List<String> getQueryProcessorNames()戻り値
クエリパラメーターとして指定されたクエリアナライザーのリスト。型: List<String>。
addToAggregates
メソッド定義
Adds an Aggregate object to the current SearchParams object.
void addToAggregates(Aggregate aggregate)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
aggregate | Aggregate | Aggregate オブジェクト。 |
setAggregates
メソッド定義
Specifies a set of Aggregate objects as a query parameter.
SearchParams setAggregates(Set<Aggregate> aggreates)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
aggreates | Set<Aggregate> | クエリパラメーターとして指定する Aggregate オブジェクトのセット。 |
getAggregates
メソッド定義
Obtains the set of Aggregate objects that are specified as a query parameter.
Set<Aggregate> getAggregates()戻り値
クエリパラメーターとして指定された Aggregate オブジェクトのセット。型: Set<Aggregate>。
setDistincts
メソッド定義
Specifies a set of Distinct objects as a query parameter.
SearchParams setDistincts(Set<Distinct> distincts)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
distincts | Set<Distinct> | クエリパラメーターとして指定する Distinct オブジェクトのセット。 |
addToDistincts
メソッド定義
Adds a Distinct object to the current SearchParams object.
void addToDistincts(Distinct distinct)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
distinct | Distinct | Distinct オブジェクト。 |
getDistincts
メソッド定義
Obtains the set of Distinct objects that are specified as a query parameter.
Set<Distinct> getDistincts()戻り値
クエリパラメーターとして指定された Distinct オブジェクトのセット。型: Set<Distinct>。
setRank
メソッド定義
Specifies a Rank object as a query parameter.
SearchParams setRank(Rank rank)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
rank | Rank | Rank オブジェクト。 |
getRank
メソッド定義
Obtains the Rank object that is specified as a query parameter.
Rank getRank()戻り値
クエリパラメーターとして指定された Rank オブジェクト。型: Rank。
setSort
メソッド定義
Specifies a Sort object as a query parameter.
SearchParams setSort(Sort sort)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
sort | Sort | Sort オブジェクト。 |
getSort
メソッド定義
Obtains the Sort object that is specified as a query parameter.
Sort getSort()戻り値
クエリパラメーターとして指定された Sort オブジェクト。型: Sort。
addToSummaries
メソッド定義
Adds a Summary object to the current SearchParams object.
void addToSummaries(Summary summary)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
summary | Summary | Summary オブジェクト。 |
setSummaries
メソッド定義
Specifies a set of Summary objects as a query parameter.
SearchParams setSummaries(Set<Summary> summaries)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
summaries | Set<Summary> | クエリパラメーターとして指定する Summary オブジェクトのセット。 |
getSummaries
メソッド定義
Obtains the set of Summary objects that are specified as a query parameter.
Set<Summary> getSummaries()戻り値
クエリパラメーターとして指定された Summary オブジェクトのセット。型: Set<Summary>。
setDeepPaging
メソッド定義
Specifies a DeepPaging object as a query parameter.
SearchParams setDeepPaging(DeepPaging deepPaging)パラメーターの説明
パラメーター | 型 | 説明 |
|---|---|---|
deepPaging | DeepPaging | DeepPaging オブジェクト。 |
getDeepPaging
メソッド定義
Obtains the DeepPaging object that is specified as a query parameter.
DeepPaging getDeepPaging()戻り値
クエリパラメーターとして指定された DeepPaging オブジェクト。型: DeepPaging。