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

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	doEncodeBundleToJsonLikeWriter(Bundle theBundle, JsonLikeWriter theEventWriter)
void	doEncodeBundleToWriter(Bundle theBundle, Writer theWriter)
void	doEncodeResourceToJsonLikeWriter(IBaseResource theResource, JsonLikeWriter theEventWriter)
protected void	doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, JsonLikeStructure theJsonStructure)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, Reader theReader)
void	encodeBundleToJsonLikeWriter(Bundle theBundle, JsonLikeWriter theJsonLikeWriter)
void	encodeResourceToJsonLikeWriter(IBaseResource theResource, JsonLikeWriter theJsonLikeWriter)
void	encodeTagListToJsonLikeWriter(TagList theTagList, JsonLikeWriter theEventWriter)
void	encodeTagListToWriter(TagList theTagList, Writer theWriter) Encodes a tag list, as defined in the FHIR Specification.
EncodingEnum	getEncoding() Which encoding does this parser instance produce?
static com.google.gson.Gson	newGson()
<T extends IBaseResource> Bundle	parseBundle(Class<T> theResourceType, JsonLikeStructure theJsonStructure) Parse a DSTU1 style Atom Bundle.
<T extends IBaseResource> Bundle	parseBundle(Class<T> theResourceType, Reader theReader) Parse a DSTU1 style Atom Bundle.
Bundle	parseBundle(JsonLikeStructure theJsonLikeStructure) Parse a DSTU1 style Atom Bundle.
<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
TagList	parseTagList(JsonLikeStructure theJsonStructure) Parses a tag list from a JSON-like data structure
TagList	parseTagList(Reader theReader) Parses a tag list, as defined in the FHIR Specification.
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, encodeBundleToString, encodeBundleToWriter, encodeResourceToString, encodeResourceToWriter, encodeTagListToString, extractMetadataListNotNull, fixContainedResourceId, getCompositeElementId, getDontStripVersionsFromReferencesAtPaths, getEncodeElements, getEncodeElementsAppliesToResourceTypes, getEncodeForceResourceId, getErrorHandler, getExtensionUrl, getMetaTagsForEncoding, getOverrideResourceIdWithBundleEntryFullUrl, getPreferTypes, getProfileTagsForEncoding, getServerBaseUrl, getStripVersionsFromReferences, getSuppressNarratives, isChildContained, isOmitResourceId, isSummaryMode, isSuppressNarratives, parseBundle, parseBundle, parseResource, parseResource, parseResource, parseResource, parseTagList, preProcessValues, setDontEncodeElements, setDontStripVersionsFromReferencesAtPaths, setDontStripVersionsFromReferencesAtPaths, setEncodeElements, setEncodeElementsAppliesToResourceTypes, setEncodeForceResourceId, setOmitResourceId, setOverrideResourceIdWithBundleEntryFullUrl, setParserErrorHandler, setPreferTypes, setServerBaseUrl, setStripVersionsFromReferences, setSummaryMode, setSuppressNarratives, shouldAddSubsettedTag, 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

encodeBundleToString, encodeBundleToWriter, encodeResourceToString, encodeResourceToWriter, encodeTagListToString, getDontStripVersionsFromReferencesAtPaths, getEncodeElements, getEncodeElementsAppliesToResourceTypes, getEncodeForceResourceId, getOverrideResourceIdWithBundleEntryFullUrl, getPreferTypes, getStripVersionsFromReferences, isOmitResourceId, isSummaryMode, parseBundle, parseBundle, parseResource, parseResource, parseResource, parseResource, parseTagList, setDontEncodeElements, setDontStripVersionsFromReferencesAtPaths, setDontStripVersionsFromReferencesAtPaths, setEncodeElements, setEncodeElementsAppliesToResourceTypes, 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

doEncodeBundleToWriter

public void doEncodeBundleToWriter(Bundle theBundle,
                                   Writer theWriter)
                            throws IOException

Specified by:

doEncodeBundleToWriter in class BaseParser

Throws:

IOException

doEncodeBundleToJsonLikeWriter

public void doEncodeBundleToJsonLikeWriter(Bundle theBundle,
                                           JsonLikeWriter theEventWriter)
                                    throws IOException

Throws:

IOException

doEncodeResourceToWriter

protected void doEncodeResourceToWriter(IBaseResource theResource,
                                        Writer theWriter)
                                 throws IOException

Specified by:

doEncodeResourceToWriter in class BaseParser

Throws:

IOException

doEncodeResourceToJsonLikeWriter

public void doEncodeResourceToJsonLikeWriter(IBaseResource theResource,
                                             JsonLikeWriter theEventWriter)
                                      throws IOException

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)

encodeBundleToJsonLikeWriter

public void encodeBundleToJsonLikeWriter(Bundle theBundle,
                                         JsonLikeWriter theJsonLikeWriter)
                                  throws IOException,
                                         DataFormatException

Specified by:

encodeBundleToJsonLikeWriter in interface IJsonLikeParser

Throws:

IOException

DataFormatException

encodeResourceToJsonLikeWriter

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

Specified by:

encodeResourceToJsonLikeWriter in interface IJsonLikeParser

Throws:

IOException

DataFormatException

encodeTagListToWriter

public void encodeTagListToWriter(TagList theTagList,
                                  Writer theWriter)
                           throws IOException

Description copied from interface: IParser

Encodes a tag list, as defined in the FHIR Specification.

Specified by:

encodeTagListToWriter in interface IParser

Parameters:

theTagList - The tag list to encode. Must not be null.

theWriter - The writer to encode to

Throws:

IOException

encodeTagListToJsonLikeWriter

public void encodeTagListToJsonLikeWriter(TagList theTagList,
                                          JsonLikeWriter theEventWriter)
                                   throws IOException

Specified by:

encodeTagListToJsonLikeWriter in interface IJsonLikeParser

Throws:

IOException

getEncoding

public EncodingEnum getEncoding()

Description copied from interface: IParser

Which encoding does this parser instance produce?

Specified by:

getEncoding in interface IParser

parseBundle

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

Description copied from interface: IParser

Parse a DSTU1 style Atom Bundle. Note that as of DSTU2, Bundle is a resource so you should use IParser.parseResource(Class, Reader) with the Bundle class found in the ca.uhn.hapi.fhir.model.[version].resource package instead.

Specified by:

parseBundle in interface IParser

parseBundle

public Bundle parseBundle(JsonLikeStructure theJsonLikeStructure)
                   throws DataFormatException

Description copied from interface: IJsonLikeParser

Parse a DSTU1 style Atom Bundle. Note that as of DSTU2, Bundle is a resource so you should use IJsonLikeParser.parseResource(Class, JsonLikeStructure) with the Bundle class found in the ca.uhn.hapi.fhir.model.[version].resource package instead.

Specified by:

parseBundle in interface IJsonLikeParser

Throws:

DataFormatException

parseBundle

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

Description copied from interface: IJsonLikeParser

Parse a DSTU1 style Atom Bundle. Note that as of DSTU2, Bundle is a resource so you should use IJsonLikeParser.parseResource(Class, JsonLikeStructure) with the Bundle class found in the ca.uhn.hapi.fhir.model.[version].resource package instead.

Specified by:

parseBundle in interface IJsonLikeParser

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

parseTagList

public TagList parseTagList(Reader theReader)

Description copied from interface: IParser

Parses a tag list, as defined in the FHIR Specification.

Specified by:

parseTagList in interface IParser

Parameters:

theReader - A reader which will supply a tag list

Returns:

A parsed tag list

parseTagList

public TagList parseTagList(JsonLikeStructure theJsonStructure)

Description copied from interface: IJsonLikeParser

Parses a tag list from a JSON-like data structure

Specified by:

parseTagList in interface IJsonLikeParser

Parameters:

theJsonStructure - The JSON-like structure to parse

Returns:

A parsed tag list

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