Package ca.uhn.fhir.jpa.searchparam.fulltext

Class FullTextExtractionResponse

java.lang.Object
ca.uhn.fhir.jpa.searchparam.fulltext.FullTextExtractionResponse
public class FullTextExtractionResponse extends Object
This is a response object containing the FullText index data which should be stored during indexing, or an instruction to skip FullText indexing for the given resource.
Since:
8.4.0
See Also:
  • invalid reference 
    for a description of how this should be used.

  • Method Details

    • doNotIndex

      public static FullTextExtractionResponse doNotIndex()
      Creates a response signalling that the given resource should not be indexed.

      Note the difference between invoking doNotIndex() and invoking indexPayload(String) with a null payload! Invoking doNotIndex() signals to the fulltext engine that the fulltext indexer should skip processing this resource, whereas invoking indexPayload(String) with a null payload signals to the fulltext engine that any existing row should be cleared. This distinction is important in the case of resource deletions, since invoking #doNotIndex() when deleting a previously fulltext indexed row will leave the previous fulltext index in place, which can waste index space and make queries inefficient.

    • indexPayload

      public static FullTextExtractionResponse indexPayload(@Nonnull String thePayload)
      Creates a response signalling that the given resource should be indexed with the given payload. Calling this method with a null payload value is subtly different from calling doNotIndex(). This method will clear any existing indexing and write an empty index, where doNotIndex() will not touch any existing index.
      Parameters:
      thePayload - The fulltext payload string. May be null if no payload should be specified for the given resource.

    • indexNormally

      public static FullTextExtractionResponse indexNormally()
      Creates a response signalling that the standard indexing should be used.

    • isDoNotIndex

      public boolean isDoNotIndex()

    • getPayload

      public String getPayload()

    • isIndexNormally

      public boolean isIndexNormally()