Package org.hl7.fhir.r5.renderers.utils

Class RenderingContext

java.lang.Object

org.hl7.fhir.r5.renderers.utils.RenderingContext

public class RenderingContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RenderingContext.ExampleScenarioRendererMode
static enum	RenderingContext.GenerationRules
static interface	RenderingContext.ILiquidTemplateProvider
static interface	RenderingContext.ITypeParser
static enum	RenderingContext.KnownLinkType
static enum	RenderingContext.QuestionnaireRendererMode
static enum	RenderingContext.ResourceRendererMode	What kind of user the renderer is targeting - end users, or technical users This affects the way codes and references are rendered
static enum	RenderingContext.StructureDefinitionRendererMode

Constructor Summary

Constructors

Constructor	Description
RenderingContext(IWorkerContext worker, org.hl7.fhir.utilities.MarkDownProcessor markdown, org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions, String specLink, String localPrefix, String lang, RenderingContext.ResourceRendererMode mode, RenderingContext.GenerationRules rules)

Method Summary

Modifier and Type	Method	Description
void	addLink(RenderingContext.KnownLinkType type, String link)
RenderingContext	copy()
String	fixReference(String ref)
String	getChangeVersion()
List<String>	getCodeSystemPropList()
IWorkerContext	getContext()
DateTimeFormatter	getDateFormat()	In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.
DateTimeFormatter	getDateTimeFormat()	In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.
DateTimeFormatter	getDateYearFormat()
DateTimeFormatter	getDateYearMonthFormat()
org.hl7.fhir.utilities.StandardsStatus	getDefaultStandardsStatus()
String	getDefinitionsTarget()
String	getDestDir()
int	getHeaderLevelContext()
String	getLang()
String	getLink(RenderingContext.KnownLinkType link)
Locale	getLocale()
String	getLocalPrefix()
org.hl7.fhir.utilities.MarkDownProcessor	getMarkdown()
RenderingContext.ResourceRendererMode	getMode()
RenderingContext.ITypeParser	getParser()
ProfileKnowledgeProvider	getPkp()
ProfileUtilities	getProfileUtilities()
RenderingContext.QuestionnaireRendererMode	getQuestionnaireMode()
Resolver.IReferenceResolver	getResolver()
RenderingContext.GenerationRules	getRules()
RenderingContext.ExampleScenarioRendererMode	getScenarioMode()
FHIRPathEngine.IEvaluationContext	getServices()
RenderingContext.StructureDefinitionRendererMode	getStructureMode()
org.hl7.fhir.utilities.FhirPublication	getTargetVersion()
RenderingContext.ILiquidTemplateProvider	getTemplateProvider()
org.hl7.fhir.utilities.validation.ValidationOptions	getTerminologyServiceOptions()
ZoneId	getTimeZoneId()	if the timezone is null, the rendering will default to the source timezone in the resource Note that if you're working server side, the FHIR project recommends the use of the Date header so that clients know what timezone the server defaults to, There is no standard way for the server to know what the client timezone is.
String	getTooCostlyNoteEmpty()
String	getTooCostlyNoteEmptyDependent()
String	getTooCostlyNoteNotEmpty()
String	getTooCostlyNoteNotEmptyDependent()
IWorkerContext	getWorker()
boolean	hasLink(RenderingContext.KnownLinkType link)
boolean	hasLocale()
boolean	isAddGeneratedNarrativeHeader()
boolean	isCanonicalUrlsAsLinks()
boolean	isContained()
boolean	isCopyButton()
boolean	isHeader()
boolean	isInlineGraphics()
boolean	isNoSlowLookup()
boolean	isPretty()
boolean	isShowComments()
boolean	isTechnicalMode()
RenderingContext	setAddGeneratedNarrativeHeader(boolean addGeneratedNarrativeHeader)
RenderingContext	setCanonicalUrlsAsLinks(boolean canonicalUrlsAsLinks)
RenderingContext	setChangeVersion(String changeVersion)
RenderingContext	setCodeSystemPropList(List<String> codeSystemPropList)
RenderingContext	setContained(boolean contained)
RenderingContext	setCopyButton(boolean copyButton)
RenderingContext	setDateFormat(DateTimeFormatter dateFormat)
RenderingContext	setDateFormatString(String dateFormat)
RenderingContext	setDateTimeFormat(DateTimeFormatter dateTimeFormat)
RenderingContext	setDateTimeFormatString(String dateTimeFormat)
RenderingContext	setDateYearFormat(DateTimeFormatter dateYearFormat)
RenderingContext	setDateYearFormatString(String dateYearFormat)
RenderingContext	setDateYearMonthFormat(DateTimeFormatter dateYearMonthFormat)
RenderingContext	setDateYearMonthFormatString(String dateYearMonthFormat)
RenderingContext	setDefaultStandardsStatus(org.hl7.fhir.utilities.StandardsStatus defaultStandardsStatus)
RenderingContext	setDefinitionsTarget(String definitionsTarget)
RenderingContext	setDestDir(String destDir)
RenderingContext	setHeader(boolean header)
RenderingContext	setHeaderLevelContext(int headerLevelContext)
RenderingContext	setInlineGraphics(boolean inlineGraphics)
RenderingContext	setLang(String lang)
RenderingContext	setLocale(Locale locale)
RenderingContext	setLocalPrefix(String localPrefix)
RenderingContext	setMode(RenderingContext.ResourceRendererMode mode)
RenderingContext	setNoSlowLookup(boolean noSlowLookup)
RenderingContext	setParser(RenderingContext.ITypeParser parser)
RenderingContext	setPkp(ProfileKnowledgeProvider pkp)
RenderingContext	setPretty(boolean pretty)
RenderingContext	setProfileUtilities(ProfileUtilities profileUtilities)
RenderingContext	setQuestionnaireMode(RenderingContext.QuestionnaireRendererMode questionnaireMode)
RenderingContext	setResolver(Resolver.IReferenceResolver resolver)
void	setRules(RenderingContext.GenerationRules rules)
RenderingContext	setScenarioMode(RenderingContext.ExampleScenarioRendererMode scenarioMode)
RenderingContext	setServices(FHIRPathEngine.IEvaluationContext services)
RenderingContext	setShowComments(boolean showComments)
RenderingContext	setStructureMode(RenderingContext.StructureDefinitionRendererMode structureMode)
RenderingContext	setTargetVersion(org.hl7.fhir.utilities.FhirPublication targetVersion)
RenderingContext	setTemplateProvider(RenderingContext.ILiquidTemplateProvider templateProvider)
RenderingContext	setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions)
RenderingContext	setTimeZoneId(ZoneId timeZoneId)
RenderingContext	setTooCostlyNoteEmpty(String tooCostlyNoteEmpty)
RenderingContext	setTooCostlyNoteEmptyDependent(String tooCostlyNoteEmptyDependent)
RenderingContext	setTooCostlyNoteNotEmpty(String tooCostlyNoteNotEmpty)
RenderingContext	setTooCostlyNoteNotEmptyDependent(String tooCostlyNoteNotEmptyDependent)

Methods inherited from class java.lang.Object

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

Constructor Details

RenderingContext

public RenderingContext(IWorkerContext worker,
 org.hl7.fhir.utilities.MarkDownProcessor markdown,
 org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions,
 String specLink,
 String localPrefix,
 String lang,
 RenderingContext.ResourceRendererMode mode,
 RenderingContext.GenerationRules rules)

Parameters:

context - - access to all related resources that might be needed

markdown - - appropriate markdown processing engine

terminologyServiceOptions - - options to use when looking up codes

specLink - - path to FHIR specification

lang - - langauage to render in

Method Details

copy

public RenderingContext copy()

getContext

public IWorkerContext getContext()

getProfileUtilities

public ProfileUtilities getProfileUtilities()

getWorker

public IWorkerContext getWorker()

isCanonicalUrlsAsLinks

public boolean isCanonicalUrlsAsLinks()

setCanonicalUrlsAsLinks

public RenderingContext setCanonicalUrlsAsLinks(boolean canonicalUrlsAsLinks)

getMarkdown

public org.hl7.fhir.utilities.MarkDownProcessor getMarkdown()

getLang

public String getLang()

getLocalPrefix

public String getLocalPrefix()

getTerminologyServiceOptions

public org.hl7.fhir.utilities.validation.ValidationOptions getTerminologyServiceOptions()

getTooCostlyNoteEmpty

public String getTooCostlyNoteEmpty()

setTooCostlyNoteEmpty

public RenderingContext setTooCostlyNoteEmpty(String tooCostlyNoteEmpty)

getTooCostlyNoteNotEmpty

public String getTooCostlyNoteNotEmpty()

setTooCostlyNoteNotEmpty

public RenderingContext setTooCostlyNoteNotEmpty(String tooCostlyNoteNotEmpty)

getTooCostlyNoteEmptyDependent

public String getTooCostlyNoteEmptyDependent()

setTooCostlyNoteEmptyDependent

public RenderingContext setTooCostlyNoteEmptyDependent(String tooCostlyNoteEmptyDependent)

getTooCostlyNoteNotEmptyDependent

public String getTooCostlyNoteNotEmptyDependent()

setTooCostlyNoteNotEmptyDependent

public RenderingContext setTooCostlyNoteNotEmptyDependent(String tooCostlyNoteNotEmptyDependent)

getHeaderLevelContext

public int getHeaderLevelContext()

setHeaderLevelContext

public RenderingContext setHeaderLevelContext(int headerLevelContext)

getResolver

public Resolver.IReferenceResolver getResolver()

setResolver

public RenderingContext setResolver(Resolver.IReferenceResolver resolver)

setTerminologyServiceOptions

public RenderingContext setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions)

isNoSlowLookup

public boolean isNoSlowLookup()

setNoSlowLookup

public RenderingContext setNoSlowLookup(boolean noSlowLookup)

getDefinitionsTarget

public String getDefinitionsTarget()

setDefinitionsTarget

public RenderingContext setDefinitionsTarget(String definitionsTarget)

getDestDir

public String getDestDir()

setDestDir

public RenderingContext setDestDir(String destDir)

setProfileUtilities

public RenderingContext setProfileUtilities(ProfileUtilities profileUtilities)

getTemplateProvider

public RenderingContext.ILiquidTemplateProvider getTemplateProvider()

setTemplateProvider

public RenderingContext setTemplateProvider(RenderingContext.ILiquidTemplateProvider templateProvider)

getServices

public FHIRPathEngine.IEvaluationContext getServices()

setServices

public RenderingContext setServices(FHIRPathEngine.IEvaluationContext services)

isPretty

public boolean isPretty()

setPretty

public RenderingContext setPretty(boolean pretty)

getParser

public RenderingContext.ITypeParser getParser()

setParser

public RenderingContext setParser(RenderingContext.ITypeParser parser)

getCodeSystemPropList

public List<String> getCodeSystemPropList()

setCodeSystemPropList

public RenderingContext setCodeSystemPropList(List<String> codeSystemPropList)

isInlineGraphics

public boolean isInlineGraphics()

setInlineGraphics

public RenderingContext setInlineGraphics(boolean inlineGraphics)

isHeader

public boolean isHeader()

setHeader

public RenderingContext setHeader(boolean header)

getScenarioMode

public RenderingContext.ExampleScenarioRendererMode getScenarioMode()

setScenarioMode

public RenderingContext setScenarioMode(RenderingContext.ExampleScenarioRendererMode scenarioMode)

getQuestionnaireMode

public RenderingContext.QuestionnaireRendererMode getQuestionnaireMode()

setQuestionnaireMode

public RenderingContext setQuestionnaireMode(RenderingContext.QuestionnaireRendererMode questionnaireMode)

getStructureMode

public RenderingContext.StructureDefinitionRendererMode getStructureMode()

setStructureMode

public RenderingContext setStructureMode(RenderingContext.StructureDefinitionRendererMode structureMode)

fixReference

public String fixReference(String ref)

setLang

public RenderingContext setLang(String lang)

setLocalPrefix

public RenderingContext setLocalPrefix(String localPrefix)

isAddGeneratedNarrativeHeader

public boolean isAddGeneratedNarrativeHeader()

setAddGeneratedNarrativeHeader

public RenderingContext setAddGeneratedNarrativeHeader(boolean addGeneratedNarrativeHeader)

getTargetVersion

public org.hl7.fhir.utilities.FhirPublication getTargetVersion()

setTargetVersion

public RenderingContext setTargetVersion(org.hl7.fhir.utilities.FhirPublication targetVersion)

isTechnicalMode

public boolean isTechnicalMode()

hasLocale

public boolean hasLocale()

getLocale

public Locale getLocale()

setLocale

public RenderingContext setLocale(Locale locale)

getTimeZoneId

public ZoneId getTimeZoneId()

if the timezone is null, the rendering will default to the source timezone in the resource Note that if you're working server side, the FHIR project recommends the use of the Date header so that clients know what timezone the server defaults to, There is no standard way for the server to know what the client timezone is. In the case where the client timezone is unknown, the timezone should be null

Returns:

the specified timezone to render in

setTimeZoneId

public RenderingContext setTimeZoneId(ZoneId timeZoneId)

getDateTimeFormat

public DateTimeFormatter getDateTimeFormat()

In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.

Returns:

the format to use

setDateTimeFormat

public RenderingContext setDateTimeFormat(DateTimeFormatter dateTimeFormat)

setDateTimeFormatString

public RenderingContext setDateTimeFormatString(String dateTimeFormat)

getDateFormat

public DateTimeFormatter getDateFormat()

In the absence of a specified format, the renderers will default to the FormatStyle.MEDIUM for the current locale.

Returns:

the format to use

setDateFormat

public RenderingContext setDateFormat(DateTimeFormatter dateFormat)

setDateFormatString

public RenderingContext setDateFormatString(String dateFormat)

getDateYearFormat

public DateTimeFormatter getDateYearFormat()

setDateYearFormat

public RenderingContext setDateYearFormat(DateTimeFormatter dateYearFormat)

setDateYearFormatString

public RenderingContext setDateYearFormatString(String dateYearFormat)

getDateYearMonthFormat

public DateTimeFormatter getDateYearMonthFormat()

setDateYearMonthFormat

public RenderingContext setDateYearMonthFormat(DateTimeFormatter dateYearMonthFormat)

setDateYearMonthFormatString

public RenderingContext setDateYearMonthFormatString(String dateYearMonthFormat)

getMode

public RenderingContext.ResourceRendererMode getMode()

setMode

public RenderingContext setMode(RenderingContext.ResourceRendererMode mode)

isContained

public boolean isContained()

setContained

public RenderingContext setContained(boolean contained)

isShowComments

public boolean isShowComments()

setShowComments

public RenderingContext setShowComments(boolean showComments)

isCopyButton

public boolean isCopyButton()

setCopyButton

public RenderingContext setCopyButton(boolean copyButton)

setPkp

public RenderingContext setPkp(ProfileKnowledgeProvider pkp)

getPkp

public ProfileKnowledgeProvider getPkp()

hasLink

public boolean hasLink(RenderingContext.KnownLinkType link)

getLink

public String getLink(RenderingContext.KnownLinkType link)

addLink

public void addLink(RenderingContext.KnownLinkType type,
 String link)

getRules

public RenderingContext.GenerationRules getRules()

setRules

public void setRules(RenderingContext.GenerationRules rules)

getDefaultStandardsStatus

public org.hl7.fhir.utilities.StandardsStatus getDefaultStandardsStatus()

setDefaultStandardsStatus

public RenderingContext setDefaultStandardsStatus(org.hl7.fhir.utilities.StandardsStatus defaultStandardsStatus)

getChangeVersion

public String getChangeVersion()

setChangeVersion

public RenderingContext setChangeVersion(String changeVersion)