Package org.allGraphQLCases.server

Interface DataFetchersDelegateTFoo1

All Known Implementing Classes:
DataFetchersDelegateTFoo1Impl
public interface DataFetchersDelegateTFoo1
This interface contains the fata fetchers that are delegated in the bean that the implementation has to provide, when fetching fields for the TFoo1 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
    STP_TBar1_STS
    bar(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, STP_TFoo1_STS origin)
    Description for the bar field:
    The 'bar' field is a valid GraphQL field.
    CompletableFuture<STP_TBar1_STS>
    bar(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, org.dataloader.DataLoader<UUID,STP_TBar1_STS> dataLoader, STP_TFoo1_STS origin)
    Description for the bar field:
    The 'bar' field is a valid GraphQL field.
    default List<STP_TFoo1_STS>
    batchLoader(List<UUID> keys, org.dataloader.BatchLoaderEnvironment environment)
    This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched.
    default List<STP_TFoo1_STS>
    unorderedReturnBatchLoader(List<UUID> keys, org.dataloader.BatchLoaderEnvironment environment)
    This method loads a list of ${dataFetcher.field.name}, based on the list of id to be fetched.

  • Method Details

    • bar

      CompletableFuture<STP_TBar1_STS> bar(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, org.dataloader.DataLoader<UUID,STP_TBar1_STS> dataLoader, STP_TFoo1_STS origin)
      Description for the bar field:
      The 'bar' field is a valid GraphQL field. But before correction of the issue #114, the generated Java code would not compile, as the TBar is a concrete class that implements IBar (and not IBar itself as declared in IFoo)
      This method loads the data for TFoo1.bar.
      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 this: 
      

      

      Parameters:
      

      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      

      dataLoader - The DataLoader 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-dataloader
      

      origin - The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the bar attribute
    of the origin, which is an instance of {ObjectType {name:TFoo1, fields:{Field{name:id, type:ID, params:[]},Field{name:bar, type:TBar1, params:[]}}, implements IFoo1, 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.
      

      

      

      • 

    • 

      

      bar
      

      STP_TBar1_STS bar(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment,
 STP_TFoo1_STS origin)
      

      Description for the bar field: 
      
 
 The 'bar' field is a valid GraphQL field. 
 But before correction of the issue #114, the generated Java code would not compile, as the TBar is a concrete class that implements IBar
 (and not IBar itself as declared in IFoo)
 
      

 This method loads the data for TFoo1.bar. 
 
      

      

      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 bar attribute
    of the origin, which is an instance of {ObjectType {name:TFoo1, fields:{Field{name:id, type:ID, params:[]},Field{name:bar, type:TBar1, params:[]}}, implements IFoo1, 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<STP_TFoo1_STS> batchLoader(List<UUID> keys,
 org.dataloader.BatchLoaderEnvironment environment)
      

      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
      

      environment - The Data Loader environment
      

      Returns:
      

      A list of IDs
      

      

      

      • 

    • 

      

      unorderedReturnBatchLoader
      

      default List<STP_TFoo1_STS> unorderedReturnBatchLoader(List<UUID> keys,
 org.dataloader.BatchLoaderEnvironment environment)
      

      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
      

      environment - The Data Loader environment
      

      Returns:
      

      

      

      • 

    

    

    •