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:

IOIDServices, IWorkerContext, IWorkerContextManager

public class SimpleWorkerContext
extends BaseWorkerContext
implements IWorkerContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimpleWorkerContext.ILoaderFactory
static interface	SimpleWorkerContext.ILoadFilter
class	SimpleWorkerContext.InternalCanonicalResourceProxy
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.BytesFromFileProvider, BaseWorkerContext.BytesFromPackageProvider, BaseWorkerContext.BytesProvider, BaseWorkerContext.IByteProvider, BaseWorkerContext.MetadataResourceVersionComparator<T extends CanonicalResource>, BaseWorkerContext.ResourceProxy

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

IOIDServices.OIDDefinition, IOIDServices.OIDDefinitionComparer, IOIDServices.OIDSummary

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

IWorkerContext.SystemSupportInformation

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

IWorkerContextManager.ICanonicalResourceLocator, IWorkerContextManager.IPackageLoadingTracker

Field Summary

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

binaries, canRunWithoutTerminology, clock, cutils, expansionParameters, logger, name, noTerminologyServer, oidCacheManual, oidSources, packageTracker, terminologyClientManager, transforms, txCache, txLog, userAgent, validationCache, version

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

KEY_DELIMITER, uncontainedKeys

Constructor Summary

Constructors

Constructor	Description
SimpleWorkerContext(SimpleWorkerContext other)

Method Summary

Modifier and Type	Method	Description
void	cachePackage(PackageInformation packageInfo)	Inform the cache about package dependencies.
void	connectToTSServer(TerminologyClientManager.ITerminologyClientFactory factory, String address, String software, String log, boolean useEcosystem)
void	connectToTSServer(TerminologyClientManager.ITerminologyClientFactory factory, ITerminologyClient client, boolean useEcosystem)
protected void	copy(SimpleWorkerContext other)
static Set<String>	defaultTypesToLoad()
<T extends Resource> T	fetchResource(Class<T> class_, String uri)	Fetch (load if necessary) an identified resource.
<T extends Resource> T	fetchResource(Class<T> class_, String uri, String version, Resource source)	Fetch (load if necessary) an identified resource.
<T extends Resource> T	fetchResourceRaw(Class<T> class_, String uri)	Find an identified resource, but do not do any processing on it.
List<StructureMap>	findTransformsforSource(String url)
List<String>	getLoadedPackages()
PackageInformation	getPackage(String id, String ver)
Questionnaire	getQuestionnaire()
List<String>	getResourceNames()
String	getSpecUrl()
SimpleWorkerContext.IValidatorFactory	getValidatorFactory()
String	getVersion()	The version loaded *does not* have to be 5.0 (R5) - the context can load other versions, though the definitions need to be converted to R5 first Note that more than one version might be loaded at once, but one version is always the default / master
XVerExtensionManager	getXVer()
boolean	hasPackage(String idAndver)
boolean	hasPackage(String id, String ver)
boolean	hasPackage(PackageInformation pack)
boolean	isAllowLazyLoading()
boolean	isCanNoTS()
boolean	isProgress()
String	listMapUrls()
void	loadBinariesFromFolder(String folder)
void	loadBinariesFromFolder(org.hl7.fhir.utilities.npm.NpmPackage pi)
String	loadedPackageSummary()
void	loadFromFile(InputStream stream, String name, IContextResourceLoader loader)
Resource	loadFromFile(InputStream stream, String name, IContextResourceLoader loader, SimpleWorkerContext.ILoadFilter filter)
void	loadFromFile(String file, IContextResourceLoader loader)
void	loadFromFolder(String folder)
int	loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage npm, IContextResourceLoader loader)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system may use lazy loading; the loader will be called later when the classes that use the context need the relevant resource
int	loadFromPackageAndDependencies(org.hl7.fhir.utilities.npm.NpmPackage pi, 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, IContextResourceLoader loader, org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm, String path)
int	loadFromPackageInt(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader, Set<String> types)
int	loadPackage(String idAndVer)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system may use lazy loading; the loader will be called later when the classes that use the context need the relevant resource
int	loadPackage(org.hl7.fhir.utilities.npm.NpmPackage npm)	Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system may use lazy loading; the loader will be called later when the classes that use the context need the relevant resource
IResourceValidator	newValidator()	Get a validator that can check whether a resource is valid this is deprecated because there's lots of properties to set on the validator; the functions using this need to be changed to use the validator directly
org.hl7.fhir.utilities.npm.IPackageCacheManager	packageManager()
void	setAllowLazyLoading(boolean allowLazyLoading)
void	setCanNoTS(boolean canNoTS)
void	setClock(org.hl7.fhir.utilities.TimeTracker tt)
void	setPackageManager(org.hl7.fhir.utilities.npm.IPackageCacheManager packageCacheManager)
void	setProgress(boolean progress)
void	setQuestionnaire(Questionnaire questionnaire)
void	setValidatorFactory(SimpleWorkerContext.IValidatorFactory validatorFactory)
void	setXVerManager(XVerExtensionManager value)

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

addDependentCodeSystem, addServerValidationParameters, addServerValidationParameters, allImplementationGuides, cacheResource, cacheResourceFromPackage, cacheVS, clearTSCache, clock, constructParameters, constructParameters, constructParameters, constructParameters, constructValueSetCheckerSimple, constructValueSetCheckerSimple, constructValueSetExpanderSimple, copy, countAllCaches, dropResource, dropResource, expandVS, expandVS, expandVS, expandVS, expandVS, expandVS, expandVS, expandVS, fetchCodeSystem, fetchCodeSystem, fetchCodeSystem, fetchResource, fetchResourceById, fetchResourceById, fetchResourceByVersionWithException, fetchResourcesByType, fetchResourcesByType, fetchResourceVersions, fetchResourceVersionsByTypeAndUrl, fetchResourceWithException, fetchResourceWithException, fetchResourceWithException, fetchResourceWithExceptionByVersion, fetchResourceWithExceptionByVersion, fetchSupplementedCodeSystem, fetchSupplementedCodeSystem, fetchTypeDefinition, fetchTypeDefinition, fetchTypeDefinitions, findTxResource, findTxResource, findTxResource, finishLoading, fixOldSD, getBinaryForKey, getBinaryKeysAsSet, getCacheId, getClientRetryCount, getCodeSystemsUsed, getCutils, getExpandCodesLimit, getExpansionParameters, getLinkForUrl, getLocator, getLogger, getManager, getName, getNSUrlMap, getPackageForUrl, getPackageTracker, getProfiledElementBuilder, getResourceNames, getResourceNamesAsSet, getResourceNamesAsSet, getSearchParameter, getStructure, getSuppressedMappings, getTxClientManager, getTxSupportInfo, getUcumService, getUserAgent, hasBinaryKey, hasResource, hasResource, hasResource, hasResource, hasResourceVersion, hasResourceVersion, hasResourceVersion, initTxCache, initTxCache, isAllowedToIterateTerminologyResources, isCachingAllowed, isCanRunWithoutTerminology, isDataType, isForPublication, isNoTerminologyServer, isPrimitiveType, isTlogging, listCodeSystems, listMaps, listStructures, listSupportedSystems, listValueSets, oidServices, processSubsumesResult, processValidationResult, registerResourceFromPackage, reportStatus, seeMetadataResource, setAllowedToIterateTerminologyResources, setCachingAllowed, setCanRunWithoutTerminology, setClientRetryCount, setExpandCodesLimit, setExpansionParameters, setForPublication, setLocale, setLocator, setLogger, setName, setNoTerminologyServer, setPackageTracker, setSuppressedMappings, setTlogging, setUcumService, setUserAgent, subsumes, tail, totalCount, txCacheReport, txLog, unload, urlsForOid, urlsForOid, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCodeBatch, validateOnServer, validateOnServer2, validateTxResource

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

formatMessage, formatMessagePlural, getLocale, getMessages, getMessagesSourceFileName, getPluralKey, getPluralKeys, getPluralRules, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, logUncontainedMessage, messageKeyExistsForLocale, setValidationMessageLanguage, setWarnAboutMissingMessages, typeOfString

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

clock, expandVS, expandVS, expandVS, expandVS, expandVS, fetchCodeSystem, fetchCodeSystem, fetchResourceById, fetchResourcesByType, fetchResourceVersions, fetchResourceWithException, fetchResourceWithException, fetchSupplementedCodeSystem, fetchSupplementedCodeSystem, fetchTypeDefinition, fetchTypeDefinitions, findTxResource, findTxResource, formatMessage, formatMessagePlural, getBinaryForKey, getBinaryKeysAsSet, getClientRetryCount, getCodeSystemsUsed, getExpansionParameters, getLocale, getLogger, getManager, getNSUrlMap, getPackageForUrl, getPackageTracker, getProfiledElementBuilder, getResourceNamesAsSet, getTxSupportInfo, getUcumService, hasBinaryKey, hasResource, hasResource, isDataType, isForPublication, isNoTerminologyServer, isPrimitiveType, oidServices, setClientRetryCount, setForPublication, setPackageTracker, subsumes, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCodeBatch, validateTxResource

Constructor Details

SimpleWorkerContext

public SimpleWorkerContext(SimpleWorkerContext other)
                    throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

Method Details

copy

protected void copy(SimpleWorkerContext other)

getLoadedPackages

public List<String> getLoadedPackages()

connectToTSServer

public void connectToTSServer(TerminologyClientManager.ITerminologyClientFactory factory,
 ITerminologyClient client,
 boolean useEcosystem)

connectToTSServer

public void connectToTSServer(TerminologyClientManager.ITerminologyClientFactory factory,
 String address,
 String software,
 String log,
 boolean useEcosystem)

loadFromFile

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

Throws:

org.hl7.fhir.exceptions.FHIRException

loadFromFile

public Resource loadFromFile(InputStream stream,
 String name,
 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 npm,
 IContextResourceLoader loader)
                    throws IOException,
org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContextManager

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

Specified by:

loadFromPackage in interface IWorkerContextManager

Parameters:

npm - - 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

loadPackage

public int loadPackage(org.hl7.fhir.utilities.npm.NpmPackage npm)
                throws IOException,
org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContextManager

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

Specified by:

loadPackage in interface IWorkerContextManager

Parameters:

npm - - the package to load

Returns:

the number of resources loaded

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

loadPackage

public int loadPackage(String idAndVer)
                throws IOException,
org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContextManager

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

Specified by:

loadPackage in interface IWorkerContextManager

Parameters:

idAndVer - - the package to load

Returns:

the number of resources loaded

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

defaultTypesToLoad

public static Set<String> defaultTypesToLoad()

loadFromPackageAndDependencies

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

Description copied from interface: IWorkerContextManager

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 IWorkerContextManager

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,
 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,
 IContextResourceLoader loader,
 Set<String> types)
                       throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

loadFromFile

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

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

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 this is deprecated because there's lots of properties to set on the validator; the functions using this need to be changed to use the validator directly

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 (sorted alphabetically)

getQuestionnaire

public Questionnaire getQuestionnaire()

setQuestionnaire

public void setQuestionnaire(Questionnaire questionnaire)

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

getVersion

public String getVersion()

Description copied from interface: IWorkerContext

The version loaded *does not* have to be 5.0 (R5) - the context can load other versions, though the definitions need to be converted to R5 first Note that more than one version might be loaded at once, but one version is always the default / master

Specified by:

getVersion in interface IWorkerContext

Returns:

the version of the base definitions loaded in context

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

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResource in interface IWorkerContext

Overrides:

fetchResource in class BaseWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

the resource if known (or null)

fetchResourceRaw

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

Description copied from interface: IWorkerContext

Find an identified resource, but do not do any processing on it. The usual processing that happens is ensuring that the snapshot is generated before returning it; This routine is used in the snapshot generation routines to avoid circular dependency challenges generating snapshots. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResourceRaw in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

the resource if known (or an exception will be thrown)

fetchResource

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

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResource in interface IWorkerContext

Overrides:

fetchResource in class BaseWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

version - the version. Don't provide both a version and a |version suffix

source - where the reference was found (if the reference is in a resource)

Returns:

if the resource is known

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

packageManager

public org.hl7.fhir.utilities.npm.IPackageCacheManager packageManager()

Specified by:

packageManager in interface IWorkerContextManager

setPackageManager

public void setPackageManager(org.hl7.fhir.utilities.npm.IPackageCacheManager packageCacheManager)

Specified by:

setPackageManager in interface IWorkerContextManager

cachePackage

public void cachePackage(PackageInformation packageInfo)

Description copied from interface: IWorkerContextManager

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 IWorkerContextManager

Parameters:

packageInfo -

hasPackage

public boolean hasPackage(String id,
 String ver)

Specified by:

hasPackage in interface IWorkerContext

Returns:

true if the nominated package has been loaded

hasPackage

public boolean hasPackage(String idAndver)

hasPackage

public boolean hasPackage(PackageInformation pack)

Specified by:

hasPackage in interface IWorkerContext

Returns:

true if the nominated package has been loaded (by id and version)

getPackage

public PackageInformation getPackage(String id,
 String ver)

Specified by:

getPackage in interface IWorkerContext

Returns:

package information for nominated package

isAllowLazyLoading

public boolean isAllowLazyLoading()

setAllowLazyLoading

public void setAllowLazyLoading(boolean allowLazyLoading)

loadedPackageSummary

public String loadedPackageSummary()

getSpecUrl

public String getSpecUrl()

Specified by:

getSpecUrl in interface IWorkerContext

Returns:

The URL that points to the specification for the version loaded

setXVerManager

public void setXVerManager(XVerExtensionManager value)