Package org.hl7.fhir.r5.context

Class SimpleWorkerContext

java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.r5.context.BaseWorkerContext

org.hl7.fhir.r5.context.SimpleWorkerContext

All Implemented Interfaces:

ProfileUtilities.ProfileKnowledgeProvider, IWorkerContext

public class SimpleWorkerContext
extends BaseWorkerContext
implements IWorkerContext, ProfileUtilities.ProfileKnowledgeProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimpleWorkerContext.ILoadFilter
static interface	SimpleWorkerContext.IValidatorFactory
static class	SimpleWorkerContext.PackageResourceLoader
static class	SimpleWorkerContext.SimpleWorkerContextBuilder

Nested classes/interfaces inherited from class org.hl7.fhir.r5.context.BaseWorkerContext

BaseWorkerContext.MetadataResourceVersionComparator<T extends CanonicalResource>, BaseWorkerContext.NullTranslator, BaseWorkerContext.ResourceProxy

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

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.conformance.ProfileUtilities.ProfileKnowledgeProvider

ProfileUtilities.ProfileKnowledgeProvider.BindingResolution

Field Summary

Fields inherited from class org.hl7.fhir.r5.context.BaseWorkerContext

binaries, clock, expParameters, logger, name, noTerminologyServer, oidCache, transforms, tsServer, txCache, txClient, txLog, userAgent, validationCache, version

Method Summary

Modifier and Type	Method	Description
List<StructureDefinition>	allStructures()
void	cachePackage(IWorkerContext.PackageDetails packageDetails, List<IWorkerContext.PackageVersion> dependencies)	Inform the cache about package dependencies.
void	cachePackage(IWorkerContext.PackageVersion packageDetails, List<IWorkerContext.PackageVersion> dependencies)
String	connectToTSServer(TerminologyClient client, String log)
protected void	copy(SimpleWorkerContext other)
static String[]	defaultTypesToLoad()
StructureDefinition	fetchRawProfile(String uri)
<T extends Resource> T	fetchResource(Class<T> class_, String uri)	Find an identified resource.
List<StructureMap>	findTransformsforSource(String url)
void	generateSnapshot(StructureDefinition p)	Given a structure definition, generate a snapshot (or regenerate it)
void	generateSnapshot(StructureDefinition p, boolean logical)
String	getAbbreviation(String name)	returns the recommended tla for the type (from the structure definitions)
String	getLinkFor(String corePath, String typeSimple)
String	getLinkForProfile(StructureDefinition profile, String url)
List<String>	getLoadedPackages()
IWorkerContext.PackageDetails	getPackage(IWorkerContext.PackageVersion pack)
IParser	getParser(String type)	Get a parser to read/write instances.
IParser	getParser(ParserType type)	Get a parser to read/write instances.
Questionnaire	getQuestionnaire()
List<String>	getResourceNames()
List<String>	getTypeNames()
SimpleWorkerContext.IValidatorFactory	getValidatorFactory()
String	getVersion()	Get the versions of the definitions loaded in context
XVerExtensionManager	getXVer()
boolean	hasCache()
boolean	hasLinkFor(String typeSimple)
boolean	hasPackage(String idAndver)
boolean	hasPackage(String id, String ver)
boolean	hasPackage(IWorkerContext.PackageVersion pack)
boolean	isCanNoTS()
boolean	isDatatype(String typeSimple)
boolean	isIgnoreProfileErrors()
boolean	isProgress()
boolean	isResource(String t)
String	listMapUrls()
void	loadBinariesFromFolder(String folder)
void	loadBinariesFromFolder(org.hl7.fhir.utilities.npm.NpmPackage pi)
void	loadFromFile(InputStream stream, String name, IWorkerContext.IContextResourceLoader loader)
void	loadFromFile(InputStream stream, String name, IWorkerContext.IContextResourceLoader loader, SimpleWorkerContext.ILoadFilter filter)
void	loadFromFile(String file, IWorkerContext.IContextResourceLoader loader)
void	loadFromFolder(String folder)
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)
int	loadFromPackageAndDependenciesInt(org.hl7.fhir.utilities.npm.NpmPackage pi, IWorkerContext.IContextResourceLoader loader, org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm, String path)
int	loadFromPackageInt(org.hl7.fhir.utilities.npm.NpmPackage pi, IWorkerContext.IContextResourceLoader loader, String... types)
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
boolean	prependLinks()
ProfileUtilities.ProfileKnowledgeProvider.BindingResolution	resolveBinding(StructureDefinition profile, String url, String path)
ProfileUtilities.ProfileKnowledgeProvider.BindingResolution	resolveBinding(StructureDefinition profile, ElementDefinition.ElementDefinitionBindingComponent binding, String path)
void	setCanNoTS(boolean canNoTS)
void	setClock(org.hl7.fhir.utilities.TimeTracker tt)
void	setIgnoreProfileErrors(boolean ignoreProfileErrors)
void	setProgress(boolean progress)
void	setQuestionnaire(Questionnaire questionnaire)
void	setValidatorFactory(SimpleWorkerContext.IValidatorFactory validatorFactory)

Methods inherited from class org.hl7.fhir.r5.context.BaseWorkerContext

allConformanceResources, allImplementationGuides, cacheResource, cacheResourceFromPackage, cacheVS, clearTS, clearTSCache, clock, constructParameters, constructParameters, constructParameters, constructParameters, constructValueSetCheckerSimple, constructValueSetCheckerSimple, constructValueSetExpanderSimple, copy, countAllCaches, dropResource, dropResource, expandVS, expandVS, expandVS, expandVS, expandVS, fetchCodeSystem, fetchCodeSystem, fetchResource, fetchResource, fetchResourceById, fetchResourceWithException, fetchResourceWithException, fetchResourceWithException, fetchResourceWithException, fetchResourceWithException, fetchTypeDefinition, findMapsForSource, finishLoading, fixOldSD, getBinaries, getCacheId, getClientRetryCount, getCodeSystemsUsed, getExpandCodesLimit, getExpansionParameters, getLinkForUrl, getLocator, getLogger, getName, getOverrideVersionNs, getPackageForUrl, getResourceNamesAsSet, getSearchParameter, getSpecUrl, getStructure, getStructures, getTransform, getTxCaps, getTxClient, getUcumService, getUserAgent, hasResource, hasResource, initTS, isAllowLoadingDuplicates, isCanRunWithoutTerminology, isNoTerminologyServer, isTlogging, listMaps, listStructures, listSupportedSystems, listTransforms, oid2Uri, processValidationResult, registerResourceFromPackage, reportStatus, seeMetadataResource, setAllowLoadingDuplicates, setCacheId, setCanRunWithoutTerminology, setClientRetryCount, setExpandCodesLimit, setExpansionProfile, setLocator, setLogger, setName, setNoTerminologyServer, setOverrideVersionNs, setTlogging, setTranslator, setTxCaps, setUcumService, setUserAgent, supportsSystem, tail, tlog, totalCount, translator, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCodeBatch, validateOnServer

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

formatMessage, getLocale, isWarnAboutMissingMessages, setLocale, 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

allConformanceResources, cacheResource, cacheResourceFromPackage, clock, expandVS, expandVS, expandVS, expandVS, fetchCodeSystem, fetchCodeSystem, fetchResource, fetchResource, fetchResourceById, fetchResourceWithException, fetchTypeDefinition, findMapsForSource, formatMessage, getBinaries, getClientRetryCount, getCodeSystemsUsed, getExpansionParameters, getLinkForUrl, getLocale, getLogger, getOverrideVersionNs, getPackageForUrl, getResourceNamesAsSet, getSpecUrl, getStructures, getTransform, getUcumService, hasResource, isNoTerminologyServer, listTransforms, oid2Uri, setClientRetryCount, setExpansionProfile, setLocale, setLogger, setOverrideVersionNs, setUcumService, setValidationMessageLanguage, supportsSystem, translator, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCodeBatch

Methods inherited from interface org.hl7.fhir.r5.conformance.ProfileUtilities.ProfileKnowledgeProvider

getLinkForUrl

Method Details

copy

protected void copy(SimpleWorkerContext other)

getLoadedPackages

public List<String> getLoadedPackages()

connectToTSServer

public String connectToTSServer(TerminologyClient client,
 String log)

loadFromFile

public void loadFromFile(InputStream stream,
 String name,
 IWorkerContext.IContextResourceLoader loader)
                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

loadFromFile

public void loadFromFile(InputStream stream,
 String name,
 IWorkerContext.IContextResourceLoader loader,
 SimpleWorkerContext.ILoadFilter filter)
                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

loadFromPackage

public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi,
 IWorkerContext.IContextResourceLoader loader)
                    throws IOException,
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:

IOException

org.hl7.fhir.exceptions.FHIRException

defaultTypesToLoad

public static String[] defaultTypesToLoad()

loadFromPackage

public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi,
 IWorkerContext.IContextResourceLoader loader,
 String[] types)
                    throws IOException,
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:

IOException

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 IOException,
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:

IOException

org.hl7.fhir.exceptions.FHIRException

loadFromPackageAndDependenciesInt

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

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

loadFromPackageInt

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

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

loadFromFile

public void loadFromFile(String file,
 IWorkerContext.IContextResourceLoader loader)
                  throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

getParser

public IParser getParser(ParserType type)

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

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:

newJsonParser

public IParser newJsonParser()

Description copied from interface: IWorkerContext

Get a JSON parser

Specified by:

newJsonParser in interface IWorkerContext

Returns:

newXmlParser

public IParser newXmlParser()

Description copied from interface: IWorkerContext

Get an XML parser

Specified by:

newXmlParser in interface IWorkerContext

Returns:

newValidator

public IResourceValidator newValidator()
                                throws org.hl7.fhir.exceptions.FHIRException

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

Throws:

org.hl7.fhir.exceptions.FHIRException

getResourceNames

public List<String> getResourceNames()

Specified by:

getResourceNames in interface IWorkerContext

Returns:

a list of the resource names defined for this version

getTypeNames

public List<String> getTypeNames()

Specified by:

getTypeNames in interface IWorkerContext

Returns:

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

getAbbreviation

public String getAbbreviation(String name)

Description copied from interface: IWorkerContext

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

Specified by:

getAbbreviation in interface IWorkerContext

Returns:

isDatatype

public boolean isDatatype(String typeSimple)

Specified by:

isDatatype in interface ProfileUtilities.ProfileKnowledgeProvider

isResource

public boolean isResource(String t)

Specified by:

isResource in interface ProfileUtilities.ProfileKnowledgeProvider

hasLinkFor

public boolean hasLinkFor(String typeSimple)

Specified by:

hasLinkFor in interface ProfileUtilities.ProfileKnowledgeProvider

getLinkFor

public String getLinkFor(String corePath,
 String typeSimple)

Specified by:

getLinkFor in interface ProfileUtilities.ProfileKnowledgeProvider

resolveBinding

public ProfileUtilities.ProfileKnowledgeProvider.BindingResolution resolveBinding(StructureDefinition profile,
 ElementDefinition.ElementDefinitionBindingComponent binding,
 String path)

Specified by:

resolveBinding in interface ProfileUtilities.ProfileKnowledgeProvider

resolveBinding

public ProfileUtilities.ProfileKnowledgeProvider.BindingResolution resolveBinding(StructureDefinition profile,
 String url,
 String path)

Specified by:

resolveBinding in interface ProfileUtilities.ProfileKnowledgeProvider

getLinkForProfile

public String getLinkForProfile(StructureDefinition profile,
 String url)

Specified by:

getLinkForProfile in interface ProfileUtilities.ProfileKnowledgeProvider

getQuestionnaire

public Questionnaire getQuestionnaire()

setQuestionnaire

public void setQuestionnaire(Questionnaire questionnaire)

allStructures

public List<StructureDefinition> allStructures()

Specified by:

allStructures in interface IWorkerContext

Returns:

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

loadBinariesFromFolder

public void loadBinariesFromFolder(String folder)
                            throws IOException

Throws:

IOException

loadBinariesFromFolder

public void loadBinariesFromFolder(org.hl7.fhir.utilities.npm.NpmPackage pi)
                            throws IOException

Throws:

IOException

loadFromFolder

public void loadFromFolder(String folder)
                    throws IOException

Throws:

IOException

prependLinks

public boolean prependLinks()

Specified by:

prependLinks in interface ProfileUtilities.ProfileKnowledgeProvider

hasCache

public boolean hasCache()

Specified by:

hasCache in interface IWorkerContext

Returns:

true if the contxt has a terminology caching service internally

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:

findTransformsforSource

public List<StructureMap> findTransformsforSource(String url)

getValidatorFactory

public SimpleWorkerContext.IValidatorFactory getValidatorFactory()

setValidatorFactory

public void setValidatorFactory(SimpleWorkerContext.IValidatorFactory validatorFactory)

fetchResource

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

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

Overrides:

fetchResource in class BaseWorkerContext

Returns:

fetchRawProfile

public StructureDefinition fetchRawProfile(String uri)

Specified by:

fetchRawProfile in interface IWorkerContext

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 p,
 boolean logical)
                      throws org.hl7.fhir.exceptions.FHIRException

Specified by:

generateSnapshot in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.FHIRException

isIgnoreProfileErrors

public boolean isIgnoreProfileErrors()

setIgnoreProfileErrors

public void setIgnoreProfileErrors(boolean ignoreProfileErrors)

listMapUrls

public String listMapUrls()

isProgress

public boolean isProgress()

setProgress

public void setProgress(boolean progress)

setClock

public void setClock(org.hl7.fhir.utilities.TimeTracker tt)

isCanNoTS

public boolean isCanNoTS()

setCanNoTS

public void setCanNoTS(boolean canNoTS)

getXVer

public XVerExtensionManager getXVer()

cachePackage

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

hasPackage

public boolean hasPackage(String id,
 String ver)

Specified by:

hasPackage in interface IWorkerContext

hasPackage

public boolean hasPackage(String idAndver)

cachePackage

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

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

hasPackage

public boolean hasPackage(IWorkerContext.PackageVersion pack)

Specified by:

hasPackage in interface IWorkerContext

getPackage

public IWorkerContext.PackageDetails getPackage(IWorkerContext.PackageVersion pack)

Specified by:

getPackage in interface IWorkerContext