Package org.hl7.fhir.r5.hapi.ctx

Class HapiWorkerContext

java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.r5.hapi.ctx.HapiWorkerContext

All Implemented Interfaces:

IWorkerContext

public final class HapiWorkerContext
extends org.hl7.fhir.utilities.i18n.I18nBase
implements IWorkerContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.context.IWorkerContext

IWorkerContext.CodingValidationRequest, IWorkerContext.ICanonicalResourceLocator, IWorkerContext.IContextResourceLoader, IWorkerContext.ILoggingService, IWorkerContext.PackageDetails, IWorkerContext.PackageVersion, IWorkerContext.ValidationResult

Constructor Summary

Constructors

Constructor	Description
HapiWorkerContext(ca.uhn.fhir.context.FhirContext theCtx, ca.uhn.fhir.context.support.IValidationSupport theValidationSupport)

Method Summary

Modifier and Type	Method	Description
List<CanonicalResource>	allConformanceResources()
List<StructureDefinition>	allStructures()
void	cachePackage(IWorkerContext.PackageDetails packageDetails, List<IWorkerContext.PackageVersion> list)	Inform the cache about package dependencies.
void	cacheResource(Resource theRes)	cache a resource for later retrieval using fetchResource.
void	cacheResourceFromPackage(Resource res, IWorkerContext.PackageVersion packageDetails)	cache a resource for later retrieval using fetchResource.
org.hl7.fhir.utilities.TimeTracker	clock()
static ca.uhn.fhir.context.support.ConceptValidationOptions	convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ElementDefinition.ElementDefinitionBindingComponent theBinding, boolean theCacheOk, boolean theHierarchical)	ValueSet Expansion - see $expand, but resolves the binding first
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ValueSet.ConceptSetComponent theInc, boolean theHierarchical, boolean theNoInactive)	Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ValueSet theSource, boolean theCacheOk, boolean theHierarchical)	ValueSet Expansion - see $expand
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ValueSet theValueSet, boolean cacheOk, boolean heiarchical, boolean incompleteOk)	ValueSet Expansion - see $expand
CodeSystem	fetchCodeSystem(String theSystem)	Find the code system definition for the nominated system uri.
CodeSystem	fetchCodeSystem(String theSystem, String version)
StructureDefinition	fetchRawProfile(String url)
<T extends Resource> T	fetchResource(Class<T> theClass, String theUri)	Find an identified resource.
<T extends Resource> T	fetchResource(Class<T> theClass, String theUri, String theVersion)
<T extends Resource> T	fetchResource(Class<T> class_, String uri, CanonicalResource canonicalForSource)	has the same functionality as fetchResource, but passes in information about the source of the reference (this may affect resolution of version)
Resource	fetchResourceById(String theType, String theUri)	Variation of fetchResource when you have a string type, and don't need the right class The URI can have one of 3 formats: - a full URL e.g.
<T extends Resource> T	fetchResourceWithException(Class<T> theClass, String theUri)
StructureDefinition	fetchTypeDefinition(String typeName)
List<ConceptMap>	findMapsForSource(String theUrl)	find concept maps for a source
void	generateSnapshot(StructureDefinition p)	Given a structure definition, generate a snapshot (or regenerate it)
void	generateSnapshot(StructureDefinition mr, boolean ifLogical)
String	getAbbreviation(String theName)	returns the recommended tla for the type (from the structure definitions)
Map<String,byte[]>	getBinaries()
int	getClientRetryCount()
Set<String>	getCodeSystemsUsed()
Parameters	getExpansionParameters()	Set the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode
String	getLinkForUrl(String corePath, String url)
Locale	getLocale()
IWorkerContext.ILoggingService	getLogger()
String	getOverrideVersionNs()
IWorkerContext.PackageDetails	getPackage(IWorkerContext.PackageVersion packageVersion)
IWorkerContext.PackageVersion	getPackageForUrl(String s)
IParser	getParser(String theType)	Get a parser to read/write instances.
IParser	getParser(ParserType theType)	Get a parser to read/write instances.
List<String>	getResourceNames()
Set<String>	getResourceNamesAsSet()
String	getSpecUrl()	return the link to the base of the specification for the loaded version e.g.
List<StructureDefinition>	getStructures()
StructureMap	getTransform(String url)
List<String>	getTypeNames()
org.fhir.ucum.UcumService	getUcumService()
String	getVersion()	Get the versions of the definitions loaded in context
boolean	hasCache()
boolean	hasPackage(String id, String ver)
boolean	hasPackage(IWorkerContext.PackageVersion packageVersion)
<T extends Resource> boolean	hasResource(Class<T> theClass_, String theUri)	find whether a resource is available.
boolean	isNoTerminologyServer()
List<StructureMap>	listTransforms()
int	loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IWorkerContext.IContextResourceLoader loader)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource
int	loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IWorkerContext.IContextResourceLoader loader, String[] types)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource Deprecated - use the simpler method where the types come from the loader.
int	loadFromPackageAndDependencies(org.hl7.fhir.utilities.npm.NpmPackage pi, IWorkerContext.IContextResourceLoader loader, org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource This method also loads all the packages that the package depends on (recursively)
IParser	newJsonParser()	Get a JSON parser
IResourceValidator	newValidator()	Get a validator that can check whether a resource is valid
IParser	newXmlParser()	Get an XML parser
String	oid2Uri(String theCode)	translate an OID to a URI (look through known NamingSystems)
IWorkerContext	setClientRetryCount(int value)
void	setExpansionProfile(Parameters theExpParameters)	Get the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode
void	setLocale(Locale locale)
void	setLogger(IWorkerContext.ILoggingService theLogger)
void	setOverrideVersionNs(String value)
void	setUcumService(org.fhir.ucum.UcumService ucumService)
boolean	supportsSystem(String theSystem)	True if the underlying terminology service provider will do expansion and code validation for the terminology.
org.hl7.fhir.utilities.TranslationServices	translator()
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theVersion, String theCode, String theDisplay)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theVersion, String theCode, String theDisplay, ValueSet theVs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String code, ValueSet vs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, CodeableConcept theCode, ValueSet theVs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, Coding theCode, ValueSet theVs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, Coding code, ValueSet vs, ValidationContextCarrier ctxt)
void	validateCodeBatch(org.hl7.fhir.utilities.validation.ValidationOptions options, List<? extends IWorkerContext.CodingValidationRequest> codes, ValueSet vs)

Methods inherited from class org.hl7.fhir.utilities.i18n.I18nBase

formatMessage, isWarnAboutMissingMessages, setValidationMessageLanguage, setWarnAboutMissingMessages

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.r5.context.IWorkerContext

formatMessage, setValidationMessageLanguage

Constructor Details

HapiWorkerContext

public HapiWorkerContext(ca.uhn.fhir.context.FhirContext theCtx,
 ca.uhn.fhir.context.support.IValidationSupport theValidationSupport)

Method Details

allStructures

public List<StructureDefinition> allStructures()

Specified by:

allStructures in interface IWorkerContext

Returns:

a list of all structure definitions, with snapshots generated (if possible)

getStructures

public List<StructureDefinition> getStructures()

Specified by:

getStructures in interface IWorkerContext

Returns:

a list of all structure definitions, without trying to generate snapshots

fetchCodeSystem

public CodeSystem fetchCodeSystem(String theSystem)

Description copied from interface: IWorkerContext

Find the code system definition for the nominated system uri. return null if there isn't one (then the tool might try supportsSystem)

Specified by:

fetchCodeSystem in interface IWorkerContext

Returns:

fetchCodeSystem

public CodeSystem fetchCodeSystem(String theSystem,
 String version)

Specified by:

fetchCodeSystem in interface IWorkerContext

findMapsForSource

public List<ConceptMap> findMapsForSource(String theUrl)

Description copied from interface: IWorkerContext

find concept maps for a source

Specified by:

findMapsForSource in interface IWorkerContext

Returns:

getAbbreviation

public String getAbbreviation(String theName)

Description copied from interface: IWorkerContext

returns the recommended tla for the type (from the structure definitions)

Specified by:

getAbbreviation in interface IWorkerContext

Returns:

getParser

public IParser getParser(ParserType theType)

Description copied from interface: IWorkerContext

Get a parser to read/write instances. Use the defined type (will be extended as further types are added, though the only currently anticipate type is RDF) XML/JSON - the standard renderers XHTML - render the narrative only (generate it if necessary)

Specified by:

getParser in interface IWorkerContext

Returns:

getParser

public IParser getParser(String theType)

Description copied from interface: IWorkerContext

Get a parser to read/write instances. Determine the type from the stated type. Supported value for type: - the recommended MIME types - variants of application/xml and application/json - _format values xml, json

Specified by:

getParser in interface IWorkerContext

Returns:

getResourceNames

public List<String> getResourceNames()

Specified by:

getResourceNames in interface IWorkerContext

Returns:

a list of the resource names defined for this version

newJsonParser

public IParser newJsonParser()

Description copied from interface: IWorkerContext

Get a JSON parser

Specified by:

newJsonParser in interface IWorkerContext

Returns:

newValidator

public IResourceValidator newValidator()

Description copied from interface: IWorkerContext

Get a validator that can check whether a resource is valid

Specified by:

newValidator in interface IWorkerContext

Returns:

a prepared generator

newXmlParser

public IParser newXmlParser()

Description copied from interface: IWorkerContext

Get an XML parser

Specified by:

newXmlParser in interface IWorkerContext

Returns:

oid2Uri

public String oid2Uri(String theCode)

Description copied from interface: IWorkerContext

translate an OID to a URI (look through known NamingSystems)

Specified by:

oid2Uri in interface IWorkerContext

Returns:

supportsSystem

public boolean supportsSystem(String theSystem)

Description copied from interface: IWorkerContext

True if the underlying terminology service provider will do expansion and code validation for the terminology. Corresponds to the extension http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system in the Conformance resource

Specified by:

supportsSystem in interface IWorkerContext

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
 CodeableConcept theCode,
 ValueSet theVs)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup Note that this doesn't validate binding strength (e.g. is just text allowed?)

Specified by:

validateCode in interface IWorkerContext

Parameters:

theOptions - - validation options (required)

theCode - - CodeableConcept to validate

theVs - the applicable valueset (optional)

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
 Coding theCode,
 ValueSet theVs)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup in this case, the system will be inferred from the value set. It's an error to call this one without the value set

Specified by:

validateCode in interface IWorkerContext

Parameters:

theOptions - - validation options (required)

theCode - - Coding to validate

theVs - the applicable valueset (optional)

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 Coding code,
 ValueSet vs,
 ValidationContextCarrier ctxt)

Specified by:

validateCode in interface IWorkerContext

validateCodeBatch

public void validateCodeBatch(org.hl7.fhir.utilities.validation.ValidationOptions options,
 List<? extends IWorkerContext.CodingValidationRequest> codes,
 ValueSet vs)

Specified by:

validateCodeBatch in interface IWorkerContext

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet theValueSet,
 boolean cacheOk,
 boolean heiarchical,
 boolean incompleteOk)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand

Specified by:

expandVS in interface IWorkerContext

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
 String theSystem,
 String theVersion,
 String theCode,
 String theDisplay)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Parameters:

theOptions - - validation options (required)

theSystem - - equals Coding.system (required)

theCode - - equals Coding.code (required)

theDisplay - - equals Coding.display (optional)

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
 String theSystem,
 String theVersion,
 String theCode,
 String theDisplay,
 ValueSet theVs)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Parameters:

theOptions - - validation options (required)

theSystem - - equals Coding.system (required)

theCode - - equals Coding.code (required)

theDisplay - - equals Coding.display (optional)

theVs - the applicable valueset (optional)

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
 String code,
 ValueSet vs)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup in this case, the system will be inferred from the value set. It's an error to call this one without the value set

Specified by:

validateCode in interface IWorkerContext

Parameters:

theOptions - - validation options (required)

code - he code to validate (required)

vs - the applicable valueset (required)

Returns:

allConformanceResources

public List<CanonicalResource> allConformanceResources()

Specified by:

allConformanceResources in interface IWorkerContext

Returns:

a list of all conformance resources

generateSnapshot

public void generateSnapshot(StructureDefinition p)
                      throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

Given a structure definition, generate a snapshot (or regenerate it)

Specified by:

generateSnapshot in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.DefinitionException

org.hl7.fhir.exceptions.FHIRException

generateSnapshot

public void generateSnapshot(StructureDefinition mr,
 boolean ifLogical)

Specified by:

generateSnapshot in interface IWorkerContext

getExpansionParameters

public Parameters getExpansionParameters()

Description copied from interface: IWorkerContext

Set the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode

Specified by:

getExpansionParameters in interface IWorkerContext

setExpansionProfile

public void setExpansionProfile(Parameters theExpParameters)

Description copied from interface: IWorkerContext

Get the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode

Specified by:

setExpansionProfile in interface IWorkerContext

hasCache

public boolean hasCache()

Specified by:

hasCache in interface IWorkerContext

Returns:

true if the contxt has a terminology caching service internally

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet theSource,
 boolean theCacheOk,
 boolean theHierarchical)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand

Specified by:

expandVS in interface IWorkerContext

Returns:

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet.ConceptSetComponent theInc,
 boolean theHierarchical,
 boolean theNoInactive)
                                                   throws org.hl7.fhir.exceptions.TerminologyServiceException

Description copied from interface: IWorkerContext

Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.

Specified by:

expandVS in interface IWorkerContext

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IWorkerContext

Overrides:

getLocale in class org.hl7.fhir.utilities.i18n.I18nBase

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface IWorkerContext

Overrides:

setLocale in class org.hl7.fhir.utilities.i18n.I18nBase

getLogger

public IWorkerContext.ILoggingService getLogger()

Specified by:

getLogger in interface IWorkerContext

setLogger

public void setLogger(IWorkerContext.ILoggingService theLogger)

Specified by:

setLogger in interface IWorkerContext

getVersion

public String getVersion()

Description copied from interface: IWorkerContext

Get the versions of the definitions loaded in context

Specified by:

getVersion in interface IWorkerContext

Returns:

getSpecUrl

public String getSpecUrl()

Description copied from interface: IWorkerContext

return the link to the base of the specification for the loaded version e.g. http://hl7.org/fhir/R4

Specified by:

getSpecUrl in interface IWorkerContext

getUcumService

public org.fhir.ucum.UcumService getUcumService()

Specified by:

getUcumService in interface IWorkerContext

setUcumService

public void setUcumService(org.fhir.ucum.UcumService ucumService)

Specified by:

setUcumService in interface IWorkerContext

isNoTerminologyServer

public boolean isNoTerminologyServer()

Specified by:

isNoTerminologyServer in interface IWorkerContext

getCodeSystemsUsed

public Set<String> getCodeSystemsUsed()

Specified by:

getCodeSystemsUsed in interface IWorkerContext

translator

public org.hl7.fhir.utilities.TranslationServices translator()

Specified by:

translator in interface IWorkerContext

listTransforms

public List<StructureMap> listTransforms()

Specified by:

listTransforms in interface IWorkerContext

getTransform

public StructureMap getTransform(String url)

Specified by:

getTransform in interface IWorkerContext

getOverrideVersionNs

public String getOverrideVersionNs()

Specified by:

getOverrideVersionNs in interface IWorkerContext

setOverrideVersionNs

public void setOverrideVersionNs(String value)

Specified by:

setOverrideVersionNs in interface IWorkerContext

fetchTypeDefinition

public StructureDefinition fetchTypeDefinition(String typeName)

Specified by:

fetchTypeDefinition in interface IWorkerContext

fetchRawProfile

public StructureDefinition fetchRawProfile(String url)

Specified by:

fetchRawProfile in interface IWorkerContext

getTypeNames

public List<String> getTypeNames()

Specified by:

getTypeNames in interface IWorkerContext

Returns:

a list of the resource and type names defined for this version

fetchResource

public <T extends Resource> T fetchResource(Class<T> theClass,
 String theUri)

Description copied from interface: IWorkerContext

Find an identified resource. The most common use of this is to access the the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. Also, the narrative generator uses this, and may access any kind of resource The URI is called speculatively for things that might exist, so not finding a matching resouce, return null, not an error The URI can have one of 3 formats: - a full URL e.g. http://acme.org/fhir/ValueSet/[id] - a relative URL e.g. ValueSet/[id] - a logical id e.g. [id] It's an error if the second form doesn't agree with class_. It's an error if class_ is null for the last form

Specified by:

fetchResource in interface IWorkerContext

Returns:

fetchResourceWithException

public <T extends Resource> T fetchResourceWithException(Class<T> theClass,
 String theUri)
                                                  throws org.hl7.fhir.exceptions.FHIRException

Specified by:

fetchResourceWithException in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResource

public <T extends Resource> T fetchResource(Class<T> theClass,
 String theUri,
 String theVersion)

Specified by:

fetchResource in interface IWorkerContext

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri,
 CanonicalResource canonicalForSource)

Description copied from interface: IWorkerContext

has the same functionality as fetchResource, but passes in information about the source of the reference (this may affect resolution of version)

Specified by:

fetchResource in interface IWorkerContext

Returns:

fetchResourceById

public Resource fetchResourceById(String theType,
 String theUri)

Description copied from interface: IWorkerContext

Variation of fetchResource when you have a string type, and don't need the right class The URI can have one of 3 formats: - a full URL e.g. http://acme.org/fhir/ValueSet/[id] - a relative URL e.g. ValueSet/[id] - a logical id e.g. [id] if type == null, the URI can't be a simple logical id

Specified by:

fetchResourceById in interface IWorkerContext

Returns:

hasResource

public <T extends Resource> boolean hasResource(Class<T> theClass_,
 String theUri)

Description copied from interface: IWorkerContext

find whether a resource is available. Implementations of the interface can assume that if hasResource ruturns true, the resource will usually be fetched subsequently

Specified by:

hasResource in interface IWorkerContext

Returns:

cacheResource

public void cacheResource(Resource theRes)
                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

cache a resource for later retrieval using fetchResource. Note that various context implementations will have their own ways of loading rseources, and not all need implement cacheResource. If the resource is loaded out of a package, call cacheResourceFromPackage instead

Specified by:

cacheResource in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.FHIRException

cacheResourceFromPackage

public void cacheResourceFromPackage(Resource res,
 IWorkerContext.PackageVersion packageDetails)
                              throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

cache a resource for later retrieval using fetchResource. The package information is used to help manage the cache internally, and to help with reference resolution. Packages should be define using cachePackage (but don't have to be) Note that various context implementations will have their own ways of loading rseources, and not all need implement cacheResource

Specified by:

cacheResourceFromPackage in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.FHIRException

cachePackage

public void cachePackage(IWorkerContext.PackageDetails packageDetails,
 List<IWorkerContext.PackageVersion> list)

Description copied from interface: IWorkerContext

Inform the cache about package dependencies. This can be used to help resolve references Note that the cache doesn't load dependencies

Specified by:

cachePackage in interface IWorkerContext

getResourceNamesAsSet

public Set<String> getResourceNamesAsSet()

Specified by:

getResourceNamesAsSet in interface IWorkerContext

Returns:

a set of the resource names defined for this version

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ElementDefinition.ElementDefinitionBindingComponent theBinding,
 boolean theCacheOk,
 boolean theHierarchical)
                                                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand, but resolves the binding first

Specified by:

expandVS in interface IWorkerContext

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

getLinkForUrl

public String getLinkForUrl(String corePath,
 String url)

Specified by:

getLinkForUrl in interface IWorkerContext

getBinaries

public Map<String,byte[]> getBinaries()

Specified by:

getBinaries in interface IWorkerContext

loadFromPackage

public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi,
 IWorkerContext.IContextResourceLoader loader)
                    throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource

Specified by:

loadFromPackage in interface IWorkerContext

Parameters:

pi - - the package to load

loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).

Returns:

the number of resources loaded

Throws:

org.hl7.fhir.exceptions.FHIRException

loadFromPackage

public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi,
 IWorkerContext.IContextResourceLoader loader,
 String[] types)
                    throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource Deprecated - use the simpler method where the types come from the loader.

Specified by:

loadFromPackage in interface IWorkerContext

Parameters:

pi - - the package to load

loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).

types - - which types of resources to load

Returns:

the number of resources loaded

Throws:

org.hl7.fhir.exceptions.FHIRException

loadFromPackageAndDependencies

public int loadFromPackageAndDependencies(org.hl7.fhir.utilities.npm.NpmPackage pi,
 IWorkerContext.IContextResourceLoader loader,
 org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm)
                                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource This method also loads all the packages that the package depends on (recursively)

Specified by:

loadFromPackageAndDependencies in interface IWorkerContext

Parameters:

pi - - the package to load

loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).

pcm - - used to find and load additional dependencies

Returns:

the number of resources loaded

Throws:

org.hl7.fhir.exceptions.FHIRException

hasPackage

public boolean hasPackage(String id,
 String ver)

Specified by:

hasPackage in interface IWorkerContext

hasPackage

public boolean hasPackage(IWorkerContext.PackageVersion packageVersion)

Specified by:

hasPackage in interface IWorkerContext

getPackage

public IWorkerContext.PackageDetails getPackage(IWorkerContext.PackageVersion packageVersion)

Specified by:

getPackage in interface IWorkerContext

getClientRetryCount

public int getClientRetryCount()

Specified by:

getClientRetryCount in interface IWorkerContext

setClientRetryCount

public IWorkerContext setClientRetryCount(int value)

Specified by:

setClientRetryCount in interface IWorkerContext

clock

public org.hl7.fhir.utilities.TimeTracker clock()

Specified by:

clock in interface IWorkerContext

getPackageForUrl

public IWorkerContext.PackageVersion getPackageForUrl(String s)

Specified by:

getPackageForUrl in interface IWorkerContext

convertConceptValidationOptions

public static ca.uhn.fhir.context.support.ConceptValidationOptions convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)