Package ca.cdr.api.fhir.tokenization

Class TokenizationRequest

java.lang.Object

ca.cdr.api.fhir.tokenization.TokenizationRequest

public class TokenizationRequest
extends Object

Constructor Summary

Constructors

Constructor	Description
TokenizationRequest(TokenizationRuleJson theRule, IBase theSourceElement, IQueryParameterType theObjectQueryParameter, FhirContext theFhirContext)	Constructor
TokenizationRequest(TokenizationRuleJson theRule, IBase theSourceElement, IBase theObject, boolean theNonNormalizedCopy, FhirContext theFhirContext)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getObjectAsString()	Returns the underlying HAPI FHIR object to be tokenized, converted into a string
IBase	getObjectElement()	Returns the underlying HAPI FHIR object to be tokenized.
IQueryParameterType	getObjectQueryParameter()	Returns the underlying HAPI FHIR query parameter object to be tokenized.
TokenizationRuleJson	getRule()	This is the rule which resulted in this request.
IBase	getSourceElement()	Returns the FHIR element which was the source of the tokenization request.
boolean	isNonNormalizedCopy()	If the rule specified a TokenizationRuleJson.getSearchValueNormalization() algorithm, then it will result in two tokenization requests.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TokenizationRequest

public TokenizationRequest(@Nonnull
 TokenizationRuleJson theRule,
 @Nullable
 IBase theSourceElement,
 @Nonnull
 IBase theObject,
 boolean theNonNormalizedCopy,
 @Nonnull
 FhirContext theFhirContext)

Constructor

TokenizationRequest

public TokenizationRequest(@Nonnull
 TokenizationRuleJson theRule,
 @Nullable
 IBase theSourceElement,
 @Nonnull
 IQueryParameterType theObjectQueryParameter,
 @Nonnull
 FhirContext theFhirContext)

Constructor

Method Details

getSourceElement

@Nullable
public IBase getSourceElement()

Returns the FHIR element which was the source of the tokenization request. This method may return null in some cases, such as when a search parameter is being tokenized.

isNonNormalizedCopy

public boolean isNonNormalizedCopy()

If the rule specified a TokenizationRuleJson.getSearchValueNormalization() algorithm, then it will result in two tokenization requests. One for the normalized value, and one for the original (non-normalized) version. This method will return true if this is such a non-normalized version.

getRule

@Nonnull
public TokenizationRuleJson getRule()

This is the rule which resulted in this request. Providers should not modify this object.

getObjectElement

@Nullable
public IBase getObjectElement()

Returns the underlying HAPI FHIR object to be tokenized. If this method returns a value, getObjectQueryParameter() will return null and vice versa.

getObjectQueryParameter

@Nullable
public IQueryParameterType getObjectQueryParameter()

Returns the underlying HAPI FHIR query parameter object to be tokenized. If this method returns a value, getObjectElement() will return null and vice versa.

getObjectAsString

public String getObjectAsString()

Returns the underlying HAPI FHIR object to be tokenized, converted into a string

toString

public String toString()

Overrides:

toString in class Object