Package org.hl7.fhir.r5.utils.sql

Class Runner

java.lang.Object

org.hl7.fhir.r5.utils.sql.Runner

All Implemented Interfaces:

FHIRPathEngine.IEvaluationContext

public class Runner
extends Object
implements FHIRPathEngine.IEvaluationContext

How to use the Runner: create a resource, and fill out: the context (supports the FHIRPathEngine) a store that handles the output a tracker - if you want Once it's created, you either run it as a batch, or in trickle mode (1) Batch Mode * provide a provider * call execute() with a ViewDefinition * wait... (watch with an observer if you want to track progress) (2) Trickle Mode * call 'prepare', and keep the WorkContext that's returned * each time there's a resource to process, call processResource and pass in the workContext and the resource * when done, call finish(WorkContext)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Runner.IRunnerObserver
class	Runner.WorkContext

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.fhirpath.FHIRPathEngine.IEvaluationContext

FHIRPathEngine.IEvaluationContext.FunctionDefinition

Constructor Summary

Constructors

Constructor	Description
Runner()

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)
void	execute(String path, org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)
void	execute(org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)
List<Base>	executeFunction(FHIRPathEngine engine, Object appContext, List<Base> focus, String functionName, List<List<Base>> parameters)
void	finish(Runner.WorkContext wc)
IWorkerContext	getContext()
List<org.hl7.fhir.utilities.validation.ValidationMessage>	getIssues()
List<String>	getProhibitedNames()
Provider	getProvider()
Storage	getStorage()
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
Runner.WorkContext	prepare(String path, org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)
void	processResource(Runner.WorkContext wc, Base b)
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 refContext)	Implementation of resolve() function.
ValueSet	resolveValueSet(FHIRPathEngine engine, Object appContext, String url)
void	setContext(IWorkerContext context)
void	setProvider(Provider provider)
void	setStorage(Storage storage)

Methods inherited from class java.lang.Object

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

Constructor Details

Runner

public Runner()

Method Details

getContext

public IWorkerContext getContext()

setContext

public void setContext(IWorkerContext context)

getProvider

public Provider getProvider()

setProvider

public void setProvider(Provider provider)

getStorage

public Storage getStorage()

setStorage

public void setStorage(Storage storage)

getProhibitedNames

public List<String> getProhibitedNames()

execute

public void execute(org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)

execute

public void execute(String path,
 org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)

prepare

public Runner.WorkContext prepare(String path,
 org.hl7.fhir.utilities.json.model.JsonObject viewDefinition)

processResource

public void processResource(Runner.WorkContext wc,
 Base b)

finish

public void finish(Runner.WorkContext wc)

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 refContext)
                      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

paramIsType

public boolean paramIsType(String name,
 int index)

Description copied from interface: FHIRPathEngine.IEvaluationContext

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

Specified by:

paramIsType in interface FHIRPathEngine.IEvaluationContext

Returns:

true if it's a type parameter

getIssues

public List<org.hl7.fhir.utilities.validation.ValidationMessage> getIssues()