ca.uhn.fhir.parser

Class JsonParser

java.lang.Object

ca.uhn.fhir.parser.BaseParser

ca.uhn.fhir.parser.JsonParser

All Implemented Interfaces:

IJsonLikeParser, IParser

public class JsonParser
extends BaseParser
implements IJsonLikeParser

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

Nested Class Summary

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

BaseParser.CompositeChildElement, BaseParser.ElementsPath, BaseParser.EncodeContext, BaseParser.EncodeContextPath, BaseParser.EncodeContextPathElement

Constructor Summary

Constructors

Constructor and Description
JsonParser(FhirContext theContext, IParserErrorHandler theParserErrorHandler) Do not use this constructor, the recommended way to obtain a new instance of the JSON parser is to invoke FhirContext.newJsonParser().

Method Summary

Modifier and Type	Method and Description
void	doEncodeResourceToJsonLikeWriter(IBaseResource theResource, JsonLikeWriter theEventWriter, BaseParser.EncodeContext theEncodeContext)
protected void	doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter, BaseParser.EncodeContext theEncodeContext)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, JsonLikeStructure theJsonStructure)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, Reader theReader)
void	encodeResourceToJsonLikeWriter(IBaseResource theResource, JsonLikeWriter theJsonLikeWriter)
EncodingEnum	getEncoding() Which encoding does this parser instance produce?
static com.google.gson.Gson	newGson()
<T extends IBaseResource> T	parseResource(Class<T> theResourceType, JsonLikeStructure theJsonLikeStructure) Parses a resource from a JSON-like data structure
IBaseResource	parseResource(JsonLikeStructure theJsonLikeStructure) Parses a resource from a JSON-like data structure
IParser	setPrettyPrint(boolean thePrettyPrint) 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, containResourcesForEncoding, encodeResourceToString, encodeResourceToWriter, encodeResourceToWriter, extractMetadataListNotNull, fixContainedResourceId, getCompositeElementId, getDontStripVersionsFromReferencesAtPaths, getEncodeForceResourceId, getErrorHandler, getExtensionMetadataKeys, getExtensionUrl, getMetaTagsForEncoding, getOverrideResourceIdWithBundleEntryFullUrl, 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

encodeResourceToString, encodeResourceToWriter, getDontStripVersionsFromReferencesAtPaths, getEncodeForceResourceId, getOverrideResourceIdWithBundleEntryFullUrl, getPreferTypes, getStripVersionsFromReferences, isEncodeElementsAppliesToChildResourcesOnly, isOmitResourceId, isSummaryMode, parseResource, parseResource, parseResource, parseResource, parseResource, parseResource, setDontEncodeElements, setDontStripVersionsFromReferencesAtPaths, setDontStripVersionsFromReferencesAtPaths, setEncodeElements, setEncodeElementsAppliesToChildResourcesOnly, setEncodeForceResourceId, setOmitResourceId, setOverrideResourceIdWithBundleEntryFullUrl, setParserErrorHandler, setPreferTypes, setServerBaseUrl, setStripVersionsFromReferences, setSummaryMode, setSuppressNarratives

Constructor Detail

JsonParser

public JsonParser(FhirContext theContext,
                  IParserErrorHandler theParserErrorHandler)

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

Parameters:

theParserErrorHandler -

Method Detail

doEncodeResourceToJsonLikeWriter

public void doEncodeResourceToJsonLikeWriter(IBaseResource theResource,
                                             JsonLikeWriter theEventWriter,
                                             BaseParser.EncodeContext theEncodeContext)
                                      throws IOException

Throws:

IOException

doEncodeResourceToWriter

protected void doEncodeResourceToWriter(IBaseResource theResource,
                                        Writer theWriter,
                                        BaseParser.EncodeContext theEncodeContext)
                                 throws IOException

Specified by:

doEncodeResourceToWriter in class BaseParser

Throws:

IOException

doParseResource

public <T extends IBaseResource> T doParseResource(Class<T> theResourceType,
                                                   Reader theReader)

Specified by:

doParseResource in class BaseParser

doParseResource

public <T extends IBaseResource> T doParseResource(Class<T> theResourceType,
                                                   JsonLikeStructure theJsonStructure)

encodeResourceToJsonLikeWriter

public void encodeResourceToJsonLikeWriter(IBaseResource theResource,
                                           JsonLikeWriter theJsonLikeWriter)
                                    throws IOException,
                                           DataFormatException

Specified by:

encodeResourceToJsonLikeWriter in interface IJsonLikeParser

Throws:

IOException

DataFormatException

getEncoding

public EncodingEnum getEncoding()

Description copied from interface: IParser

Which encoding does this parser instance produce?

Specified by:

getEncoding in interface IParser

parseResource

public <T extends IBaseResource> T parseResource(Class<T> theResourceType,
                                                 JsonLikeStructure theJsonLikeStructure)
                                          throws DataFormatException

Description copied from interface: IJsonLikeParser

Parses a resource from a JSON-like data structure

Specified by:

parseResource in interface IJsonLikeParser

Parameters:

theResourceType - The resource type to use. This can be used to explicitly specify a class which extends a built-in type (e.g. a custom type extending the default Patient class)

theJsonLikeStructure - The JSON-like structure to parse

Returns:

A parsed resource

Throws:

DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason

parseResource

public IBaseResource parseResource(JsonLikeStructure theJsonLikeStructure)
                            throws DataFormatException

Description copied from interface: IJsonLikeParser

Parses a resource from a JSON-like data structure

Specified by:

parseResource in interface IJsonLikeParser

Parameters:

theJsonLikeStructure - The JSON-like structure to parse

Returns:

A parsed resource. Note that the returned object will be an instance of IResource or IAnyResource depending on the specific FhirContext which created this parser.

Throws:

DataFormatException - If the resource can not be parsed because the data is not recognized or invalid for any reason

setPrettyPrint

public IParser setPrettyPrint(boolean thePrettyPrint)

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.

Specified by:

setPrettyPrint in interface IParser

Parameters:

thePrettyPrint - The flag

Returns:

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

newGson

public static com.google.gson.Gson newGson()