Overview
The SearchParams class is used to configure parameters or add parameter objects.
Constructor (1)
This constructor requires you to specify a Config object.
SearchParams(Config config)Constructor (2)
This constructor requires no parameter.
SearchParams()setQuery
Method definition
Specifies a query keyword.
SearchParams setQuery(String query)Parameter description
Parameter | Type | Description |
|---|---|---|
query | String | The query keyword. |
getQuery
Method definition
Obtains the specified query keyword.
String getQuery()Return value
The specified query keyword. Type: String.
setFilter
Method definition
Specifies a filter condition.
SearchParams setFilter(String filter)Parameter description
Parameter | Type | Description |
|---|---|---|
filter | String | The filter condition. |
Method definition
setSuggest
Specifies a Suggest object as a query parameter.
SearchParams setSuggest(Suggest suggest)Parameter description
Parameter | Type | Description |
|---|---|---|
suggest | Suggest | The Suggest object. |
getSuggest
Obtains the Suggest object that is specified as a query parameter.
Suggest getSuggest()Return value
The Suggest object that is specified as a query parameter. Type: Suggest.
setConfig
Method definition
Specifies a Config object as a query parameter.
SearchParams setConfig(Config config)Parameter description
Parameter | Type | Description |
|---|---|---|
config | Config | The Config object. |
getConfig
Method definition
Obtains the Config object that is specified as a query parameter.
Config getConfig()Return value
The Config object that is specified as a query parameter. Type: Config.
addToQueryProcessorNames
Method definition
Adds a query analyzer.
void addToQueryProcessorNames(String qpName)Parameter description
Parameter | Type | Description |
|---|---|---|
qpName | String | The query analyzer to be added. |
setQueryProcessorNames
Method definition
Specifies a list of query analyzers as a query parameter.
SearchParams setQueryProcessorNames(List<String> queryProcessorNames)Parameter description
Parameter | Type | Description |
|---|---|---|
queryProcessorNames | List<String> | The list of query analyzers. |
getQueryProcessorNames
Method definition
Obtains the list of query analyzers that are specified as a query parameter.
List<String> getQueryProcessorNames()Return value
The list of query analyzers that are specified as a query parameter. Type: List<String>.
addToAggregates
Method definition
Adds an Aggregate object to the current SearchParams object.
void addToAggregates(Aggregate aggregate)Parameter description
Parameter | Type | Description |
|---|---|---|
aggregate | Aggregate | The Aggregate object. |
setAggregates
Method definition
Specifies a set of Aggregate objects as a query parameter.
SearchParams setAggregates(Set<Aggregate> aggreates)Parameter description
Parameter | Type | Description |
|---|---|---|
aggreates | Set<Aggregate> | The set of Aggregate objects to be specified as a query parameter. |
getAggregates
Method definition
Obtains the set of Aggregate objects that are specified as a query parameter.
Set<Aggregate> getAggregates()Return value
The set of Aggregate objects that are specified as a query parameter. Type: Set<Aggregate>.
setDistincts
Method definition
Specifies a set of Distinct objects as a query parameter.
SearchParams setDistincts(Set<Distinct> distincts)Parameter description
Parameter | Type | Description |
|---|---|---|
distincts | Set<Distinct> | The set of Distinct objects to be specified as a query parameter. |
addToDistincts
Method definition
Adds a Distinct object to the current SearchParams object.
void addToDistincts(Distinct distinct)Parameter description
Parameter | Type | Description |
|---|---|---|
distinct | Distinct | The Distinct object. |
getDistincts
Method definition
Obtains the set of Distinct objects that are specified as a query parameter.
Set<Distinct> getDistincts()Return value
The set of Distinct objects that are specified as a query parameter. Type: Set<Distinct>.
setRank
Method definition
Specifies a Rank object as a query parameter.
SearchParams setRank(Rank rank)Parameter description
Parameter | Type | Description |
|---|---|---|
rank | Rank | The Rank object. |
getRank
Method definition
Obtains the Rank object that is specified as a query parameter.
Rank getRank()Return value
The Rank object that is specified as a query parameter. Type: Rank.
setSort
Method definition
Specifies a Sort object as a query parameter.
SearchParams setSort(Sort sort)Parameter description
Parameter | Type | Description |
|---|---|---|
sort | Sort | The Sort object. |
getSort
Method definition
Obtains the Sort object that is specified as a query parameter.
Sort getSort()Return value
The Sort object that is specified as a query parameter. Type: Sort.
addToSummaries
Method definition
Adds a Summary object to the current SearchParams object.
void addToSummaries(Summary summary)Parameter description
Parameter | Type | Description |
|---|---|---|
summary | Summary | The Summary object. |
setSummaries
Method definition
Specifies a set of Summary objects as a query parameter.
SearchParams setSummaries(Set<Summary> summaries)Parameter description
Parameter | Type | Description |
|---|---|---|
summaries | Set<Summary> | The set of Summary objects to be specified as a query parameter. |
getSummaries
Method definition
Obtains the set of Summary objects that are specified as a query parameter.
Set<Summary> getSummaries()Return value
The set of Summary objects that are specified as a query parameter. Type: Set<Summary>.
setDeepPaging
Method definition
Specifies a DeepPaging object as a query parameter.
SearchParams setDeepPaging(DeepPaging deepPaging)Parameter description
Parameter | Type | Description |
|---|---|---|
deepPaging | DeepPaging | The DeepPaging object. |
getDeepPaging
Method definition
Obtains the DeepPaging object that is specified as a query parameter.
DeepPaging getDeepPaging()Return value
The DeepPaging object that is specified as a query parameter. Type: DeepPaging.