Package ca.uhn.fhir.parser

Class RDFParser

java.lang.Object

ca.uhn.fhir.parser.BaseParser

ca.uhn.fhir.parser.RDFParser

All Implemented Interfaces:

IParser

public class RDFParser
extends BaseParser

This class is the FHIR RDF parser/encoder. Users should not interact with this class directly, but should use FhirContext.newRDFParser() to get an instance.

Nested Class Summary

Nested classes/interfaces inherited from class ca.uhn.fhir.parser.BaseParser

BaseParser.CompositeChildElement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTAINED
static final String	DOMAIN_RESOURCE_CONTAINED
static final String	ELEMENT_ID
static final String	EXTENSION
static final String	ID
static final String	MODIFIER_EXTENSION
static final String	NODE_ROLE
static final String	RESOURCE_ID
static final String	TREE_ROOT

Fields inherited from class ca.uhn.fhir.parser.BaseParser

RESOURCE_CREATED_BY_PARSER

Constructor Summary

Constructors

Constructor	Description
RDFParser(FhirContext context, IParserErrorHandler parserErrorHandler, org.apache.jena.riot.Lang lang)	Do not use this constructor, the recommended way to obtain a new instance of the RDF parser is to invoke FhirContext.newRDFParser().

Method Summary

Modifier and Type	Method	Description
protected void	doEncodeResourceToWriter(IBaseResource resource, Writer writer, ca.uhn.fhir.parser.BaseParser.EncodeContext encodeContext)	Writes the provided resource to the writer.
protected <T extends IBaseResource> T	doParseResource(Class<T> resourceType, Reader reader)	Parses RDF content to a FHIR resource using Apache Jena
EncodingEnum	getEncoding()	Which encoding does this parser instance produce?
IParser	setPrettyPrint(boolean prettyPrint)	Sets the "pretty print" flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.

Methods inherited from class ca.uhn.fhir.parser.BaseParser

compositeChildIterator, containResourcesInReferences, doEncodeToWriter, encodeResourceToString, encodeResourceToWriter, encodeResourceToWriter, encodeToString, encodeToWriter, encodeToWriter, extractMetadataListNotNull, fixContainedResourceId, getCompositeElementId, getContext, getDontStripVersionsFromReferencesAtPaths, getEncodeForceResourceId, getErrorHandler, getExtensionMetadataKeys, getExtensionUrl, getMetaTagsForEncoding, getPreferTypes, getProfileTagsForEncoding, getServerBaseUrl, getStripVersionsFromReferences, getSuppressNarratives, isChildContained, isEncodeElementsAppliesToChildResourcesOnly, isOmitResourceId, isSummaryMode, isSuppressNarratives, parseResource, parseResource, parseResource, parseResource, parseResource, parseResource, preProcessValues, setDontEncodeElements, setDontStripVersionsFromReferencesAtPaths, setDontStripVersionsFromReferencesAtPaths, setEncodeElements, setEncodeElementsAppliesToChildResourcesOnly, setEncodeForceResourceId, setOmitResourceId, setOverrideResourceIdWithBundleEntryFullUrl, setParserErrorHandler, setPreferTypes, setServerBaseUrl, setStripVersionsFromReferences, setSummaryMode, setSuppressNarratives, shouldAddSubsettedTag, shouldEncodePath, shouldEncodeResource, shouldEncodeResourceId, shouldEncodeResourceMeta, throwExceptionForUnknownChildType

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.parser.IParser

setDontEncodeElements, setEncodeElements

Field Details

NODE_ROLE

public static final String NODE_ROLE

See Also:

• Constant Field Values

TREE_ROOT

public static final String TREE_ROOT

See Also:

• Constant Field Values

RESOURCE_ID

public static final String RESOURCE_ID

See Also:

• Constant Field Values

ID

public static final String ID

See Also:

• Constant Field Values

ELEMENT_ID

public static final String ELEMENT_ID

See Also:

• Constant Field Values

DOMAIN_RESOURCE_CONTAINED

public static final String DOMAIN_RESOURCE_CONTAINED

See Also:

• Constant Field Values

EXTENSION

public static final String EXTENSION

See Also:

• Constant Field Values

CONTAINED

public static final String CONTAINED

See Also:

• Constant Field Values

MODIFIER_EXTENSION

public static final String MODIFIER_EXTENSION

See Also:

• Constant Field Values

Constructor Details

RDFParser

public RDFParser(FhirContext context,
 IParserErrorHandler parserErrorHandler,
 org.apache.jena.riot.Lang lang)

Do not use this constructor, the recommended way to obtain a new instance of the RDF parser is to invoke FhirContext.newRDFParser().

Parameters:

parserErrorHandler - the Parser Error Handler

Method Details

getEncoding

public EncodingEnum getEncoding()

Description copied from interface: IParser

Which encoding does this parser instance produce?

setPrettyPrint

public IParser setPrettyPrint(boolean prettyPrint)

Description copied from interface: IParser

Sets the "pretty print" flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.

Parameters:

prettyPrint - The flag

Returns:

Returns an instance of this parser so that method calls can be chained together

doEncodeResourceToWriter

protected void doEncodeResourceToWriter(IBaseResource resource,
 Writer writer,
 ca.uhn.fhir.parser.BaseParser.EncodeContext encodeContext)

Writes the provided resource to the writer. This should only be called for the top-level resource being encoded.

Specified by:

doEncodeResourceToWriter in class BaseParser

Parameters:

resource - FHIR resource for writing

writer - The writer to write to -- Note: Jena prefers streams over writers

encodeContext - encoding content from parent

doParseResource

protected <T extends IBaseResource> T doParseResource(Class<T> resourceType,
 Reader reader)
                                               throws DataFormatException

Parses RDF content to a FHIR resource using Apache Jena

Specified by:

doParseResource in class BaseParser

Type Parameters:

T - Type parameter denoting which resource is being parsed

Parameters:

resourceType - Class of FHIR resource being deserialized

reader - Reader containing RDF (turtle) content

Returns:

Populated FHIR resource

Throws:

DataFormatException - Exception that can be thrown from parser