public class SearchQuery extends Object implements Serializable
| Modifier and Type | Class and Description |
|---|---|
static class |
SearchQuery.Operator |
static class |
SearchQuery.QueryOperator |
static class |
SearchQuery.QueryParser
Deprecated.
Since 5.7, query syntax should not rely on specific query parser.
|
| Constructor and Description |
|---|
SearchQuery(FacetSearchConfig facetSearchConfig,
IndexedType indexedType) |
| Modifier and Type | Method and Description |
|---|---|
void |
addBoost(BoostField boostField) |
void |
addBoost(String field,
BoostField.BoostType boostType) |
void |
addBoost(String field,
SearchQuery.QueryOperator queryOperator,
Object value,
Float boost,
BoostField.BoostType boostType) |
void |
addBoostField(String field,
String value,
SearchQuery.Operator operator)
Deprecated.
Since 5.7, replaced by
addBoost(BoostField) |
void |
addCoupledFields(CoupledQueryField field)
Adds logically coupled query fields.
|
void |
addExcludedResult(PK itemPk) |
void |
addFacet(FacetField facet)
Adds a facet field.
|
void |
addFacet(String field)
Adds a facet field.
|
void |
addFacet(String field,
FacetType facetType)
Adds a facet field.
|
void |
addFacetValue(FacetValueField facetValue)
Adds a facet value field.
|
void |
addFacetValue(String field,
Set<String> values)
Adds a facet value field.
|
void |
addFacetValue(String field,
String... values)
Adds a facet value field.
|
void |
addField(String field)
Adds a field to the list of fields that will be returned within a query response.
|
void |
addFilterQuery(QueryField query)
Adds a filter query field.
|
void |
addFilterQuery(String field,
SearchQuery.Operator operator,
Set<String> values)
Adds a filter query field.
|
void |
addFilterQuery(String field,
SearchQuery.Operator operator,
String... values)
Adds a filter query field.
|
void |
addFilterQuery(String field,
String... values)
Adds a filter query field.
|
void |
addFilterRawQuery(RawQuery rawQuery)
Adds a filter raw query using lucene syntax.
|
void |
addFilterRawQuery(String rawQuery)
Adds a filter raw query using lucene syntax.
|
void |
addFreeTextFuzzyQuery(FreeTextFuzzyQueryField freeTextFuzzyQuery)
Adds a free text fuzzy query field.
|
void |
addFreeTextFuzzyQuery(String field,
Integer minTermLength,
Integer fuzziness,
Float boost)
Adds a free text fuzzy query field.
|
void |
addFreeTextPhraseQuery(FreeTextPhraseQueryField freeTextPhraseQuery)
Adds a free text phrase query field.
|
void |
addFreeTextPhraseQuery(String field,
Float slop,
Float boost)
Adds a free text phrase query field.
|
void |
addFreeTextQuery(FreeTextQueryField freeTextQuery)
Adds a free text query field.
|
void |
addFreeTextQuery(String field,
Integer minTermLength,
Float boost)
Adds a free text query field.
|
void |
addFreeTextWildcardQuery(FreeTextWildcardQueryField freeTextWildcardQuery)
Adds a free text wildcard query field.
|
void |
addFreeTextWildcardQuery(String field,
Integer minTermLength,
WildcardType wildcardType,
Float boost)
Adds a free text wildcard query field.
|
void |
addGroupCommand(GroupCommandField groupCommand)
Adds group command field.
|
void |
addGroupCommand(String field)
Adds group command field.
|
void |
addGroupCommand(String field,
Integer groupLimit)
Adds group command field.
|
protected void |
addLegacySorts(SearchConfig searchConfig) |
void |
addPromotedResult(PK itemPk) |
void |
addQuery(QueryField query)
Adds a query field.
|
void |
addQuery(String field,
SearchQuery.Operator operator,
SearchQuery.QueryOperator queryOperator,
Set<String> values)
Adds a query field.
|
void |
addQuery(String field,
SearchQuery.Operator operator,
SearchQuery.QueryOperator queryOperator,
String... values)
Adds a query field.
|
void |
addQuery(String field,
SearchQuery.Operator operator,
String... values)
Adds a query field.
|
void |
addQuery(String field,
String... values)
Adds a query field.
|
void |
addRawParam(String param,
String... values)
Adds a new raw parameter.
|
void |
addRawQuery(RawQuery rawQuery)
Adds a raw query using lucene syntax.
|
void |
addRawQuery(String rawQuery)
Adds a raw query using lucene syntax.
|
void |
addRawQuery(String rawQuery,
SearchQuery.Operator operator)
Deprecated.
Since 5.7, see
setDefaultOperator(Operator). |
void |
addSort(OrderField sort)
Adds a sort field.
|
void |
addSort(String field)
Adds a sort field using ascending as sort order.
|
void |
addSort(String field,
OrderField.SortOrder sortOrder)
Adds a sort field.
|
protected int |
findBoostField(String name) |
protected int |
findField(String name) |
List<QueryField> |
getBoostFields()
Deprecated.
Since 5.7, replaced by
getRawQueries() |
List<BoostField> |
getBoosts() |
List<Breadcrumb> |
getBreadcrumbs() |
List<CatalogVersionModel> |
getCatalogVersions()
Returns the catalog versions.
|
List<CoupledQueryField> |
getCoupledFields() |
String |
getCurrency()
Returns the currency.
|
SearchQuery.Operator |
getDefaultOperator()
Returns the default operator for the search query.
|
List<PK> |
getExcludedResults() |
List<FacetField> |
getFacets()
Returns the facet fields.
|
FacetSearchConfig |
getFacetSearchConfig()
Returns the facet search config.
|
List<FacetValueField> |
getFacetValues()
Returns the facet value fields.
|
List<String> |
getFields()
Returns the list of fields that will be returned within a query response.
|
List<QueryField> |
getFilterQueries()
Returns the filter query fields.
|
List<RawQuery> |
getFilterRawQueries()
Returns the filter raw queries.
|
List<FreeTextFuzzyQueryField> |
getFreeTextFuzzyQueries()
Returns the free text fuzzy query fields.
|
List<FreeTextPhraseQueryField> |
getFreeTextPhraseQueries()
Returns the free text phrase query fields.
|
List<FreeTextQueryField> |
getFreeTextQueries()
Returns the free text query fields.
|
String |
getFreeTextQueryBuilder()
Returns the query builder.
|
Map<String,String> |
getFreeTextQueryBuilderParameters()
Returns the query builder parameters.
|
List<FreeTextWildcardQueryField> |
getFreeTextWildcardQueries()
Returns the free text wildcard query fields.
|
List<GroupCommandField> |
getGroupCommands()
Returns group command fields.
|
IndexedType |
getIndexedType()
Returns the indexed type.
|
String |
getLanguage()
Returns the language.
|
int |
getOffset()
Returns the offset (page number).
|
int |
getPageSize()
Returns the page size.
|
List<PK> |
getPromotedResults() |
List<QueryField> |
getQueries()
Returns the query fields.
|
SearchQuery.QueryParser |
getQueryParser()
Deprecated.
Since 5.7, query syntax should not rely on specific query parser.
|
Map<String,String[]> |
getRawParams()
Returns the raw parameters.
|
List<RawQuery> |
getRawQueries()
Returns the raw queries.
|
List<OrderField> |
getSorts()
Returns the sort fields.
|
String |
getUserQuery()
Returns the user query.
|
boolean |
isEnableSpellcheck()
Returns
true if spell checking is enabled for the search query. |
boolean |
isGroupFacets()
Returns
true if group facets is enabled for the search query. |
void |
nextPage()
Changes the offset to the next page.
|
void |
prevPage()
Changes the offset to the previous page.
|
void |
setCatalogVersions(List<CatalogVersionModel> catalogVersions)
Sets the catalog versions.
|
void |
setCurrency(String currency)
Sets the currency.
|
void |
setDefaultOperator(SearchQuery.Operator defaultOperator)
Sets the default operator for the search query.
|
void |
setEnableSpellcheck(boolean enableSpellcheck)
Enables or disables spell checking for the search query.
|
void |
setFreeTextQueryBuilder(String freeTextQueryBuilder)
Sets the query builder.
|
void |
setGroupFacets(boolean groupFacets)
Enables or disables group facets for the search query.
|
void |
setLanguage(String language)
Sets the language.
|
void |
setOffset(int offset)
Sets the offset (page number).
|
void |
setPageSize(int pageSize)
Sets the page size.
|
void |
setQueryParser(SearchQuery.QueryParser queryParser)
Deprecated.
Since 5.7, query syntax should not rely on specific query parser.
|
void |
setUserQuery(String userQuery)
Sets the user query.
|
public SearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType)
protected final void addLegacySorts(SearchConfig searchConfig)
public FacetSearchConfig getFacetSearchConfig()
public IndexedType getIndexedType()
public String getLanguage()
public void setLanguage(String language)
language - - isocode of the languagepublic String getCurrency()
public void setCurrency(String currency)
currency - - isocode of the currencypublic List<CatalogVersionModel> getCatalogVersions()
public void setCatalogVersions(List<CatalogVersionModel> catalogVersions)
catalogVersions - - the catalog versionspublic int getOffset()
public void setOffset(int offset)
offset - the offset (page number)public int getPageSize()
public void setPageSize(int pageSize)
pageSize - the page sizepublic void nextPage()
public void prevPage()
public SearchQuery.Operator getDefaultOperator()
public void setDefaultOperator(SearchQuery.Operator defaultOperator)
defaultOperator - the default operatorpublic void addQuery(String field, String... values)
field - - the fieldvalues - - the valuespublic void addQuery(String field, SearchQuery.Operator operator, String... values)
field - - the fieldoperator - - the operatorvalues - - the valuespublic void addQuery(String field, SearchQuery.Operator operator, SearchQuery.QueryOperator queryOperator, String... values)
field - - the fieldoperator - - the operatorqueryOperator - - the query operatorvalues - - the valuespublic void addQuery(String field, SearchQuery.Operator operator, SearchQuery.QueryOperator queryOperator, Set<String> values)
field - - the fieldoperator - - the operatorqueryOperator - - the query operatorvalues - - the valuespublic void addQuery(QueryField query)
query - - the query fieldpublic List<QueryField> getQueries()
public String getFreeTextQueryBuilder()
public void setFreeTextQueryBuilder(String freeTextQueryBuilder)
freeTextQueryBuilder - - the query builderpublic Map<String,String> getFreeTextQueryBuilderParameters()
public String getUserQuery()
public void setUserQuery(String userQuery)
userQuery - - the user querypublic void addFreeTextQuery(String field, Integer minTermLength, Float boost)
field - - the fieldminTermLength - - minimal length of the search termboost - - the boost valuepublic void addFreeTextQuery(FreeTextQueryField freeTextQuery)
freeTextQuery - - the free text query fieldpublic List<FreeTextQueryField> getFreeTextQueries()
public void addFreeTextFuzzyQuery(String field, Integer minTermLength, Integer fuzziness, Float boost)
field - -the fieldminTermLength - - minimal length of the search termfuzziness - - the fuzziness valueboost - - the boost valuepublic void addFreeTextFuzzyQuery(FreeTextFuzzyQueryField freeTextFuzzyQuery)
freeTextFuzzyQuery - -the free text fuzzy query fieldpublic List<FreeTextFuzzyQueryField> getFreeTextFuzzyQueries()
public void addFreeTextWildcardQuery(String field, Integer minTermLength, WildcardType wildcardType, Float boost)
field - - the fieldminTermLength - - minimal length of the search termwildcardType - - the wildcard typeboost - - the boost valuepublic void addFreeTextWildcardQuery(FreeTextWildcardQueryField freeTextWildcardQuery)
freeTextWildcardQuery - -the free text wildcard query fieldpublic List<FreeTextWildcardQueryField> getFreeTextWildcardQueries()
public void addFreeTextPhraseQuery(String field, Float slop, Float boost)
field - - the fieldslop - - the slop valueboost - - the boost valuepublic void addFreeTextPhraseQuery(FreeTextPhraseQueryField freeTextPhraseQuery)
freeTextPhraseQuery - - the free text phrase query fieldpublic List<FreeTextPhraseQueryField> getFreeTextPhraseQueries()
public void addRawQuery(String rawQuery)
rawQuery - - the raw querypublic void addRawQuery(RawQuery rawQuery)
rawQuery - - the raw querypublic List<RawQuery> getRawQueries()
public void addFilterQuery(String field, String... values)
field - - the fieldvalues - - the valuespublic void addFilterQuery(String field, SearchQuery.Operator operator, String... values)
field - - the fieldoperator - - the operatorvalues - - the valuespublic void addFilterQuery(String field, SearchQuery.Operator operator, Set<String> values)
field - - the fieldoperator - - the operatorvalues - - the valuespublic void addFilterQuery(QueryField query)
query - - the filter query fieldpublic List<QueryField> getFilterQueries()
public void addFilterRawQuery(String rawQuery)
rawQuery - - the raw querypublic void addFilterRawQuery(RawQuery rawQuery)
rawQuery - - the raw querypublic List<RawQuery> getFilterRawQueries()
public void addGroupCommand(String field)
field - - the group fieldpublic void addGroupCommand(String field, Integer groupLimit)
field - - the group fieldgroupLimit - - the group limitpublic void addGroupCommand(GroupCommandField groupCommand)
groupCommand - - the group command fieldpublic List<GroupCommandField> getGroupCommands()
public boolean isGroupFacets()
true if group facets is enabled for the search query.true if group facets is enabled, false otherwisepublic void setGroupFacets(boolean groupFacets)
groupFacets - true to enable group facets, false to disable itpublic void addSort(String field)
field - - the fieldpublic void addSort(String field, OrderField.SortOrder sortOrder)
field - - the fieldsortOrder - - the sort orderpublic void addSort(OrderField sort)
sort - - the sort fieldpublic List<OrderField> getSorts()
public void addField(String field)
field - - the fieldpublic List<String> getFields()
public void addFacet(String field)
field - - the fieldpublic void addFacet(String field, FacetType facetType)
field - - the fieldfacetType - - the facet typepublic void addFacet(FacetField facet)
facet - - the facet fieldpublic List<FacetField> getFacets()
public void addFacetValue(String field, String... values)
field - - the fieldvalues - - the valuespublic void addFacetValue(String field, Set<String> values)
field - - the fieldvalues - - the valuespublic void addFacetValue(FacetValueField facetValue)
facetValue - - the facet value fieldpublic List<FacetValueField> getFacetValues()
public void addBoost(String field, SearchQuery.QueryOperator queryOperator, Object value, Float boost, BoostField.BoostType boostType)
public void addBoost(String field, BoostField.BoostType boostType)
public void addBoost(BoostField boostField)
public List<BoostField> getBoosts()
public void addPromotedResult(PK itemPk)
public void addExcludedResult(PK itemPk)
public boolean isEnableSpellcheck()
true if spell checking is enabled for the search query.true if spell checking is enabled, false otherwisepublic void setEnableSpellcheck(boolean enableSpellcheck)
enableSpellcheck - true to enable spell checking, false to disable itpublic void addRawParam(String param, String... values)
param - - the parametervalues - - the values for the parameterpublic Map<String,String[]> getRawParams()
public List<Breadcrumb> getBreadcrumbs()
@Deprecated public void setQueryParser(SearchQuery.QueryParser queryParser)
@Deprecated public SearchQuery.QueryParser getQueryParser()
@Deprecated public void addRawQuery(String rawQuery, SearchQuery.Operator operator)
setDefaultOperator(Operator).rawQuery - - the raw queryoperator - - the operator@Deprecated public void addBoostField(String field, String value, SearchQuery.Operator operator)
addBoost(BoostField)@Deprecated public List<QueryField> getBoostFields()
getRawQueries()protected int findField(String name)
protected int findBoostField(String name)
public void addCoupledFields(CoupledQueryField field)
public List<CoupledQueryField> getCoupledFields()
Copyright © 2017 SAP SE. All Rights Reserved.