ca.uhn.fhir.parser

Class XmlParser

java.lang.Object

ca.uhn.fhir.parser.BaseParser

ca.uhn.fhir.parser.XmlParser

All Implemented Interfaces:

IParser

public class XmlParser
extends BaseParser
implements IParser

This class is the FHIR XML parser/encoder. Users should not interact with this class directly, but should use FhirContext.newXmlParser() 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
XmlParser(FhirContext theContext, IParserErrorHandler theParserErrorHandler) Do not use this constructor, the recommended way to obtain a new instance of the XML parser is to invoke FhirContext.newXmlParser().

Method Summary

Modifier and Type	Method and Description
void	doEncodeBundleToWriter(Bundle theBundle, Writer theWriter)
void	doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, Reader theReader)
String	encodeBundleToString(Bundle theBundle)
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?
<T extends IBaseResource> Bundle	parseBundle(Class<T> theResourceType, Reader theReader) Parse a DSTU1 style Atom Bundle.
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, determineReferenceText, determineResourceBaseUrl, encodeBundleToWriter, encodeResourceToString, encodeResourceToWriter, encodeTagListToString, extractMetadataListNotNull, fixContainedResourceId, getEncodeElements, getEncodeElementsAppliesToResourceTypes, getErrorHandler, getMetaTagsForEncoding, getSuppressNarratives, isChildContained, isOmitResourceId, isStripVersionsFromReferences, isSummaryMode, isSuppressNarratives, parseBundle, parseBundle, parseResource, parseResource, parseResource, parseResource, parseTagList, preProcessValues, setEncodeElements, setEncodeElementsAppliesToResourceTypes, setOmitResourceId, setParserErrorHandler, setServerBaseUrl, setStripVersionsFromReferences, setSummaryMode, setSuppressNarratives, shouldAddSubsettedTag, 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

encodeBundleToWriter, encodeResourceToString, encodeResourceToWriter, encodeTagListToString, getEncodeElements, getEncodeElementsAppliesToResourceTypes, isOmitResourceId, isStripVersionsFromReferences, isSummaryMode, parseBundle, parseBundle, parseResource, parseResource, parseResource, parseResource, parseTagList, setEncodeElements, setEncodeElementsAppliesToResourceTypes, setOmitResourceId, setParserErrorHandler, setServerBaseUrl, setStripVersionsFromReferences, setSummaryMode, setSuppressNarratives

Constructor Detail

XmlParser

public XmlParser(FhirContext theContext,
                 IParserErrorHandler theParserErrorHandler)

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

Parameters:

theParserErrorHandler -

Method Detail

doEncodeBundleToWriter

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

Specified by:

doEncodeBundleToWriter in class BaseParser

Throws:

DataFormatException

doEncodeResourceToWriter

public void doEncodeResourceToWriter(IBaseResource theResource,
                                     Writer theWriter)
                              throws DataFormatException

Specified by:

doEncodeResourceToWriter in class BaseParser

Throws:

DataFormatException

doParseResource

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

Specified by:

doParseResource in class BaseParser

encodeBundleToString

public String encodeBundleToString(Bundle theBundle)
                            throws DataFormatException

Specified by:

encodeBundleToString in interface IParser

Overrides:

encodeBundleToString in class BaseParser

Throws:

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

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

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

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