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

Class FullTextExtractionRequest

java.lang.Object

ca.uhn.fhir.jpa.searchparam.fulltext.FullTextExtractionRequest

public class FullTextExtractionRequest
extends Object

This is a request object containing a request to extract the FullText index data from a resource during storage.

Since:

8.4.0

See Also:

• invalid reference

  for a description of how this should be used.

Constructor Summary

Constructors

Constructor	Description
FullTextExtractionRequest(org.hl7.fhir.instance.model.api.IIdType theResourceId, org.hl7.fhir.instance.model.api.IBaseResource theResource, String theResourceType, Supplier<String> theDefaultSupplier)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getDefaultString()
org.hl7.fhir.instance.model.api.IBaseResource	getResource()
org.hl7.fhir.instance.model.api.IIdType	getResourceId()
String	getResourceType()
boolean	isDelete()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FullTextExtractionRequest

public FullTextExtractionRequest(@Nullable
 org.hl7.fhir.instance.model.api.IIdType theResourceId,
 @Nullable
 org.hl7.fhir.instance.model.api.IBaseResource theResource,
 @Nonnull
 String theResourceType,
 @Nonnull
 Supplier<String> theDefaultSupplier)

Constructor

Method Details

isDelete

public boolean isDelete()

Returns:

Returns true if this request represents a resource deletion

getResourceId

@Nullable
public org.hl7.fhir.instance.model.api.IIdType getResourceId()

Returns:

Returns the ID of the resource being indexed. This may be null if a new resource is being created, and a type isn't assigned yet

getResource

@Nullable
public org.hl7.fhir.instance.model.api.IBaseResource getResource()

Returns:

Returns the resource being indexed. May be null if the operation is a resource deletion.

getResourceType

@Nonnull
public String getResourceType()

Returns:

Returns the resource type being indexed.

getDefaultString

public String getDefaultString()

Returns:

Returns the extracted content/text string that is automatically extracted from the resource