io.sphere.sdk.search

Interface SearchDsl<T,C extends SearchDsl<T,C>>

All Superinterfaces:

ResourceSearch<T>, Search<T>, SphereRequest<PagedSearchResult<T>>

All Known Subinterfaces:

MetaModelSearchDsl<T,C,S,L,F,E>, ProductProjectionSearch

All Known Implementing Classes:

MetaModelSearchDslImpl

public interface SearchDsl<T,C extends SearchDsl<T,C>>
extends ResourceSearch<T>

Field Summary

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

MAX_OFFSET, MIN_OFFSET

Method Summary

Modifier and Type	Method and Description
C	withFuzzy(Boolean fuzzy) Returns an ResourceSearch with modified fuzzy parameter.
C	withFuzzyLevel(Integer fuzzyLevel) Returns an ResourceSearch with modified fuzzyLevel parameter.
default C	withLimit(long limit) Returns a new object with the new limit.
C	withLimit(Long limit) Returns a new object with the new limit.
default C	withOffset(long offset) Returns a new object with the new offset.
C	withOffset(Long offset) Returns a new object with the new offset.
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 interface io.sphere.sdk.search.ResourceSearch

endpoint, fuzzyLevel, isFuzzy, limit, offset, text

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

deserialize, toSearch

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

canDeserialize, httpRequestIntent

Method Detail

withText

C withText(LocalizedStringEntry text)

Returns a new object with the new text as search text.

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

C withText(Locale locale,
           String text)

Returns a new object with the new text as search text.

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

C withFuzzy(Boolean fuzzy)

Returns an ResourceSearch with modified fuzzy parameter.

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

C withFuzzyLevel(Integer fuzzyLevel)

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.

Parameters:

fuzzyLevel - defines level of unsharpness of the search using the Damerau-Levenshtein distance

Returns:

an ResourceSearch with the new fuzzyLevel setting

withLimit

C withLimit(Long limit)

Returns a new object with the new limit.

Parameters:

limit - the new limit

Returns:

a new object with limit

withLimit

default C withLimit(long limit)

Returns a new object with the new limit.

Parameters:

limit - the new limit

Returns:

a new object with limit

withOffset

C withOffset(Long offset)

Returns a new object with the new offset.

Parameters:

offset - the new offset

Returns:

a new object with offset

withOffset

default C withOffset(long offset)

Returns a new object with the new offset.

Parameters:

offset - the new offset

Returns:

a new object with offset