Package org.hl7.fhir.r5.renderers

Class ResourceRenderer

java.lang.Object

org.hl7.fhir.r5.renderers.Renderer

org.hl7.fhir.r5.renderers.DataRenderer

org.hl7.fhir.r5.renderers.ResourceRenderer

All Implemented Interfaces:

CodeResolver

Direct Known Subclasses:

ActorDefinitionRenderer, BundleRenderer, CapabilityStatementRenderer, CompartmentDefinitionRenderer, DiagnosticReportRenderer, FeatureDefinitionRenderer, ImplementationGuideRenderer, LibraryRenderer, LiquidRenderer, ListRenderer, NamingSystemRenderer, OperationOutcomeRenderer, ParametersRenderer, PatientRenderer, ProfileDrivenRenderer, ProvenanceRenderer, QuestionnaireResponseRenderer, RequirementsRenderer, StructureDefinitionRenderer, SubscriptionTopicRenderer, TerminologyRenderer, TestPlanRenderer, ViewDefinitionRenderer, WebTemplateRenderer

public abstract class ResourceRenderer
extends DataRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ResourceRenderer.RendererType
class	ResourceRenderer.TableData
class	ResourceRenderer.TableRowData

Nested classes/interfaces inherited from class org.hl7.fhir.r5.renderers.Renderer

Renderer.RenderingStatus

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.renderers.CodeResolver

CodeResolver.CodeResolution

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	inner
protected boolean	multiLangMode
protected XVerExtensionManager	xverManager

Fields inherited from class org.hl7.fhir.r5.renderers.Renderer

context

Constructor Summary

Constructors

Constructor	Description
ResourceRenderer(RenderingContext context)

Method Summary

Modifier and Type	Method	Description
protected void	addContained(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, List<ResourceWrapper> list)
abstract void	buildNarrative(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper r)
org.hl7.fhir.utilities.xhtml.XhtmlNode	buildNarrative(ResourceWrapper dr)	Just build the narrative that would go in the resource (per @renderResource()), but don't put it in the resource
void	buildSummary(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper r)
abstract String	buildSummary(ResourceWrapper r)
String	canonicalTitle(ResourceWrapper r)
boolean	canRender(Resource resource)
org.hl7.fhir.utilities.xhtml.XhtmlNode	checkNarrative(ResourceWrapper r)
void	describe(org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper r)
protected String	describeStatus(String status, String experimental, ResourceWrapper dt, String deprecated)
protected String	describeStatus(Enumerations.PublicationStatus status, boolean experimental)
protected String	describeStatus(Enumerations.PublicationStatus status, boolean experimental, DateTimeType dt, Boolean deprecated)
protected String	describeStatus(Renderer.RenderingStatus status, CanonicalResource cr)
protected String	describeStatus(Renderer.RenderingStatus status, ResourceWrapper cr)
protected String	displayCanonical(ResourceWrapper canonical)
String	displayReference(Resource res, Reference r)
protected String	displayReference(ResourceWrapper type)
protected <T extends Resource> T	findCanonical(Class<T> class_, String canonical, ResourceWrapper sourceOfReference)
protected <T extends Resource> T	findCanonical(Class<T> class_, UriType canonical, ResourceWrapper sourceOfReference)	Eventually this will be retired if and when there's no more direct renderers
protected void	generateCopyright(org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper cs)
protected void	generateCopyrightTableRow(org.hl7.fhir.utilities.xhtml.XhtmlNode tbl, ResourceWrapper cs)
void	genSummaryTable(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, CanonicalResource cr)
boolean	genSummaryTable(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper cr)
protected void	genSummaryTableContent(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode tbl, CanonicalResource cr)
protected void	genSummaryTableContent(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode tbl, ResourceWrapper cr)
protected String	getNameForResource(ResourceWrapper resource)
ResourceRenderer.RendererType	getRendererType()
protected boolean	hasAnchorName(org.hl7.fhir.utilities.xhtml.XhtmlNode x, String an)
void	inject(ResourceWrapper r, org.hl7.fhir.utilities.xhtml.XhtmlNode x, Narrative.NarrativeStatus status)
boolean	isInner()
boolean	isMultiLangMode()
protected String	makeIdFromBundleEntry(String url)
static String	makeInternalBundleLink(ResourceWrapper bundle, String fullUrl)
void	markLanguage(org.hl7.fhir.utilities.xhtml.XhtmlNode x)
Base	parseType(String string, String type)
protected org.hl7.fhir.utilities.xhtml.XhtmlNode	plateStyle(org.hl7.fhir.utilities.xhtml.XhtmlNode para)
<T extends Resource> void	renderCanonical(Renderer.RenderingStatus status, ResourceWrapper res, org.hl7.fhir.utilities.xhtml.XhtmlNode x, Class<T> class_, CanonicalType canonical)
<T extends Resource> void	renderCanonical(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, Class<T> class_, ResourceWrapper canonical)
protected void	renderCanonical(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper type)
protected void	renderCommitteeLink(org.hl7.fhir.utilities.xhtml.XhtmlNode x, CanonicalResource cr)
protected void	renderCommitteeLink(org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper cr)
boolean	renderingUsesValidation()
void	renderOrError(ResourceWrapper dr)
void	renderReference(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper type)	this is overridden in ResourceRenderer where a better rendering is performed
void	renderReference(ResourceWrapper res, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Piece> pieces, Reference r, boolean allowLinks)
void	renderReference(ResourceWrapper res, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Piece> pieces, ResourceWrapper r, boolean allowLinks)
void	renderResource(ResourceWrapper r)	given a resource, update it's narrative with the best rendering available.
protected org.hl7.fhir.utilities.xhtml.XhtmlNode	renderResourceTechDetails(ResourceWrapper r, org.hl7.fhir.utilities.xhtml.XhtmlNode x)
protected org.hl7.fhir.utilities.xhtml.XhtmlNode	renderResourceTechDetails(ResourceWrapper r, org.hl7.fhir.utilities.xhtml.XhtmlNode x, String id)
void	renderTable(Renderer.RenderingStatus status, ResourceRenderer.TableData provider, org.hl7.fhir.utilities.xhtml.XhtmlNode x)
protected void	renderUri(Renderer.RenderingStatus status, ResourceWrapper resource, org.hl7.fhir.utilities.xhtml.XhtmlNode x, UriType uri)
protected void	renderUri(Renderer.RenderingStatus status, org.hl7.fhir.utilities.xhtml.XhtmlNode x, ResourceWrapper uri)
protected Resolver.ResourceWithReference	resolveReference(ResourceWrapper reference)
protected Resolver.ResourceWithReference	resolveReference(ResourceWrapper resource, String url, boolean followLinks)
protected void	selfLink(org.hl7.fhir.utilities.xhtml.XhtmlNode node, String link)
ResourceRenderer	setInner(boolean inner)
ResourceRenderer	setMultiLangMode(boolean multiLangMode)
protected boolean	willRenderId(ResourceWrapper r)

Methods inherited from class org.hl7.fhir.r5.renderers.DataRenderer

addMarkdown, addMarkdown, addTelecom, canRenderDataType, checkRenderExtensions, describeLang, describeVersion, display, displayBase, displayCodeableConcept, displayCodeSource, displayCoding, displayCoding, displayContactDetail, displayContactPoint, displayContactPoint, displayDataType, displayDataType, displayDateTime, displayHumanName, displayIdentifier, displayPeriod, displayQuantity, displayRange, displaySystem, getContext, getLinkForCode, getLinkForSystem, getLocalizedBigDecimalValue, gt, gt, hasRenderableExtensions, hasRenderableExtensions, hasRenderableExtensions, isInKnownUrlSpace, lookupCode, makeAnchor, makeExceptionXhtml, processRelativeUrls, renderAddress, renderAnnotation, renderBase, renderCodeableConcept, renderCodeableReference, renderCoding, renderCoding, renderCoding, renderCoding, renderCodingWithDetails, renderContactPoint, renderDataRequirement, renderDataType, renderDataType, renderExpression, renderExtensionsInList, renderExtensionsInText, renderHumanName, renderIdentifier, renderMoney, renderPeriod, renderPrimitiveWithNoValue, renderPrimitiveWithNoValue, renderQuantity, renderQuantity, renderQuantity, renderRange, renderSampledData, renderTiming, renderTriggerDefinition, renderUsageContext, resolveCode, resolveCode, resolveCode, resolveCode, systemFromCanonical, tail, utail, versionFromCanonical

Methods inherited from class org.hl7.fhir.r5.renderers.Renderer

egt, formatPhrase, genStandardsStatus, getTranslatedCode, markBoilerplate, markGenerated, renderStatus, renderStatusDiv, renderStatusRow, renderStatusSummary, spanIfTracking, toStr, toStr, wrap, wrapNC, wrapWC, xlinkNarrative

Methods inherited from class java.lang.Object

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

Field Details

xverManager

protected XVerExtensionManager xverManager

multiLangMode

protected boolean multiLangMode

inner

protected boolean inner

Constructor Details

ResourceRenderer

public ResourceRenderer(RenderingContext context)

Method Details

isMultiLangMode

public boolean isMultiLangMode()

setMultiLangMode

public ResourceRenderer setMultiLangMode(boolean multiLangMode)

renderingUsesValidation

public boolean renderingUsesValidation()

isInner

public boolean isInner()

setInner

public ResourceRenderer setInner(boolean inner)

buildNarrative

public org.hl7.fhir.utilities.xhtml.XhtmlNode buildNarrative(ResourceWrapper dr)
                                                      throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
org.hl7.fhir.exceptions.FHIRException,
IOException,
EOperationOutcome

Just build the narrative that would go in the resource (per @renderResource()), but don't put it in the resource

Parameters:

dr -

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

org.hl7.fhir.exceptions.FHIRException

IOException

EOperationOutcome

renderResource

public void renderResource(ResourceWrapper r)
                    throws IOException,
org.hl7.fhir.exceptions.FHIRException,
EOperationOutcome

given a resource, update it's narrative with the best rendering available. ResourceWrapper is a facade to either a org.hl7.fhir.r5.model Resource, or to a org.hl7.fhir.r5.elementModel (which might a resource of any version). Note that some resource renderers - only canonical ones - only render native resources, and not element model ones. These may be migrated in the future (only reason not to is the sheer size of the task, though performance might be a factor)

Parameters:

r - - the domain resource in question

Throws:

IOException

EOperationOutcome

org.hl7.fhir.exceptions.FHIRException

checkNarrative

public org.hl7.fhir.utilities.xhtml.XhtmlNode checkNarrative(ResourceWrapper r)
                                                      throws IOException,
org.hl7.fhir.exceptions.FHIRException,
EOperationOutcome

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

EOperationOutcome

hasAnchorName

protected boolean hasAnchorName(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 String an)

buildNarrative

public abstract void buildNarrative(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper r)
                             throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException,
org.hl7.fhir.exceptions.FHIRException,
EOperationOutcome

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

org.hl7.fhir.exceptions.FHIRException

EOperationOutcome

buildSummary

public abstract String buildSummary(ResourceWrapper r)
                             throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

buildSummary

public void buildSummary(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper r)
                  throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

canonicalTitle

public String canonicalTitle(ResourceWrapper r)

describe

public void describe(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper r)
              throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

inject

public void inject(ResourceWrapper r,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 Narrative.NarrativeStatus status)
            throws IOException

Throws:

IOException

markLanguage

public void markLanguage(org.hl7.fhir.utilities.xhtml.XhtmlNode x)

renderCanonical

protected void renderCanonical(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper type)
                        throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Overrides:

renderCanonical in class DataRenderer

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

renderCanonical

public <T extends Resource> void renderCanonical(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 Class<T> class_,
 ResourceWrapper canonical)
                                          throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

displayCanonical

protected String displayCanonical(ResourceWrapper canonical)

displayReference

protected String displayReference(ResourceWrapper type)

Overrides:

displayReference in class DataRenderer

renderCanonical

public <T extends Resource> void renderCanonical(Renderer.RenderingStatus status,
 ResourceWrapper res,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 Class<T> class_,
 CanonicalType canonical)
                                          throws UnsupportedEncodingException,
IOException

Type Parameters:

T -

Parameters:

status -

res -

x -

class_ - - makes resolution faster, but can just be Resource.class

canonical -

Throws:

UnsupportedEncodingException

IOException

renderReference

public void renderReference(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper type)
                     throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Description copied from class: DataRenderer

this is overridden in ResourceRenderer where a better rendering is performed

Overrides:

renderReference in class DataRenderer

Parameters:

status -

x -

type -

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

renderReference

public void renderReference(ResourceWrapper res,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Piece> pieces,
 Reference r,
 boolean allowLinks)
                     throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

renderReference

public void renderReference(ResourceWrapper res,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Piece> pieces,
 ResourceWrapper r,
 boolean allowLinks)
                     throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

getNameForResource

protected String getNameForResource(ResourceWrapper resource)

renderUri

protected void renderUri(Renderer.RenderingStatus status,
 ResourceWrapper resource,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 UriType uri)
                  throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

renderUri

protected void renderUri(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper uri)
                  throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Overrides:

renderUri in class DataRenderer

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

findCanonical

protected <T extends Resource> T findCanonical(Class<T> class_,
 UriType canonical,
 ResourceWrapper sourceOfReference)

Eventually this will be retired if and when there's no more direct renderers

Type Parameters:

T -

findCanonical

protected <T extends Resource> T findCanonical(Class<T> class_,
 String canonical,
 ResourceWrapper sourceOfReference)

resolveReference

protected Resolver.ResourceWithReference resolveReference(ResourceWrapper resource,
 String url,
 boolean followLinks)
                                                   throws IOException

Throws:

IOException

resolveReference

protected Resolver.ResourceWithReference resolveReference(ResourceWrapper reference)

makeIdFromBundleEntry

protected String makeIdFromBundleEntry(String url)

generateCopyright

protected void generateCopyright(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper cs)

generateCopyrightTableRow

protected void generateCopyrightTableRow(org.hl7.fhir.utilities.xhtml.XhtmlNode tbl,
 ResourceWrapper cs)

displayReference

public String displayReference(Resource res,
 Reference r)
                        throws UnsupportedEncodingException,
IOException

Throws:

UnsupportedEncodingException

IOException

parseType

public Base parseType(String string,
 String type)

describeStatus

protected String describeStatus(Enumerations.PublicationStatus status,
 boolean experimental)

renderCommitteeLink

protected void renderCommitteeLink(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 CanonicalResource cr)

makeInternalBundleLink

public static String makeInternalBundleLink(ResourceWrapper bundle,
 String fullUrl)

canRender

public boolean canRender(Resource resource)

renderResourceTechDetails

protected org.hl7.fhir.utilities.xhtml.XhtmlNode renderResourceTechDetails(ResourceWrapper r,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x)
                                                                    throws UnsupportedEncodingException,
org.hl7.fhir.exceptions.FHIRException,
IOException

Throws:

UnsupportedEncodingException

org.hl7.fhir.exceptions.FHIRException

IOException

renderResourceTechDetails

protected org.hl7.fhir.utilities.xhtml.XhtmlNode renderResourceTechDetails(ResourceWrapper r,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 String id)
                                                                    throws UnsupportedEncodingException,
org.hl7.fhir.exceptions.FHIRException,
IOException

Throws:

UnsupportedEncodingException

org.hl7.fhir.exceptions.FHIRException

IOException

willRenderId

protected boolean willRenderId(ResourceWrapper r)

plateStyle

protected org.hl7.fhir.utilities.xhtml.XhtmlNode plateStyle(org.hl7.fhir.utilities.xhtml.XhtmlNode para)

getRendererType

public ResourceRenderer.RendererType getRendererType()

renderTable

public void renderTable(Renderer.RenderingStatus status,
 ResourceRenderer.TableData provider,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x)
                 throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

renderOrError

public void renderOrError(ResourceWrapper dr)
                   throws IOException

Throws:

IOException

genSummaryTable

public boolean genSummaryTable(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper cr)
                        throws IOException

Throws:

IOException

genSummaryTableContent

protected void genSummaryTableContent(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode tbl,
 ResourceWrapper cr)
                               throws IOException

Throws:

IOException

genSummaryTable

public void genSummaryTable(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 CanonicalResource cr)
                     throws IOException

Throws:

IOException

genSummaryTableContent

protected void genSummaryTableContent(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode tbl,
 CanonicalResource cr)
                               throws IOException

Throws:

IOException

renderCommitteeLink

protected void renderCommitteeLink(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 ResourceWrapper cr)

describeStatus

protected String describeStatus(Renderer.RenderingStatus status,
 ResourceWrapper cr)

describeStatus

protected String describeStatus(Renderer.RenderingStatus status,
 CanonicalResource cr)

describeStatus

protected String describeStatus(Enumerations.PublicationStatus status,
 boolean experimental,
 DateTimeType dt,
 Boolean deprecated)

describeStatus

protected String describeStatus(String status,
 String experimental,
 ResourceWrapper dt,
 String deprecated)

addContained

protected void addContained(Renderer.RenderingStatus status,
 org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 List<ResourceWrapper> list)
                     throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
org.hl7.fhir.exceptions.FHIRException,
IOException,
EOperationOutcome

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

org.hl7.fhir.exceptions.FHIRException

IOException

EOperationOutcome

selfLink

protected void selfLink(org.hl7.fhir.utilities.xhtml.XhtmlNode node,
 String link)