MetaModelSearchDslImpl (Composable Commerce JVM SDK 2.17.0-SNAPSHOT API)

java.lang.Object
- io.sphere.sdk.models.Base
- - io.sphere.sdk.search.MetaModelSearchDslImpl<T,C,S,L,F,E>

Type Parameters:

T - type of the search result

C - type of the class implementing this class

S - type of the sort model

F - type of the facet model

E - type of the expansion model

All Implemented Interfaces:

SphereRequest<PagedSearchResult<T>>, ExpansionPathContainer<T>, MetaModelReferenceExpansionDsl<T,C,E>, ReferenceExpansionDsl<T,C>, ReferenceExpansionSupport<T>, FacetDsl<T,C>, FacetedSearchDsl<T,C>, FacetedSearchSupport<T>, FacetSupport<T>, FilterDsl<T,C>, FilterSupport<T>, MetaModelFacetDsl<T,C,F>, MetaModelFilterDsl<T,C,L>, MetaModelSearchDsl<T,C,S,L,F,E>, MetaModelSortDsl<T,C,S>, ResourceSearch<T>, Search<T>, SearchDsl<T,C>, SortDsl<T,C>, SortSupport<T>
```
public abstract class MetaModelSearchDslImpl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S,L,F,E>
extends Base
implements MetaModelSearchDsl<T,C,S,L,F,E>
```

Field Summary
- Fields inherited from interface io.sphere.sdk.search.Search
  MAX_OFFSET, MIN_OFFSET

Constructor Summary

Constructors
Constructor and Description
MetaModelSearchDslImpl(LocalizedStringEntry text, Boolean fuzzy, Integer fuzzyLevel, List<FacetExpression<T>> facets, List<FilterExpression<T>> resultFilters, List<FilterExpression<T>> queryFilters, List<FilterExpression<T>> facetFilters, List<FacetedSearchExpression<T>> facetedSearch, List<SortExpression<T>> sort, Long limit, Long offset, String endpoint, Function<HttpResponse,PagedSearchResult<T>> resultMapper, List<ExpansionPath<T>> expansionPaths, List<NameValuePair> additionalQueryParameters, S sortModel, L filterModel, F facetModel, E expansionModel, Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction)
`MetaModelSearchDslImpl(MetaModelSearchDslBuilder<T,C,S,L,F,E> builder)`
`MetaModelSearchDslImpl(String endpoint, com.fasterxml.jackson.core.type.TypeReference<PagedSearchResult<T>> pagedSearchResultTypeReference, S sortModel, L filterModel, F facetModel, E expansionModel, Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction)`
`MetaModelSearchDslImpl(String endpoint, com.fasterxml.jackson.core.type.TypeReference<PagedSearchResult<T>> pagedSearchResultTypeReference, S sortModel, L filterModel, F facetModel, E expansionModel, Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction, List<NameValuePair> additionalQueryParameters)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected List<NameValuePair>`	`additionalQueryParameters()`
`protected MetaModelSearchDslBuilder<T,C,S,L,F,E>`	`copyBuilder()`
`PagedSearchResult<T>`	`deserialize(HttpResponse httpResponse)` Takes an http response and maps it into a Java object of type T.
`String`	`endpoint()`
`boolean`	`equals(Object o)`
`List<ExpansionPath<T>>`	`expansionPaths()`
`List<FacetedSearchExpression<T>>`	`facetedSearch()`
`List<FilterExpression<T>>`	`facetFilters()`
`List<FacetExpression<T>>`	`facets()`
`Integer`	`fuzzyLevel()`
`int`	`hashCode()`
`HttpRequestIntent`	`httpRequestIntent()` Provides an http request intent, this does not include the execution of it.
`Boolean`	`isFuzzy()`
`Long`	`limit()`
`Long`	`offset()`
`C`	`plusExpansionPaths(ExpansionPath<T> expansionPath)` Creates a new object with the properties of the old object but adds `expansionPath` to the expansion paths.
`C`	`plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m)` Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.
`C`	`plusExpansionPaths(List<ExpansionPath<T>> expansionPaths)` Creates a new object with the properties of the old object but adds `expansionPaths` to the expansion paths.
`C`	`plusExpansionPaths(String expansionPath)` Creates a new object with the properties of the old object but adds `expansionPath` to the expansion paths.
`C`	`plusFacetedSearch(FacetedSearchExpression<T> facetedSearchExpression)` Returns a new object with the new faceted search expression appended to the existing faceted search (combination of the query parameter `facet` with the facet expression and the query parameters `filter.facet` and `filter` with the filter expressions).
`C`	`plusFacetedSearch(List<FacetedSearchExpression<T>> facetedSearchExpressions)` Returns a ResourceSearch with the new faceted search expression list appended to the existing faceted search (combination of the query parameter `facet` with the facet expression and the query parameters `filter.facet` and `filter` with the filter expressions).
`C`	`plusFacetFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but adds a new filter list to the `facetFilters` by using meta models.
`C`	`plusFacetFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new facet filter list appended to the existing facet filters (query parameter `filter.facet`).
`C`	`plusFacets(FacetExpression<T> facetExpression)` Returns a new object with the new facet expression appended to the existing facets (query parameter `facet`).
`C`	`plusFacets(Function<F,FacetExpression<T>> m)` Creates a new object with the properties of the old object but adds a new facet to it by using meta models.
`C`	`plusFacets(List<FacetExpression<T>> facetExpressions)` Returns a ResourceSearch with the new facet expression list appended to the existing facets (query parameter `facet`).
`C`	`plusQueryFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but adds a new filter list to the `queryFilters` by using meta models.
`C`	`plusQueryFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new query filter expression list appended to the existing query filters (query parameter `filter.query`).
`C`	`plusResultFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but adds a new filter list to the `resultFilters` by using meta models.
`C`	`plusResultFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new result filter expression list appended to the existing result filters (query parameter `filter`).
`C`	`plusSort(Function<S,SortExpression<T>> m)` Creates a new object with the properties of the old object but adds a new sort expression to it by using meta models.
`C`	`plusSort(List<SortExpression<T>> sortExpressions)` Returns a new object with the new sort expression list appended to the existing sort expressions.
`C`	`plusSort(SortExpression<T> sortExpression)` Returns a new object with the new sort expression list appended to the existing sort expressions.
`List<FilterExpression<T>>`	`queryFilters()`
`List<FilterExpression<T>>`	`resultFilters()`
`List<SortExpression<T>>`	`sort()`
`LocalizedStringEntry`	`text()`
`String`	`toString()`
`C`	`withAdditionalQueryParameter(NameValuePair pair)`
`protected C`	`withAdditionalQueryParameters(List<NameValuePair> pairs)`
`C`	`withExpansionPaths(ExpansionPath<T> expansionPath)` Creates a new object with the properties of the old object but replaces all expansion paths with a single `expansionPath`.
`C`	`withExpansionPaths(Function<E,ExpansionPathContainer<T>> m)` Creates a new object with the properties of the old object but replaces all expansion paths with a single `expansionPath` by using meta models.
`C`	`withExpansionPaths(List<ExpansionPath<T>> expansionPaths)` Creates a new object with the properties of the old object but replaces all expansion paths with `expansionPaths`.
`C`	`withExpansionPaths(String expansionPath)` Creates a new object with the properties of the old object but replaces all expansion paths with a single `expansionPath`.
`C`	`withFacetedSearch(FacetedSearchExpression<T> facetedSearchExpression)` Returns a new object with the new faceted search expression as facets (combination of the query parameter `facet` with the facet expression and the query parameters `filter.facet` and `filter` with the filter expressions).
`C`	`withFacetedSearch(List<FacetedSearchExpression<T>> facetedSearchExpressions)` Returns a new object with the new faceted search expression list as faceted search (combination of the query parameter `facet` with the facet expression and the query parameters `filter.facet` and `filter` with the filter expressions).
`C`	`withFacetFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the `facetFilters` by using meta models.
`C`	`withFacetFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new facet filter list as facet filter (query parameter `filter.facet`).
`C`	`withFacets(FacetExpression<T> facetExpression)` Returns a new object with the new facet expression as facets (query parameter `facet`).
`C`	`withFacets(Function<F,FacetExpression<T>> m)` Creates a new object with the properties of the old object but replaces all facets with a single facet expression to it by using meta models.
`C`	`withFacets(List<FacetExpression<T>> facets)` Returns a new object with the new facet expression list as facets (query parameter `facet`).
`C`	`withFuzzy(Boolean fuzzy)` Returns an ResourceSearch with modified fuzzy parameter.
`C`	`withFuzzyLevel(Integer fuzzyLevel)` Returns an ResourceSearch with modified fuzzyLevel parameter.
`C`	`withLimit(Long limit)` Returns a new object with the new limit.
`C`	`withOffset(Long offset)` Returns a new object with the new offset.
`C`	`withQueryFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the `queryFilters` by using meta models.
`C`	`withQueryFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new query filter expression list as query filters (query parameter `filter.query`).
`C`	`withResultFilters(Function<L,List<FilterExpression<T>>> m)` Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the `resultFilters` by using meta models.
`C`	`withResultFilters(List<FilterExpression<T>> filterExpressions)` Returns a new object with the new result filter expression list as result filter (query parameter `filter`).
`C`	`withSort(Function<S,SortExpression<T>> m)` Creates a new object with the properties of the old object but replaces all sort expressions with a single sort expression to it by using meta models.
`C`	`withSort(List<SortExpression<T>> sortExpressions)` Returns a new object with the new sort expressions.
`C`	`withSort(SortExpression<T> sortExpression)` Returns a new object with the new sort expressions.
`C`	`withText(Locale locale, String text)` Returns a new object with the new text as search text.
`C`	`withText(LocalizedStringEntry text)` Returns a new object with the new text as search text.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.search.SearchDsl
withLimit, withOffset

Methods inherited from interface io.sphere.sdk.search.Search
toSearch

Methods inherited from interface io.sphere.sdk.client.SphereRequest
canDeserialize

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl
plusExpansionPaths, withExpansionPaths

- Constructor Detail
  - MetaModelSearchDslImpl
```
public MetaModelSearchDslImpl(@Nullable
                              LocalizedStringEntry text,
                              @Nullable
                              Boolean fuzzy,
                              @Nullable
                              Integer fuzzyLevel,
                              List<FacetExpression<T>> facets,
                              List<FilterExpression<T>> resultFilters,
                              List<FilterExpression<T>> queryFilters,
                              List<FilterExpression<T>> facetFilters,
                              List<FacetedSearchExpression<T>> facetedSearch,
                              List<SortExpression<T>> sort,
                              @Nullable
                              Long limit,
                              @Nullable
                              Long offset,
                              String endpoint,
                              Function<HttpResponse,PagedSearchResult<T>> resultMapper,
                              List<ExpansionPath<T>> expansionPaths,
                              List<NameValuePair> additionalQueryParameters,
                              S sortModel,
                              L filterModel,
                              F facetModel,
                              E expansionModel,
                              Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction)
```
  - MetaModelSearchDslImpl
```
public MetaModelSearchDslImpl(String endpoint,
                              com.fasterxml.jackson.core.type.TypeReference<PagedSearchResult<T>> pagedSearchResultTypeReference,
                              S sortModel,
                              L filterModel,
                              F facetModel,
                              E expansionModel,
                              Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction,
                              List<NameValuePair> additionalQueryParameters)
```
  - MetaModelSearchDslImpl
```
public MetaModelSearchDslImpl(String endpoint,
                              com.fasterxml.jackson.core.type.TypeReference<PagedSearchResult<T>> pagedSearchResultTypeReference,
                              S sortModel,
                              L filterModel,
                              F facetModel,
                              E expansionModel,
                              Function<MetaModelSearchDslBuilder<T,C,S,L,F,E>,C> searchDslBuilderFunction)
```
  - MetaModelSearchDslImpl
```
public MetaModelSearchDslImpl(MetaModelSearchDslBuilder<T,C,S,L,F,E> builder)
```
- Method Detail
  - withText
```
public C withText(@Nullable
                  LocalizedStringEntry text)
```
    Description copied from interface: SearchDsl
    
    Returns a new object with the new text as search text.
    
    Specified by:
    
    withText in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    text - the new search text with locale, the locale should be enabled for the Project (see the project settings in the Merchant Center)
    
    Returns:
    
    a new object with text
  - withText
```
public C withText(Locale locale,
                  String text)
```
    Description copied from interface: SearchDsl
    
    Returns a new object with the new text as search text.
    
    Specified by:
    
    withText in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    locale - the new locale, the locale should be enabled for the Project (see the project settings in the Merchant Center)
    
    text - the new search text
    
    Returns:
    
    a new object with text
  - withFuzzy
```
public C withFuzzy(Boolean fuzzy)
```
    Description copied from interface: SearchDsl
    
    Returns an ResourceSearch with modified fuzzy parameter.
    
    Specified by:
    
    withFuzzy in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    fuzzy - a flag to indicate if fuzzy search is enabled (true) or not (false)
    
    Returns:
    
    an ResourceSearch with the new fuzzy flag setting
  - withFuzzyLevel
```
public C withFuzzyLevel(Integer fuzzyLevel)
```
    Description copied from interface: SearchDsl
    Returns an ResourceSearch with modified fuzzyLevel parameter.
    final String searchWord = "abcdfgh"; final String productName = "abcdefgh"; withProduct(client(), builder -> builder.name(ofEnglish(productName)), product -> { final ProductProjectionSearch request = ProductProjectionSearch.ofStaged() .withText(ENGLISH, searchWord) .withFuzzy(true); assertEventually(() -> { softAssert(s -> { s.assertThat(client().executeBlocking(request.withFuzzyLevel(0))) .as("level 0 matches not") .doesNotHave(product()); s.assertThat(client().executeBlocking(request.withFuzzyLevel(1))) .as("level 1 matches") .has(product()); s.assertThat(client().executeBlocking(request.withFuzzyLevel(2))) .as("level 2 matches") .has(product()); }); }); });
    See the test code.
    Specified by:
    
    withFuzzyLevel in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    fuzzyLevel - defines level of unsharpness of the search using the Damerau-Levenshtein distance
    
    Returns:
    
    an ResourceSearch with the new fuzzyLevel setting
  - withFacets
```
public C withFacets(List<FacetExpression<T>> facets)
```
    Description copied from interface: FacetDsl
    
    Returns a new object with the new facet expression list as facets (query parameter facet).
    
    Specified by:
    
    withFacets in interface FacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facets - the new facet expression list
    
    Returns:
    
    a new object with facets
  - withFacets
```
public C withFacets(FacetExpression<T> facetExpression)
```
    Description copied from interface: FacetDsl
    
    Returns a new object with the new facet expression as facets (query parameter facet).
    
    Specified by:
    
    withFacets in interface FacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetExpression - the new facet expression
    
    Returns:
    
    a new object with facets
  - withFacets
```
public C withFacets(Function<F,FacetExpression<T>> m)
```
    Description copied from interface: MetaModelFacetDsl
    
    Creates a new object with the properties of the old object but replaces all facets with a single facet expression to it by using meta models.
    
    Specified by:
    
    withFacets in interface MetaModelFacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,F>
    
    Parameters:
    
    m - function to use the meta model for facets to create a facet expression
    
    Returns:
    
    new object
  - plusFacets
```
public C plusFacets(List<FacetExpression<T>> facetExpressions)
```
    Description copied from interface: FacetDsl
    
    Returns a ResourceSearch with the new facet expression list appended to the existing facets (query parameter facet).
    
    Specified by:
    
    plusFacets in interface FacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetExpressions - the new facet expression list
    
    Returns:
    
    a ResourceSearch with the existing facets plus the new facet list.
  - plusFacets
```
public C plusFacets(FacetExpression<T> facetExpression)
```
    Description copied from interface: FacetDsl
    
    Returns a new object with the new facet expression appended to the existing facets (query parameter facet).
    
    Specified by:
    
    plusFacets in interface FacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetExpression - the new facet expression
    
    Returns:
    
    a new object with the existing facets plus the new facet.
  - plusFacets
```
public C plusFacets(Function<F,FacetExpression<T>> m)
```
    Description copied from interface: MetaModelFacetDsl
    
    Creates a new object with the properties of the old object but adds a new facet to it by using meta models.
    
    Specified by:
    
    plusFacets in interface MetaModelFacetDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,F>
    
    Parameters:
    
    m - function to use the meta model for facets to create a facet expression
    
    Returns:
    
    new object
  - withResultFilters
```
public C withResultFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new result filter expression list as result filter (query parameter filter).
    
    Specified by:
    
    withResultFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new result filter expression list
    
    Returns:
    
    a new object with filterExpressions as resultFilters
  - withResultFilters
```
public C withResultFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the resultFilters by using meta models.
    
    Specified by:
    
    withResultFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a list of filter expression
    
    Returns:
    
    new object
  - plusResultFilters
```
public C plusResultFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new result filter expression list appended to the existing result filters (query parameter filter).
    
    Specified by:
    
    plusResultFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new result filter expression list
    
    Returns:
    
    a new object with the existing resultFilters plus the new filterExpressions.
  - plusResultFilters
```
public C plusResultFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but adds a new filter list to the resultFilters by using meta models.
    
    Specified by:
    
    plusResultFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a filter expression
    
    Returns:
    
    new object
  - withQueryFilters
```
public C withQueryFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new query filter expression list as query filters (query parameter filter.query).
    
    Specified by:
    
    withQueryFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new query filter expression list
    
    Returns:
    
    a new object with queryFilters as filterExpressions
  - withQueryFilters
```
public C withQueryFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the queryFilters by using meta models.
    
    Specified by:
    
    withQueryFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a list of filter expression
    
    Returns:
    
    new object
  - plusQueryFilters
```
public C plusQueryFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new query filter expression list appended to the existing query filters (query parameter filter.query).
    
    Specified by:
    
    plusQueryFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new query filter expression list
    
    Returns:
    
    a new object with the existing queryFilters plus the new filterExpressions.
  - plusQueryFilters
```
public C plusQueryFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but adds a new filter list to the queryFilters by using meta models.
    
    Specified by:
    
    plusQueryFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a filter expression
    
    Returns:
    
    new object
  - withFacetFilters
```
public C withFacetFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new facet filter list as facet filter (query parameter filter.facet).
    
    Specified by:
    
    withFacetFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new facet filter expression list
    
    Returns:
    
    a new object with facetFilters as filterExpressions
  - withFacetFilters
```
public C withFacetFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but replaces all filters with a list of filter expressions to the facetFilters by using meta models.
    
    Specified by:
    
    withFacetFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a list of filter expression
    
    Returns:
    
    new object
  - plusFacetFilters
```
public C plusFacetFilters(List<FilterExpression<T>> filterExpressions)
```
    Description copied from interface: FilterDsl
    
    Returns a new object with the new facet filter list appended to the existing facet filters (query parameter filter.facet).
    
    Specified by:
    
    plusFacetFilters in interface FilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    filterExpressions - the new facet filter expression list
    
    Returns:
    
    a new object with the existing facetFilters plus the new filterExpressions.
  - plusFacetFilters
```
public C plusFacetFilters(Function<L,List<FilterExpression<T>>> m)
```
    Description copied from interface: MetaModelFilterDsl
    
    Creates a new object with the properties of the old object but adds a new filter list to the facetFilters by using meta models.
    
    Specified by:
    
    plusFacetFilters in interface MetaModelFilterDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,L>
    
    Parameters:
    
    m - function to use the meta model for filters to create a filter expression
    
    Returns:
    
    new object
  - withFacetedSearch
```
public C withFacetedSearch(List<FacetedSearchExpression<T>> facetedSearchExpressions)
```
    Description copied from interface: FacetedSearchDsl
    
    Returns a new object with the new faceted search expression list as faceted search (combination of the query parameter facet with the facet expression and the query parameters filter.facet and filter with the filter expressions). This enables the behaviour of the faceted search as explained in the documentation.
    
    Specified by:
    
    withFacetedSearch in interface FacetedSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetedSearchExpressions - the new faceted search expression list
    
    Returns:
    
    a new object with faceted search
  - withFacetedSearch
```
public C withFacetedSearch(FacetedSearchExpression<T> facetedSearchExpression)
```
    Description copied from interface: FacetedSearchDsl
    
    Returns a new object with the new faceted search expression as facets (combination of the query parameter facet with the facet expression and the query parameters filter.facet and filter with the filter expressions). This enables the behaviour of the faceted search as explained in the documentation.
    
    Specified by:
    
    withFacetedSearch in interface FacetedSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetedSearchExpression - the new faceted search expression
    
    Returns:
    
    a new object with faceted search
  - plusFacetedSearch
```
public C plusFacetedSearch(List<FacetedSearchExpression<T>> facetedSearchExpressions)
```
    Description copied from interface: FacetedSearchDsl
    
    Returns a ResourceSearch with the new faceted search expression list appended to the existing faceted search (combination of the query parameter facet with the facet expression and the query parameters filter.facet and filter with the filter expressions). This enables the behaviour of the faceted search as explained in the documentation.
    
    Specified by:
    
    plusFacetedSearch in interface FacetedSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetedSearchExpressions - the new faceted search expression list
    
    Returns:
    
    a ResourceSearch with the existing faceted search plus the new faceted search list.
  - plusFacetedSearch
```
public C plusFacetedSearch(FacetedSearchExpression<T> facetedSearchExpression)
```
    Description copied from interface: FacetedSearchDsl
    
    Returns a new object with the new faceted search expression appended to the existing faceted search (combination of the query parameter facet with the facet expression and the query parameters filter.facet and filter with the filter expressions). This enables the behaviour of the faceted search as explained in the documentation.
    
    Specified by:
    
    plusFacetedSearch in interface FacetedSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    facetedSearchExpression - the new faceted search expression
    
    Returns:
    
    a new object with the existing faceted search plus the new facet.
  - withSort
```
public C withSort(List<SortExpression<T>> sortExpressions)
```
    Description copied from interface: SortDsl
    
    Returns a new object with the new sort expressions.
    
    Specified by:
    
    withSort in interface SortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    sortExpressions - the new sort expression list
    
    Returns:
    
    a new object with sort sortExpressions
  - withSort
```
public C withSort(SortExpression<T> sortExpression)
```
    Description copied from interface: SortDsl
    
    Returns a new object with the new sort expressions.
    
    Specified by:
    
    withSort in interface SortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    sortExpression - the new sort expression list
    
    Returns:
    
    a new object with sort sortExpressions
  - withSort
```
public C withSort(Function<S,SortExpression<T>> m)
```
    Description copied from interface: MetaModelSortDsl
    
    Creates a new object with the properties of the old object but replaces all sort expressions with a single sort expression to it by using meta models.
    
    Specified by:
    
    withSort in interface MetaModelSortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S>
    
    Parameters:
    
    m - function to use the meta model for sort to create a sort expression
    
    Returns:
    
    new object
  - plusSort
```
public C plusSort(List<SortExpression<T>> sortExpressions)
```
    Description copied from interface: SortDsl
    
    Returns a new object with the new sort expression list appended to the existing sort expressions.
    
    Specified by:
    
    plusSort in interface SortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    sortExpressions - the new sort expression list
    
    Returns:
    
    a new object with the existing sort expressions plus the new sortExpressions.
  - plusSort
```
public C plusSort(SortExpression<T> sortExpression)
```
    Description copied from interface: SortDsl
    
    Returns a new object with the new sort expression list appended to the existing sort expressions.
    
    Specified by:
    
    plusSort in interface SortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    sortExpression - the new sort expression
    
    Returns:
    
    a new object with the existing sort expressions plus the new sortExpressions.
  - plusSort
```
public C plusSort(Function<S,SortExpression<T>> m)
```
    Description copied from interface: MetaModelSortDsl
    
    Creates a new object with the properties of the old object but adds a new sort expression to it by using meta models.
    
    Specified by:
    
    plusSort in interface MetaModelSortDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S>
    
    Parameters:
    
    m - function to use the meta model for sort to create a sort expression
    
    Returns:
    
    new object
  - withLimit
```
public C withLimit(Long limit)
```
    Description copied from interface: SearchDsl
    
    Returns a new object with the new limit.
    
    Specified by:
    
    withLimit in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    limit - the new limit
    
    Returns:
    
    a new object with limit
  - withOffset
```
public C withOffset(Long offset)
```
    Description copied from interface: SearchDsl
    
    Returns a new object with the new offset.
    
    Specified by:
    
    withOffset in interface SearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    offset - the new offset
    
    Returns:
    
    a new object with offset
  - withExpansionPaths
```
public C withExpansionPaths(List<ExpansionPath<T>> expansionPaths)
```
    Description copied from interface: ReferenceExpansionDsl
    
    Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.
    
    Specified by:
    
    withExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPaths - the new expansion paths
    
    Returns:
    
    new object
  - withExpansionPaths
```
public C withExpansionPaths(ExpansionPath<T> expansionPath)
```
    Description copied from interface: ReferenceExpansionDsl
    Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .withExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"))); final ProductProjectionByIdGet fetch2 = fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged") .isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType"))); assertThat(fetch2).isNotSameAs(fetch);
    See the test code.
    This method also can be used to use the same expansions as in another request:
    final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories()); final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query); assertThat(query.expansionPaths()) .hasSize(1) .as("reuse expansion spec from other request") .isEqualTo(search.expansionPaths());
    See the test code.
    Specified by:
    
    withExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPath - the new expansion paths
    
    Returns:
    
    new object
  - withExpansionPaths
```
public C withExpansionPaths(Function<E,ExpansionPathContainer<T>> m)
```
    Description copied from interface: MetaModelReferenceExpansionDsl
    Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .plusExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"))); final ProductProjectionByIdGet fetch2 = fetch.withExpansionPaths(m -> m.productType()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged") .isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType"))); assertThat(fetch2).isNotSameAs(fetch);
    See the test code.
    Specified by:
    
    withExpansionPaths in interface MetaModelReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,E>
    
    Parameters:
    
    m - function to use the meta model for expansions to create an expansion path
    
    Returns:
    
    new object
  - plusExpansionPaths
```
public C plusExpansionPaths(List<ExpansionPath<T>> expansionPaths)
```
    Description copied from interface: ReferenceExpansionDsl
    
    Creates a new object with the properties of the old object but adds expansionPaths to the expansion paths.
    
    Specified by:
    
    plusExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPaths - the new expansion paths to add to the existing ones
    
    Returns:
    
    new object
  - plusExpansionPaths
```
public C plusExpansionPaths(ExpansionPath<T> expansionPath)
```
    Description copied from interface: ReferenceExpansionDsl
    Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT); assertThat(fetch.expansionPaths()).isEmpty(); final ProductProjectionByIdGet fetch2 = fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty(); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2).isNotSameAs(fetch);
    See the test code.
    Specified by:
    
    plusExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPath - the new expansion path to add to the existing ones
    
    Returns:
    
    new object
  - plusExpansionPaths
```
public C plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m)
```
    Description copied from interface: MetaModelReferenceExpansionDsl
    Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch1 = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .plusExpansionPaths(m -> m.categories()); assertThat(fetch1.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"))); final ProductProjectionByIdGet fetch2 = fetch1.plusExpansionPaths(m -> m.productType()); assertThat(fetch2.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType"))) .isEqualTo(listOf(fetch1.expansionPaths(), ExpansionPath.of("productType"))); //this is equivalent to final ExpansionPath<ProductProjection> categoryExpand = ProductProjectionExpansionModel.of().categories().expansionPaths().get(0); final ExpansionPath<ProductProjection> productTypeExpand = ProductProjectionExpansionModel.of().productType().expansionPaths().get(0); final ProductProjectionByIdGet fetchB = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .withExpansionPaths(asList(categoryExpand, productTypeExpand)); assertThat(fetchB.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")));
    See the test code.
    Specified by:
    
    plusExpansionPaths in interface MetaModelReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,E>
    
    Parameters:
    
    m - function to use the meta model for expansions to create an expansion path
    
    Returns:
    
    new object
  - withExpansionPaths
```
public C withExpansionPaths(String expansionPath)
```
    Description copied from interface: ReferenceExpansionDsl
    Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT) .withExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()) .isEqualTo(asList(ExpansionPath.of("categories[*]"))); final ProductProjectionByIdGet fetch2 = fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged") .isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType"))); assertThat(fetch2).isNotSameAs(fetch);
    See the test code.
    This method also can be used to use the same expansions as in another request:
    final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories()); final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query); assertThat(query.expansionPaths()) .hasSize(1) .as("reuse expansion spec from other request") .isEqualTo(search.expansionPaths());
    See the test code.
    Specified by:
    
    withExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPath - the new expansion paths
    
    Returns:
    
    new object
  - plusExpansionPaths
```
public C plusExpansionPaths(String expansionPath)
```
    Description copied from interface: ReferenceExpansionDsl
    Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
    An example in the product projection context:
    final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT); assertThat(fetch.expansionPaths()).isEmpty(); final ProductProjectionByIdGet fetch2 = fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories()); assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty(); assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]"))); assertThat(fetch2).isNotSameAs(fetch);
    See the test code.
    Specified by:
    
    plusExpansionPaths in interface ReferenceExpansionDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>>
    
    Parameters:
    
    expansionPath - the new expansion path to add to the existing ones
    
    Returns:
    
    new object
  - withAdditionalQueryParameter
```
public C withAdditionalQueryParameter(NameValuePair pair)
```
    Specified by:
    
    withAdditionalQueryParameter in interface MetaModelSearchDsl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S,L,F,E>
  - withAdditionalQueryParameters
```
protected C withAdditionalQueryParameters(List<NameValuePair> pairs)
```
  - text
```
@Nullable
public LocalizedStringEntry text()
```
    Specified by:
    
    text in interface ResourceSearch<T>
  - facets
```
public List<FacetExpression<T>> facets()
```
    Specified by:
    
    facets in interface FacetSupport<T>
  - resultFilters
```
public List<FilterExpression<T>> resultFilters()
```
    Specified by:
    
    resultFilters in interface FilterSupport<T>
  - queryFilters
```
public List<FilterExpression<T>> queryFilters()
```
    Specified by:
    
    queryFilters in interface FilterSupport<T>
  - facetFilters
```
public List<FilterExpression<T>> facetFilters()
```
    Specified by:
    
    facetFilters in interface FilterSupport<T>
  - facetedSearch
```
public List<FacetedSearchExpression<T>> facetedSearch()
```
    Specified by:
    
    facetedSearch in interface FacetedSearchSupport<T>
  - sort
```
public List<SortExpression<T>> sort()
```
    Specified by:
    
    sort in interface SortSupport<T>
  - limit
```
@Nullable
public Long limit()
```
    Specified by:
    
    limit in interface ResourceSearch<T>
  - offset
```
@Nullable
public Long offset()
```
    Specified by:
    
    offset in interface ResourceSearch<T>
  - endpoint
```
public String endpoint()
```
    Specified by:
    
    endpoint in interface ResourceSearch<T>
  - expansionPaths
```
public List<ExpansionPath<T>> expansionPaths()
```
    Specified by:
    
    expansionPaths in interface ExpansionPathContainer<T>
    
    Specified by:
    
    expansionPaths in interface ReferenceExpansionSupport<T>
  - isFuzzy
```
@Nullable
public Boolean isFuzzy()
```
    Specified by:
    
    isFuzzy in interface ResourceSearch<T>
  - fuzzyLevel
```
@Nullable
public Integer fuzzyLevel()
```
    Specified by:
    
    fuzzyLevel in interface ResourceSearch<T>
  - additionalQueryParameters
```
protected List<NameValuePair> additionalQueryParameters()
```
  - copyBuilder
```
protected MetaModelSearchDslBuilder<T,C,S,L,F,E> copyBuilder()
```
  - httpRequestIntent
```
public HttpRequestIntent httpRequestIntent()
```
    Description copied from interface: SphereRequest
    
    Provides an http request intent, this does not include the execution of it.
    
    Specified by:
    
    httpRequestIntent in interface SphereRequest<PagedSearchResult<T>>
    
    Returns:
    
    http request intent
  - deserialize
```
public PagedSearchResult<T> deserialize(HttpResponse httpResponse)
```
    Description copied from interface: SphereRequest
    
    Takes an http response and maps it into a Java object of type T. Before calling this method, check with SphereRequest.canDeserialize(HttpResponse) if the response can be consumed.
    
    Specified by:
    
    deserialize in interface SphereRequest<PagedSearchResult<T>>
    
    Specified by:
    
    deserialize in interface Search<T>
    
    Parameters:
    
    httpResponse - the http response of the API
    
    Returns:
    
    the deserialized object
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Base
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Base
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Base

Class MetaModelSearchDslImpl<T,C extends MetaModelSearchDsl<T,C,S,L,F,E>,S,L,F,E>

Field Summary

Fields inherited from interface io.sphere.sdk.search.Search

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.sphere.sdk.search.SearchDsl

Methods inherited from interface io.sphere.sdk.search.Search

Methods inherited from interface io.sphere.sdk.client.SphereRequest

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

Constructor Detail

MetaModelSearchDslImpl

MetaModelSearchDslImpl

MetaModelSearchDslImpl

MetaModelSearchDslImpl

Method Detail

withText

withText

withFuzzy

withFuzzyLevel

withFacets

withFacets

withFacets

plusFacets

plusFacets

plusFacets

withResultFilters

withResultFilters

plusResultFilters

plusResultFilters

withQueryFilters

withQueryFilters

plusQueryFilters

plusQueryFilters

withFacetFilters

withFacetFilters

plusFacetFilters

plusFacetFilters

withFacetedSearch

withFacetedSearch

plusFacetedSearch

plusFacetedSearch

withSort

withSort

withSort

plusSort

plusSort

plusSort

withLimit

withOffset

withExpansionPaths

withExpansionPaths

withExpansionPaths

plusExpansionPaths

plusExpansionPaths

plusExpansionPaths

withExpansionPaths

plusExpansionPaths

withAdditionalQueryParameter

withAdditionalQueryParameters

text

facets

resultFilters

queryFilters

facetFilters

facetedSearch

sort

limit

offset

endpoint

expansionPaths

isFuzzy

fuzzyLevel

additionalQueryParameters

copyBuilder

httpRequestIntent

deserialize

equals

hashCode

toString