Package 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

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

Field Summary

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

RESOURCE_CREATED_BY_PARSER

Constructor Summary

Constructors

Constructor	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	Description
void	doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter, ca.uhn.fhir.parser.BaseParser.EncodeContext theEncodeContext)
protected void	doEncodeToWriter(IBase theElement, Writer theWriter, ca.uhn.fhir.parser.BaseParser.EncodeContext theEncodeContext)
protected void	doParseIntoComplexStructure(Reader theSource, IBase theTarget)
<T extends IBaseResource> T	doParseResource(Class<T> theResourceType, Reader theReader)
EncodingEnum	getEncoding()	Which encoding does this parser instance produce?
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, containResourcesInReferences, 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, parseInto, 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

parseInto, setDontEncodeElements, setEncodeElements

Constructor Details

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 Details

doEncodeResourceToWriter

public void doEncodeResourceToWriter(IBaseResource theResource,
 Writer theWriter,
 ca.uhn.fhir.parser.BaseParser.EncodeContext theEncodeContext)
                              throws DataFormatException

Specified by:

doEncodeResourceToWriter in class BaseParser

Throws:

DataFormatException

doEncodeToWriter

protected void doEncodeToWriter(IBase theElement,
 Writer theWriter,
 ca.uhn.fhir.parser.BaseParser.EncodeContext theEncodeContext)
                         throws DataFormatException

Overrides:

doEncodeToWriter in class BaseParser

Throws:

DataFormatException

doParseIntoComplexStructure

protected void doParseIntoComplexStructure(Reader theSource,
 IBase theTarget)

Overrides:

doParseIntoComplexStructure in class BaseParser

doParseResource

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

Specified by:

doParseResource in class BaseParser

getEncoding

public EncodingEnum getEncoding()

Description copied from interface: IParser

Which encoding does this parser instance produce?

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.

Parameters:

thePrettyPrint - The flag

Returns:

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