Package org.hl7.fhir.r5.liquid

Class LiquidEngine

java.lang.Object

org.hl7.fhir.r5.liquid.LiquidEngine

All Implemented Interfaces:

IHostApplicationServices

public class LiquidEngine
extends Object
implements IHostApplicationServices

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LiquidEngine.ILiquidEngineIncludeResolver
static interface	LiquidEngine.ILiquidRenderingSupport
static class	LiquidEngine.LiquidDocument
static class	LiquidEngine.LiquidForLoopObject

Constructor Summary

Constructors

Constructor	Description
LiquidEngine(IWorkerContext context, IHostApplicationServices 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, Base resource, Object appContext)
List<Base>	executeFunction(FHIRPathEngine engine, Object appContext, List<Base> focus, String functionName, List<List<Base>> parameters)
FHIRPathEngine	getEngine()
LiquidEngine.ILiquidEngineIncludeResolver	getIncludeResolver()
LiquidEngine.ILiquidRenderingSupport	getRenderingSupport()
Map<String,Base>	getVars()
boolean	log(String argument, List<Base> focus)	when the .log() function is called
boolean	paramIsType(String name, int index)	For the moment, there can only be one parameter if it's a type parameter
LiquidEngine.LiquidDocument	parse(String source, String sourceName)
boolean	replaceInHtml(org.hl7.fhir.utilities.xhtml.XhtmlNode node, Map<String,String> vars)	Lightweight method to replace fixed constants in resources
List<Base>	resolveConstant(FHIRPathEngine engine, Object appContext, String name, org.hl7.fhir.utilities.fhirpath.FHIRPathConstantEvaluationMode mode)	A constant reference - e.g. a reference to a name that must be resolved in context.
TypeDetails	resolveConstantType(FHIRPathEngine engine, Object appContext, String name, org.hl7.fhir.utilities.fhirpath.FHIRPathConstantEvaluationMode mode)	Compile time support for a constant reference - e.g. a reference to a name that must be resolved in context.
FHIRPathUtilityClasses.FunctionDetails	resolveFunction(FHIRPathEngine engine, String functionName)
Base	resolveReference(FHIRPathEngine engine, Object appContext, String url, Base refContext)	Implementation of resolve() function.
ValueSet	resolveValueSet(FHIRPathEngine engine, Object appContext, String url)
void	setIncludeResolver(LiquidEngine.ILiquidEngineIncludeResolver includeResolver)
void	setRenderingSupport(LiquidEngine.ILiquidRenderingSupport renderingSupport)

Methods inherited from class java.lang.Object

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

Constructor Details

LiquidEngine

public LiquidEngine(IWorkerContext context,
 IHostApplicationServices hostServices)

Method Details

getIncludeResolver

public LiquidEngine.ILiquidEngineIncludeResolver getIncludeResolver()

setIncludeResolver

public void setIncludeResolver(LiquidEngine.ILiquidEngineIncludeResolver includeResolver)

getRenderingSupport

public LiquidEngine.ILiquidRenderingSupport getRenderingSupport()

setRenderingSupport

public void setRenderingSupport(LiquidEngine.ILiquidRenderingSupport renderingSupport)

getVars

public Map<String,Base> getVars()

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,
 Base 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,
 org.hl7.fhir.utilities.fhirpath.FHIRPathConstantEvaluationMode mode)
                           throws org.hl7.fhir.exceptions.PathEngineException

Description copied from interface: IHostApplicationServices

A constant reference - e.g. a reference to a name that must be resolved in context. resolveConstant is invoked under 3 different circumstances, which are reflected in the mode parameter: * an explicit constant of the form %{token}, where the token isn't a known internal constant * every evaluation of any expression to allow the Host Application to decide whether to interpret the expression as a constant even if it is not explicitly a constant * at the start of evaluating an expression if the focus provided by the application when invoking the expression is {} The return value is a List - a collection, though most constants are singleton values note that variables created using defineVariable() in the FHIRPath expressions will not be processed by resolveConstant (or resolveConstantType)

Specified by:

resolveConstant in interface IHostApplicationServices

Parameters:

appContext - - application context passed into the FHIRPath engine when first executed

name - - name reference to resolve. if mode = EXPLICIT, the % will NOT be in the name

mode - - what situation the reference comes from - see the documentation for @FHIRPathConstantEvaluationMode

Returns:

the value of the constant , or an empty list, though the host application can choose to throw an exception

Throws:

org.hl7.fhir.exceptions.PathEngineException

resolveConstantType

public TypeDetails resolveConstantType(FHIRPathEngine engine,
 Object appContext,
 String name,
 org.hl7.fhir.utilities.fhirpath.FHIRPathConstantEvaluationMode mode)
                                throws org.hl7.fhir.exceptions.PathEngineException

Description copied from interface: IHostApplicationServices

Compile time support for a constant reference - e.g. a reference to a name that must be resolved in context. resolveConstant is invoked under 3 different circumstances, which are reflected in the mode parameter: * an explicit constant of the form %{token}, where the token isn't a known internal constant * every evaluation of any expression to allow the Host Application to decide whether to interpret the expression as a constant even if it is not explicitly a constant * at the start of evaluating an expression if the focus provided by the application when invoking the expression is {} The return value is a TypeDetails - a collection, though most constants are singleton values note that variables created using defineVariable() in the FHIRPath expressions will not be processed by resolveConstant (or resolveConstantType)

Specified by:

resolveConstantType in interface IHostApplicationServices

Parameters:

appContext - - application context passed into the FHIRPath engine when first executed

name - - name reference to resolve. if mode = EXPLICIT, the % will NOT be in the name

mode - - what situation the reference comes from - see the documentation for @FHIRPathConstantEvaluationMode

Returns:

the type of the constant, or null, though the host application can choose to throw an exception

Throws:

org.hl7.fhir.exceptions.PathEngineException

log

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

Description copied from interface: IHostApplicationServices

when the .log() function is called

Specified by:

log in interface IHostApplicationServices

Parameters:

argument -

focus -

Returns:

resolveFunction

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

Specified by:

resolveFunction in interface IHostApplicationServices

Parameters:

functionName -

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: IHostApplicationServices

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

Specified by:

checkFunction in interface IHostApplicationServices

Parameters:

functionName -

parameters -

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 IHostApplicationServices

Parameters:

appContext -

functionName -

parameters -

Returns:

resolveReference

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

Description copied from interface: IHostApplicationServices

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

Specified by:

resolveReference in interface IHostApplicationServices

Parameters:

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 IHostApplicationServices

Throws:

org.hl7.fhir.exceptions.FHIRException

resolveValueSet

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

Specified by:

resolveValueSet in interface IHostApplicationServices

replaceInHtml

public boolean replaceInHtml(org.hl7.fhir.utilities.xhtml.XhtmlNode node,
 Map<String,String> vars)

Lightweight method to replace fixed constants in resources

Parameters:

node -

vars -

Returns:

paramIsType

public boolean paramIsType(String name,
 int index)

Description copied from interface: IHostApplicationServices

For the moment, there can only be one parameter if it's a type parameter

Specified by:

paramIsType in interface IHostApplicationServices

Parameters:

name -

Returns:

true if it's a type parameter

getEngine

public FHIRPathEngine getEngine()