Package org.starwars.server.util

Interface DataFetchersDelegateCharacter

All Known Implementing Classes:
DataFetchersDelegateCharacterImpl
public interface DataFetchersDelegateCharacter
This interface contains the fata fetchers that are delegated in the bean that the implementation has to provide, when fetching fields for the Character GraphQL type, as defined in the provided GraphQL schema. Please read the wiki server page for more information on this.
Author:
generated by graphql-java-generator
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    appearsIn(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin)
    This method loads the data for Character.appearsIn.
    default List<Character>
    batchLoader(List<UUID> keys)
    This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched.
    Object
    friends(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin)
    This method loads the data for Character.friends.
    default List<Character>
    unorderedReturnBatchLoader(List<UUID> keys)
    This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched.

  • Method Details

    • friends

      Object friends(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin)
      This method loads the data for Character.friends. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a List<org.starwars.server.Character>)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<List<org.starwars.server.Character>> or a Flux<List<org.starwars.server.Character>>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<List<org.starwars.server.Character>>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<List<org.starwars.server.Character>>. 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.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      origin - The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the friends attribute of the origin, which is an instance of {InterfaceType {name:Character, fields:{Field{name:id, type:ID!, params:[]},Field{name:name, type:String!, params:[]},Field{name:friends, type:[Character], params:[]},Field{name:appearsIn, type:[Episode]!, 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 a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • appearsIn

      Object appearsIn(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, Character origin)
      This method loads the data for Character.appearsIn. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a List<org.starwars.server.Episode>)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<List<org.starwars.server.Episode>> or a Flux<List<org.starwars.server.Episode>>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<List<org.starwars.server.Episode>>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<List<org.starwars.server.Episode>>. 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.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      origin - The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the appearsIn attribute of the origin, which is an instance of {InterfaceType {name:Character, fields:{Field{name:id, type:ID!, params:[]},Field{name:name, type:String!, params:[]},Field{name:friends, type:[Character], params:[]},Field{name:appearsIn, type:[Episode]!, 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 a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • batchLoader

      default List<Character> batchLoader(List<UUID> keys)
      This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched. This method is used by graphql-java java-dataloader to highly optimize the number of requests to the server, when recursing down through the object associations.
      You can find more information on this page: graphql-java batching
      Important notes:
      • The list returned by this method must be sorted in the exact same order as the given keys list. If values are missing (no value for a given key), then the returned list must contain a null value at this key's position.
      • One of batchLoader or unorderedReturnBatchLoader must be overriden in the data fetcher implementation. If not, then a NullPointerException will be thrown at runtime, with a proper error message.
      • If your data storage implementation makes it complex to return values in the same order as the keys list, then it's easier to override unorderedReturnBatchLoader, and let the default implementation of batchLoader order the values
      Parameters:
      keys - A list of ID's id, for which the matching objects must be returned
      Returns:
      A list of IDs

    • unorderedReturnBatchLoader

      default List<Character> unorderedReturnBatchLoader(List<UUID> keys)
      This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched. This method is used by graphql-java java-dataloader to highly optimize the number of requests to the server, when recursing down through the object associations.
      You can find more information on this page: graphql-java batching
      Important notes:
      • The list returned may be in any order: this method is called by the default implementation of batchLoader, which will sort the value return by this method, according to the given keys list.
      • There may be missing values (no value for a given key): the default implementation of batchLoader will replace these missing values by a null value at this key's position.
      • One of batchLoader or unorderedReturnBatchLoader must be overriden in the data fetcher implementation. If not, then a NullPointerException will be thrown at runtime, with a proper error message.
      • If your data storage implementation makes it complex to return values in the same order as the keys list, then it's easier to override unorderedReturnBatchLoader, and let the default implementation of batchLoader order the values
      • If your data storage implementation makes it easy to return values in the same order as the keys list, then the execution is a little quicker if you override batchLoader, as there would be no sort of the returned list.
      Parameters:
      keys - A list of ID's id, for which the matching objects must be returned
      Returns: