io.sphere.sdk.queries

Class QueryExecutionUtils

java.lang.Object

io.sphere.sdk.queries.QueryExecutionUtils

public final class QueryExecutionUtils
extends Object

Provides facilities to fetch all elements matching a query predicate.

Since:

1.0.0-RC1

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
static <T,C extends QueryDsl<T,C>> CompletionStage<List<T>>	queryAll(SphereClient client, QueryDsl<T,C> query) Queries all elements matching a query by using an offset based pagination with page size 500.
static <T,C extends QueryDsl<T,C>> CompletionStage<Void>	queryAll(SphereClient client, QueryDsl<T,C> query, Consumer<T> resultsConsumer) Queries all elements matching a query by using an offset based pagination with page size 500.
static <T,C extends QueryDsl<T,C>> CompletionStage<Void>	queryAll(SphereClient client, QueryDsl<T,C> query, Consumer<T> resultsConsumer, int pageSize) Queries all elements matching a query by using an offset based pagination.
static <T,C extends QueryDsl<T,C>,S> CompletionStage<List<S>>	queryAll(SphereClient client, QueryDsl<T,C> query, Function<T,S> resultsMapper) Queries all elements matching a query by using an offset based pagination with page size 500.
static <T,C extends QueryDsl<T,C>,S> CompletionStage<List<S>>	queryAll(SphereClient client, QueryDsl<T,C> query, Function<T,S> resultsMapper, int pageSize) Queries all elements matching a query by using an offset based pagination.
static <T,C extends QueryDsl<T,C>> CompletionStage<List<T>>	queryAll(SphereClient client, QueryDsl<T,C> query, int pageSize) Queries all elements matching a query by using an offset based pagination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Method Detail

queryAll

public static <T,C extends QueryDsl<T,C>> CompletionStage<List<T>> queryAll(SphereClient client,
                                                                            QueryDsl<T,C> query)

Queries all elements matching a query by using an offset based pagination with page size 500.

Type Parameters:

T - type of one query result element

C - type of the query

Parameters:

client - commercetools Composable Commerce client

query - query containing predicates and expansion paths

Returns:

elements

queryAll

public static <T,C extends QueryDsl<T,C>> CompletionStage<List<T>> queryAll(SphereClient client,
                                                                            QueryDsl<T,C> query,
                                                                            int pageSize)

Queries all elements matching a query by using an offset based pagination.

Type Parameters:

T - type of one query result element

C - type of the query

Parameters:

client - commercetools Composable Commerce client

query - query containing predicates and expansion paths

pageSize - size of one batch to fetch

Returns:

elements

queryAll

@Nonnull
public static <T,C extends QueryDsl<T,C>,S> CompletionStage<List<S>> queryAll(@Nonnull
                                                                                       SphereClient client,
                                                                                       @Nonnull
                                                                                       QueryDsl<T,C> query,
                                                                                       @Nonnull
                                                                                       Function<T,S> resultsMapper)

Queries all elements matching a query by using an offset based pagination with page size 500. The method takes a callback Function that returns a result of type <S> that is returned on every page of elements queried. Eventually, the method returns a CompletionStage that contains a list of all the results of the callbacks returned from every page.

Type Parameters:

T - type of one query result element

C - type of the query

S - type of the returned result of the callback function on every page.

Parameters:

client - commercetools Composable Commerce client

query - query containing predicates and expansion paths

resultsMapper - callback function that is called on every page queried.

Returns:

elements

queryAll

@Nonnull
public static <T,C extends QueryDsl<T,C>,S> CompletionStage<List<S>> queryAll(@Nonnull
                                                                                       SphereClient client,
                                                                                       @Nonnull
                                                                                       QueryDsl<T,C> query,
                                                                                       @Nonnull
                                                                                       Function<T,S> resultsMapper,
                                                                                       int pageSize)

Queries all elements matching a query by using an offset based pagination. The method takes a callback Function that returns a result of type <S> that is returned on every page of elements queried. Eventually, the method returns a CompletionStage that contains a list of all the results of the callbacks returned from every page.

Type Parameters:

T - type of one query result element

C - type of the query

S - type of the returned result of the callback function on every page.

Parameters:

client - commercetools Composable Commerce client

query - query containing predicates and expansion paths

resultsMapper - callback function that is called on every page queried.

pageSize - the page size.

Returns:

elements

queryAll

@Nonnull
public static <T,C extends QueryDsl<T,C>> CompletionStage<Void> queryAll(@Nonnull
                                                                                  SphereClient client,
                                                                                  @Nonnull
                                                                                  QueryDsl<T,C> query,
                                                                                  @Nonnull
                                                                                  Consumer<T> resultsConsumer)

Queries all elements matching a query by using an offset based pagination with page size 500. The method takes a consumer Consumer that is applied on on every page of elements queried.

Type Parameters:

T - type of one query result element

C - type of the query

Parameters:

client - commercetools client

query - query containing predicates and expansion paths

resultsConsumer - that is applied on every page queried.

Returns:

elements

queryAll

@Nonnull
public static <T,C extends QueryDsl<T,C>> CompletionStage<Void> queryAll(@Nonnull
                                                                                  SphereClient client,
                                                                                  @Nonnull
                                                                                  QueryDsl<T,C> query,
                                                                                  @Nonnull
                                                                                  Consumer<T> resultsConsumer,
                                                                                  int pageSize)

Queries all elements matching a query by using an offset based pagination. The method takes a consumer Consumer that is applied on on every page of elements queried.

Type Parameters:

T - type of one query result element

C - type of the query

Parameters:

client - commercetools Composable Commerce client

query - query containing predicates and expansion paths

resultsConsumer - that is applied on every page queried.

pageSize - the page size.

Returns:

elements