Package ca.uhn.fhir.jpa.search.cache

Interface ISearchResultCacheSvc

All Known Implementing Classes:
DatabaseSearchResultCacheSvcImpl
public interface ISearchResultCacheSvc

  • Method Summary

    Modifier and Type
    Method
    Description
    List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId>
    fetchAllResultPids(Search theSearch)
    Fetch all result PIDs for a given search with no particular order required
    List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId>
    fetchResultPids(Search theSearch, int theFrom, int theTo)
    Fetch a sunset of the search result IDs from the cache
    void
    storeResults(Search theSearch, List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> thePreviouslyStoredResourcePids, List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> theNewResourcePids)
     

  • Method Details

    • storeResults

      void storeResults(Search theSearch, List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> thePreviouslyStoredResourcePids, List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> theNewResourcePids)
      Parameters:
      theSearch - The search - This method is not required to persist any chances to the Search object, it is only provided here for identification
      thePreviouslyStoredResourcePids - A list of resource PIDs that have previously been saved to this search
      theNewResourcePids - A list of new resoure PIDs to add to this search (these ones have not been previously saved)

    • fetchResultPids

      @Nullable List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> fetchResultPids(Search theSearch, int theFrom, int theTo)
      Fetch a sunset of the search result IDs from the cache
      Parameters:
      theSearch - The search to fetch IDs for
      theFrom - The starting index (inclusive)
      theTo - The ending index (exclusive)
      Returns:
      A list of resource PIDs, or null if the results no longer exist (this should only happen if the results have been removed from the cache for some reason, such as expiry or manual purge)

    • fetchAllResultPids

      @Nullable List<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> fetchAllResultPids(Search theSearch)
      Fetch all result PIDs for a given search with no particular order required
      Parameters:
      theSearch - The search object
      Returns:
      A list of resource PIDs, or null if the results no longer exist (this should only happen if the results have been removed from the cache for some reason, such as expiry or manual purge)