Package org.springframework.graphql.data.query

Class QueryByExampleDataFetcher.Builder<T,R>

java.lang.Object

org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder<T,R>

Type Parameters:

T - domain type

R - result type

Enclosing class:

QueryByExampleDataFetcher<T>

public static class QueryByExampleDataFetcher.Builder<T,R>
extends Object

Builder for a Query by Example-based DataFetcher. Note that builder instances are immutable and return a new instance of the builder when calling configuration methods.

Method Summary

Modifier and Type	Method	Description
QueryByExampleDataFetcher.Builder<T,R>	cursorStrategy(CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy)	Configure strategy for decoding a cursor from a paginated request.
QueryByExampleDataFetcher.Builder<T,R>	defaultScrollSubrange(ScrollSubrange defaultSubrange)	Configure a ScrollSubrange to use when a paginated request does not specify a cursor and/or a count of items.
DataFetcher<Iterable<R>>	many()	Build a DataFetcher to fetch many object instances.
<P> QueryByExampleDataFetcher.Builder<T,P>	projectAs(Class<P> projectionType)	Project results returned from the QueryByExampleExecutor into the target projectionType.
DataFetcher<Iterable<R>>	scrollable()	Build a DataFetcher that scrolls and returns Window.
DataFetcher<R>	single()	Build a DataFetcher to fetch single object instances.
QueryByExampleDataFetcher.Builder<T,R>	sortBy(org.springframework.data.domain.Sort sort)	Apply a Sort order.

Methods inherited from class java.lang.Object

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

Method Details

projectAs

public <P> QueryByExampleDataFetcher.Builder<T,P> projectAs(Class<P> projectionType)

Project results returned from the QueryByExampleExecutor into the target projectionType. Projection types can be either interfaces with property getters to expose or regular classes outside the entity type hierarchy for DTO projections.

Parameters:

projectionType - projection type

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and projectionType applied

cursorStrategy

public QueryByExampleDataFetcher.Builder<T,R> cursorStrategy(@Nullable
 CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy)

Configure strategy for decoding a cursor from a paginated request.

By default, this is ScrollPositionCursorStrategy with CursorEncoder.base64() encoding.

Parameters:

cursorStrategy - the strategy to use

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and Sort applied

Since:

1.2.0

defaultScrollSubrange

public QueryByExampleDataFetcher.Builder<T,R> defaultScrollSubrange(@Nullable
 ScrollSubrange defaultSubrange)

Configure a ScrollSubrange to use when a paginated request does not specify a cursor and/or a count of items.

By default, this is OffsetScrollPosition.initial() with a count of 20.

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and Sort applied

Since:

1.2.0

sortBy

public QueryByExampleDataFetcher.Builder<T,R> sortBy(org.springframework.data.domain.Sort sort)

Apply a Sort order.

Parameters:

sort - the default sort order

Returns:

a new QueryByExampleDataFetcher.Builder instance with all previously configured options and Sort applied

single

public DataFetcher<R> single()

Build a DataFetcher to fetch single object instances.

many

public DataFetcher<Iterable<R>> many()

Build a DataFetcher to fetch many object instances.

scrollable

public DataFetcher<Iterable<R>> scrollable()

Build a DataFetcher that scrolls and returns Window.

Since:

1.2.0