Package org.hl7.fhir.r4.utils

Class LiquidEngine

java.lang.Object

org.hl7.fhir.r4.utils.LiquidEngine

All Implemented Interfaces:

FHIRPathEngine.IEvaluationContext

public class LiquidEngine
extends Object
implements FHIRPathEngine.IEvaluationContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LiquidEngine.ILiquidEngineIcludeResolver
static class	LiquidEngine.LiquidDocument

Constructor Summary

Constructors

Constructor	Description
LiquidEngine(IWorkerContext context, FHIRPathEngine.IEvaluationContext hostServices)

Method Summary

Modifier and Type	Method	Description
TypeDetails	checkFunction(FHIRPathEngine engine, Object appContext, String functionName, TypeDetails focus, List<TypeDetails> parameters)	Check the function parameters, and throw an error if they are incorrect, or return the type for the function
boolean	conformsToProfile(FHIRPathEngine engine, Object appContext, Base item, String url)
String	evaluate(LiquidEngine.LiquidDocument document, Resource resource, Object appContext)
List<Base>	executeFunction(FHIRPathEngine engine, Object appContext, List<Base> focus, String functionName, List<List<Base>> parameters)
LiquidEngine.ILiquidEngineIcludeResolver	getIncludeResolver()
boolean	log(String argument, List<Base> focus)	when the .log() function is called
LiquidEngine.LiquidDocument	parse(String source, String sourceName)
List<Base>	resolveConstant(FHIRPathEngine engine, Object appContext, String name, boolean beforeContext, boolean explicitConstant)	A constant reference - e.g.
TypeDetails	resolveConstantType(FHIRPathEngine engine, Object appContext, String name, boolean explicitConstant)
FHIRPathUtilityClasses.FunctionDetails	resolveFunction(FHIRPathEngine engine, String functionName)
Base	resolveReference(FHIRPathEngine engine, Object appContext, String url, Base base)	Implementation of resolve() function.
ValueSet	resolveValueSet(FHIRPathEngine engine, Object appContext, String url)
void	setIncludeResolver(LiquidEngine.ILiquidEngineIcludeResolver includeResolver)

Methods inherited from class java.lang.Object

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

Constructor Detail

LiquidEngine

public LiquidEngine(IWorkerContext context,
                    FHIRPathEngine.IEvaluationContext hostServices)

Method Detail

getIncludeResolver

public LiquidEngine.ILiquidEngineIcludeResolver getIncludeResolver()

setIncludeResolver

public void setIncludeResolver(LiquidEngine.ILiquidEngineIcludeResolver includeResolver)

parse

public LiquidEngine.LiquidDocument parse(String source,
                                         String sourceName)
                                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

evaluate

public String evaluate(LiquidEngine.LiquidDocument document,
                       Resource resource,
                       Object appContext)
                throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

resolveConstant

public List<Base> resolveConstant(FHIRPathEngine engine,
                                  Object appContext,
                                  String name,
                                  boolean beforeContext,
                                  boolean explicitConstant)
                           throws org.hl7.fhir.exceptions.PathEngineException

Description copied from interface: FHIRPathEngine.IEvaluationContext

A constant reference - e.g. a reference to a name that must be resolved in context. The % will be removed from the constant name before this is invoked. Variables created with defineVariable will not be processed by resolveConstant (or resolveConstantType) This will also be called if the host invokes the FluentPath engine with a context of null

Specified by:

resolveConstant in interface FHIRPathEngine.IEvaluationContext

appContext - - content passed into the fluent path engine

name - - name reference to resolve

beforeContext - - whether this is being called before the name is resolved locally, or not

Returns:

the value of the reference (or null, if it's not valid, though can throw an exception if desired)

Throws:

org.hl7.fhir.exceptions.PathEngineException

resolveConstantType

public TypeDetails resolveConstantType(FHIRPathEngine engine,
                                       Object appContext,
                                       String name,
                                       boolean explicitConstant)
                                throws org.hl7.fhir.exceptions.PathEngineException

Specified by:

resolveConstantType in interface FHIRPathEngine.IEvaluationContext

Throws:

org.hl7.fhir.exceptions.PathEngineException

log

public boolean log(String argument,
                   List<Base> focus)

Description copied from interface: FHIRPathEngine.IEvaluationContext

when the .log() function is called

Specified by:

log in interface FHIRPathEngine.IEvaluationContext

Returns:

resolveFunction

public FHIRPathUtilityClasses.FunctionDetails resolveFunction(FHIRPathEngine engine,
                                                              String functionName)

Specified by:

resolveFunction in interface FHIRPathEngine.IEvaluationContext

Returns:

null if the function is not known

checkFunction

public TypeDetails checkFunction(FHIRPathEngine engine,
                                 Object appContext,
                                 String functionName,
                                 TypeDetails focus,
                                 List<TypeDetails> parameters)
                          throws org.hl7.fhir.exceptions.PathEngineException

Description copied from interface: FHIRPathEngine.IEvaluationContext

Check the function parameters, and throw an error if they are incorrect, or return the type for the function

Specified by:

checkFunction in interface FHIRPathEngine.IEvaluationContext

Returns:

Throws:

org.hl7.fhir.exceptions.PathEngineException

executeFunction

public List<Base> executeFunction(FHIRPathEngine engine,
                                  Object appContext,
                                  List<Base> focus,
                                  String functionName,
                                  List<List<Base>> parameters)

Specified by:

executeFunction in interface FHIRPathEngine.IEvaluationContext

Returns:

resolveReference

public Base resolveReference(FHIRPathEngine engine,
                             Object appContext,
                             String url,
                             Base base)
                      throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: FHIRPathEngine.IEvaluationContext

Implementation of resolve() function. Passed a string, return matching resource, if one is known - else null

Specified by:

resolveReference in interface FHIRPathEngine.IEvaluationContext

url - the reference (Reference.reference or the value of the canonical

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

conformsToProfile

public boolean conformsToProfile(FHIRPathEngine engine,
                                 Object appContext,
                                 Base item,
                                 String url)
                          throws org.hl7.fhir.exceptions.FHIRException

Specified by:

conformsToProfile in interface FHIRPathEngine.IEvaluationContext

Throws:

org.hl7.fhir.exceptions.FHIRException

resolveValueSet

public ValueSet resolveValueSet(FHIRPathEngine engine,
                                Object appContext,
                                String url)

Specified by:

resolveValueSet in interface FHIRPathEngine.IEvaluationContext