io.sphere.sdk.queries

Class MetaModelGetDslImpl<R,T,C extends MetaModelGetDsl<R,T,C,E>,E>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.queries.MetaModelGetDslImpl<R,T,C,E>

Type Parameters:

R - result type, maybe directly T or sth. like List<T>

T - type of the query result

C - type of the class implementing this class

E - type of the expansion model

All Implemented Interfaces:

SphereRequest<R>, ExpansionPathContainer<T>, MetaModelExpansionDslExpansionModelRead<T,C,E>, MetaModelReferenceExpansionDsl<T,C,E>, ReferenceExpansionDsl<T,C>, ReferenceExpansionSupport<T>, Get<R>, GetDsl<R,T,C>, MetaModelGetDsl<R,T,C,E>

public abstract class MetaModelGetDslImpl<R,T,C extends MetaModelGetDsl<R,T,C,E>,E>
extends Base
implements MetaModelGetDsl<R,T,C,E>, MetaModelExpansionDslExpansionModelRead<T,C,E>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaModelGetDslImpl(com.fasterxml.jackson.databind.JavaType javaType, String endpoint, String identifierToSearchFor, List<ExpansionPath<T>> expansionPaths, E expansionModel, Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction, List<NameValuePair> additionalParameters)
protected	MetaModelGetDslImpl(JsonEndpoint<R> endpoint, String identifierToSearchFor, E expansionModel, Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction, List<NameValuePair> additionalParameters)
protected	MetaModelGetDslImpl(MetaModelGetDslBuilder<R,T,C,E> builder)
protected	MetaModelGetDslImpl(String identifierToSearchFor, JsonEndpoint<R> endpoint, E expansionModel, Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction)

Method Summary

Modifier and Type	Method and Description
protected List<NameValuePair>	additionalQueryParameters()
boolean	canDeserialize(HttpResponse httpResponse) Checks if the response can be handled by SphereRequest.deserialize(HttpResponse).
protected MetaModelGetDslBuilder<R,T,C,E>	copyBuilder()
R	deserialize(HttpResponse httpResponse) Takes an http response and maps it into a Java object of type T.
E	expansionModel()
List<ExpansionPath<T>>	expansionPaths()
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
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.
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.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

plusExpansionPaths, withExpansionPaths

Constructor Detail

MetaModelGetDslImpl

protected MetaModelGetDslImpl(JsonEndpoint<R> endpoint,
                              String identifierToSearchFor,
                              E expansionModel,
                              Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction,
                              List<NameValuePair> additionalParameters)

MetaModelGetDslImpl

protected MetaModelGetDslImpl(String identifierToSearchFor,
                              JsonEndpoint<R> endpoint,
                              E expansionModel,
                              Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction)

MetaModelGetDslImpl

protected MetaModelGetDslImpl(MetaModelGetDslBuilder<R,T,C,E> builder)

MetaModelGetDslImpl

protected MetaModelGetDslImpl(com.fasterxml.jackson.databind.JavaType javaType,
                              String endpoint,
                              String identifierToSearchFor,
                              List<ExpansionPath<T>> expansionPaths,
                              E expansionModel,
                              Function<MetaModelGetDslBuilder<R,T,C,E>,C> builderFunction,
                              List<NameValuePair> additionalParameters)

Method Detail

deserialize

@Nullable
public R 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<R>

Specified by:

deserialize in interface Get<R>

Parameters:

httpResponse - the http response of the API

Returns:

the deserialized object

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<R>

Returns:

http request intent

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

additionalQueryParameters

protected List<NameValuePair> additionalQueryParameters()

canDeserialize

public boolean canDeserialize(HttpResponse httpResponse)

Description copied from interface: SphereRequest

Checks if the response can be handled by SphereRequest.deserialize(HttpResponse). Use case 1: A http response returns 404 and the this SphereRequest can handle this error by returning an empty optional, an empty list or throwing a domain specific exception.

Specified by:

canDeserialize in interface SphereRequest<R>

Parameters:

httpResponse - the http response which shall be transformed

Returns:

true if the http response can be consumed, false otherwise

expansionPaths

public List<ExpansionPath<T>> expansionPaths()

Specified by:

expansionPaths in interface ExpansionPathContainer<T>

Specified by:

expansionPaths in interface ReferenceExpansionSupport<T>

withExpansionPaths

public final 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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,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 MetaModelGetDsl<R,T,C,E>>

Parameters:

expansionPath - the new expansion path to add to the existing ones

Returns:

new object

expansionModel

public E expansionModel()

Specified by:

expansionModel in interface MetaModelExpansionDslExpansionModelRead<T,C extends MetaModelGetDsl<R,T,C,E>,E>

copyBuilder

protected MetaModelGetDslBuilder<R,T,C,E> copyBuilder()

withAdditionalQueryParameters

protected C withAdditionalQueryParameters(List<NameValuePair> pairs)