Package org.starwars.server.util
Class CharacterController
java.lang.Object
org.starwars.server.util.CharacterController
- Author:
- generated by graphql-java-generator
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected DataFetchersDelegateCharacter
protected GraphqlServerUtils
-
Constructor Summary
ConstructorDescriptionCharacterController
(org.springframework.graphql.execution.BatchLoaderRegistry registry) -
Method Summary
Modifier and TypeMethodDescriptionThis method loads the data for ${dataFetcher.graphQLType}.appearsIn.This method loads the data for ${dataFetcher.graphQLType}.friends.
-
Field Details
-
dataFetchersDelegateCharacter
-
graphqlServerUtils
-
-
Constructor Details
-
CharacterController
public CharacterController(org.springframework.graphql.execution.BatchLoaderRegistry registry)
-
-
Method Details
-
friends
@SchemaMapping(field="friends") public Object friends(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin) This method loads the data for ${dataFetcher.graphQLType}.friends.
For optimization, this method returns a CompletableFuture. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server.
The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
You can implements this method like the sample below:@Override public CompletableFuture<List
> friends(DataFetchingEnvironment environment, DataLoader<Long, Member> dataLoader, Human origin) { List<java.lang.Long> friendIds = origin.getFriendIds(); DataLoader<java.lang.Long, CharacterImpl> dataLoader = environment.getDataLoader("Character"); return dataLoader.loadMany(friendIds); } - Parameters:
dataFetchingEnvironment
- The GraphQLDataFetchingEnvironment
. It gives you access to the full GraphQL context for this DataFetcherdataLoader
- TheDataLoader
allows to load several data in one query. It allows to solve the (n+1) queries issues, and greatly optimizes the response time.
You'll find more informations here: https://github.com/graphql-java/java-dataloaderorigin
- The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the author attribute of the origin, which is an instance of {ObjectType {name:Post, fields:{Field{name:id, type:ID!, params:[]},Field{name:date, type:Date!, params:[]},Field{name:author, type:Member, params:[]},Field{name:publiclyAvailable, type:Boolean, params:[]},Field{name:title, type:String!, params:[]},Field{name:content, type:String!, params:[]},Field{name:authorId, type:ID, params:[]},Field{name:topicId, type:ID, params:[]}}, comments ""}. It depends on your data modle, but it typically contains the id to use in the query.- Throws:
NoSuchElementException
- This method may return aNoSuchElementException
exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use theOptional.get()
method directly, without caring of whether or not there is a value. The generated code will take care of theNoSuchElementException
exception.
-
appearsIn
@SchemaMapping(field="appearsIn") public Object appearsIn(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin) This method loads the data for ${dataFetcher.graphQLType}.appearsIn.
For optimization, this method returns a CompletableFuture. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server.
The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
You can implements this method like the sample below:@Override public CompletableFuture<List
> friends(DataFetchingEnvironment environment, DataLoader<Long, Member> dataLoader, Human origin) { List<java.lang.Long> friendIds = origin.getFriendIds(); DataLoader<java.lang.Long, CharacterImpl> dataLoader = environment.getDataLoader("Character"); return dataLoader.loadMany(friendIds); }
To manage enum values that are java keyword, enum values like if, else (...) are stored in enum values prefixed by _ (like _if, _else...) But this prevents the automatic mapping of spring-graphql to work. So enum values are returned as String- Parameters:
dataFetchingEnvironment
- The GraphQLDataFetchingEnvironment
. It gives you access to the full GraphQL context for this DataFetcherdataLoader
- TheDataLoader
allows to load several data in one query. It allows to solve the (n+1) queries issues, and greatly optimizes the response time.
You'll find more informations here: https://github.com/graphql-java/java-dataloaderorigin
- The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the author attribute of the origin, which is an instance of {ObjectType {name:Post, fields:{Field{name:id, type:ID!, params:[]},Field{name:date, type:Date!, params:[]},Field{name:author, type:Member, params:[]},Field{name:publiclyAvailable, type:Boolean, params:[]},Field{name:title, type:String!, params:[]},Field{name:content, type:String!, params:[]},Field{name:authorId, type:ID, params:[]},Field{name:topicId, type:ID, params:[]}}, comments ""}. It depends on your data modle, but it typically contains the id to use in the query.- Throws:
NoSuchElementException
- This method may return aNoSuchElementException
exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use theOptional.get()
method directly, without caring of whether or not there is a value. The generated code will take care of theNoSuchElementException
exception.
-