Package org.allGraphQLCases.server

Interface DataFetchersDelegateWithID

All Known Implementing Classes:
DataFetchersDelegateWithIDImpl
public interface DataFetchersDelegateWithID
This interface contains the fata fetchers that are delegated in the bean that the implementation has to provide, when fetching fields for the WithID 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
    default List<SIP_WithID_SIS>
    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<SIP_WithID_SIS>
    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

    • batchLoader

      default List<SIP_WithID_SIS> 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<SIP_WithID_SIS> 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: