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 interface	RenderingContext.ILiquidTemplateProvider
static interface	RenderingContext.ITypeParser
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

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)

Method Summary

Modifier and Type	Method	Description
RenderingContext	copy()
String	fixReference(String ref)
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()
String	getDefinitionsTarget()
String	getDestDir()
int	getHeaderLevelContext()
String	getLang()
Locale	getLocale()
String	getLocalPrefix()
org.hl7.fhir.utilities.MarkDownProcessor	getMarkdown()
RenderingContext.ResourceRendererMode	getMode()
RenderingContext.ITypeParser	getParser()
ProfileUtilities	getProfileUtilities()
RenderingContext.QuestionnaireRendererMode	getQuestionnaireMode()
Resolver.IReferenceResolver	getResolver()
String	getSelfLink()
FHIRPathEngine.IEvaluationContext	getServices()
String	getSpecificationLink()
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	hasLocale()
boolean	isAddGeneratedNarrativeHeader()
boolean	isCanonicalUrlsAsLinks()
boolean	isHeader()
boolean	isInlineGraphics()
boolean	isNoSlowLookup()
boolean	isPretty()
boolean	isTechnicalMode()
RenderingContext	setAddGeneratedNarrativeHeader(boolean addGeneratedNarrativeHeader)
RenderingContext	setCanonicalUrlsAsLinks(boolean canonicalUrlsAsLinks)
RenderingContext	setCodeSystemPropList(List<String> codeSystemPropList)
void	setDateFormat(DateTimeFormatter dateFormat)
void	setDateFormatString(String dateFormat)
void	setDateTimeFormat(DateTimeFormatter dateTimeFormat)
void	setDateTimeFormatString(String dateTimeFormat)
void	setDateYearFormat(DateTimeFormatter dateYearFormat)
void	setDateYearFormatString(String dateYearFormat)
void	setDateYearMonthFormat(DateTimeFormatter dateYearMonthFormat)
void	setDateYearMonthFormatString(String dateYearMonthFormat)
RenderingContext	setDefinitionsTarget(String definitionsTarget)
RenderingContext	setDestDir(String destDir)
RenderingContext	setHeader(boolean header)
RenderingContext	setHeaderLevelContext(int headerLevelContext)
RenderingContext	setInlineGraphics(boolean inlineGraphics)
RenderingContext	setLang(String lang)
void	setLocale(Locale locale)
RenderingContext	setLocalPrefix(String localPrefix)
void	setMode(RenderingContext.ResourceRendererMode mode)
RenderingContext	setNoSlowLookup(boolean noSlowLookup)
RenderingContext	setParser(RenderingContext.ITypeParser parser)
RenderingContext	setPretty(boolean pretty)
RenderingContext	setProfileUtilities(ProfileUtilities profileUtilities)
RenderingContext	setQuestionnaireMode(RenderingContext.QuestionnaireRendererMode questionnaireMode)
RenderingContext	setResolver(Resolver.IReferenceResolver resolver)
RenderingContext	setSelfLink(String selfLink)
RenderingContext	setServices(FHIRPathEngine.IEvaluationContext services)
void	setTargetVersion(FhirPublication targetVersion)
RenderingContext	setTemplateProvider(RenderingContext.ILiquidTemplateProvider templateProvider)
RenderingContext	setTerminologyServiceOptions(org.hl7.fhir.utilities.validation.ValidationOptions terminologyServiceOptions)
void	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)

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

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

getSpecificationLink

public String getSpecificationLink()

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)

copy

public RenderingContext copy()

isInlineGraphics

public boolean isInlineGraphics()

setInlineGraphics

public RenderingContext setInlineGraphics(boolean inlineGraphics)

isHeader

public boolean isHeader()

setHeader

public RenderingContext setHeader(boolean header)

getQuestionnaireMode

public RenderingContext.QuestionnaireRendererMode getQuestionnaireMode()

setQuestionnaireMode

public RenderingContext setQuestionnaireMode(RenderingContext.QuestionnaireRendererMode questionnaireMode)

getSelfLink

public String getSelfLink()

setSelfLink

public RenderingContext setSelfLink(String selfLink)

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

setTargetVersion

public void setTargetVersion(FhirPublication targetVersion)

isTechnicalMode

public boolean isTechnicalMode()

hasLocale

public boolean hasLocale()

getLocale

public Locale getLocale()

setLocale

public void 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 void 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 void setDateTimeFormat(DateTimeFormatter dateTimeFormat)

setDateTimeFormatString

public void 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 void setDateFormat(DateTimeFormatter dateFormat)

setDateFormatString

public void setDateFormatString(String dateFormat)

getDateYearFormat

public DateTimeFormatter getDateYearFormat()

setDateYearFormat

public void setDateYearFormat(DateTimeFormatter dateYearFormat)

setDateYearFormatString

public void setDateYearFormatString(String dateYearFormat)

getDateYearMonthFormat

public DateTimeFormatter getDateYearMonthFormat()

setDateYearMonthFormat

public void setDateYearMonthFormat(DateTimeFormatter dateYearMonthFormat)

setDateYearMonthFormatString

public void setDateYearMonthFormatString(String dateYearMonthFormat)

getMode

public RenderingContext.ResourceRendererMode getMode()

setMode

public void setMode(RenderingContext.ResourceRendererMode mode)