Package ca.uhn.fhir.parser

Class BaseParser

java.lang.Object

ca.uhn.fhir.parser.BaseParser

All Implemented Interfaces:

IParser

Direct Known Subclasses:

JsonParser, NDJsonParser, RDFParser, XmlParser

public abstract class BaseParser
extends Object
implements IParser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BaseParser.CompositeChildElement
class	BaseParser.EncodeContext	EncodeContext is a shared state object that is passed around the encode process

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOURCE_CREATED_BY_PARSER	Any resources that were created by the parser (i.e.

Constructor Summary

Constructors

Constructor	Description
BaseParser(FhirContext theContext, IParserErrorHandler theParserErrorHandler)	Constructor

Method Summary

Modifier and Type	Method	Description
protected Iterable<BaseParser.CompositeChildElement>	compositeChildIterator(IBase theCompositeElement, boolean theContainedResource, BaseParser.CompositeChildElement theParent, BaseParser.EncodeContext theEncodeContext)
protected abstract void	doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter, BaseParser.EncodeContext theEncodeContext)
protected abstract <T extends IBaseResource> T	doParseResource(Class<T> theResourceType, Reader theReader)
String	encodeResourceToString(IBaseResource theResource)
final void	encodeResourceToWriter(IBaseResource theResource, Writer theWriter)
protected void	encodeResourceToWriter(IBaseResource theResource, Writer theWriter, BaseParser.EncodeContext theEncodeContext)
protected static <T> List<T>	extractMetadataListNotNull(IResource resource, ResourceMetadataKeyEnum<List<T>> key)
protected IIdType	fixContainedResourceId(String theValue)
protected String	getCompositeElementId(IBase theElement)
protected FhirContext	getContext()
Set<String>	getDontStripVersionsFromReferencesAtPaths()	Returns the value supplied to IParser.setDontStripVersionsFromReferencesAtPaths(String...) or null if no value has been set for this parser (in which case the default from the ParserOptions will be used}
IIdType	getEncodeForceResourceId()	If not set to null (as is the default) this ID will be used as the ID in any resources encoded by this parser
protected IParserErrorHandler	getErrorHandler()
protected List<Map.Entry<ResourceMetadataKeyEnum<?>,Object>>	getExtensionMetadataKeys(IResource resource)
protected String	getExtensionUrl(String extensionUrl)
protected TagList	getMetaTagsForEncoding(IResource theIResource, BaseParser.EncodeContext theEncodeContext)
List<Class<? extends IBaseResource>>	getPreferTypes()	Gets the preferred types, as set using IParser.setPreferTypes(List)
protected <T extends IPrimitiveType<String>> List<T>	getProfileTagsForEncoding(IBaseResource theResource, List<T> theProfiles)
protected String	getServerBaseUrl()
Boolean	getStripVersionsFromReferences()	If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded.

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

getEncoding, setPrettyPrint

Field Details

RESOURCE_CREATED_BY_PARSER

public static final String RESOURCE_CREATED_BY_PARSER

Any resources that were created by the parser (i.e. by parsing a serialized resource) will have a user data property with this key.

Since:

5.0.0

Constructor Details

BaseParser

public BaseParser(FhirContext theContext,
 IParserErrorHandler theParserErrorHandler)

Constructor

Method Details

getContext

protected FhirContext getContext()

setDontEncodeElements

public IParser setDontEncodeElements(Collection<String> theDontEncodeElements)

Description copied from interface: IParser

If provided, specifies the elements which should NOT be encoded. Valid values for this field would include:

• Patient - Don't encode patient and all its children
• Patient.name - Don't encode the patient's name
• Patient.name.family - Don't encode the patient's family name
• *.text - Don't encode the text element on any resource (only the very first position may contain a wildcard)

DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3+ mode.

Specified by:

setDontEncodeElements in interface IParser

Parameters:

theDontEncodeElements - The elements to encode

See Also:

• IParser.setEncodeElements(Set)

setEncodeElements

public IParser setEncodeElements(Set<String> theEncodeElements)

Description copied from interface: IParser

If provided, specifies the elements which should be encoded, to the exclusion of all others. Valid values for this field would include:

• Patient - Encode patient and all its children
• Patient.name - Encode only the patient's name
• Patient.name.family - Encode only the patient's family name
• *.text - Encode the text element on any resource (only the very first position may contain a wildcard)
• *.(mandatory) - This is a special case which causes any mandatory fields (min > 0) to be encoded

Specified by:

setEncodeElements in interface IParser

Parameters:

theEncodeElements - The elements to encode

See Also:

• IParser.setDontEncodeElements(Collection)

compositeChildIterator

protected Iterable<BaseParser.CompositeChildElement> compositeChildIterator(IBase theCompositeElement,
 boolean theContainedResource,
 BaseParser.CompositeChildElement theParent,
 BaseParser.EncodeContext theEncodeContext)

doEncodeResourceToWriter

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

Throws:

IOException

DataFormatException

doParseResource

protected abstract <T extends IBaseResource> T doParseResource(Class<T> theResourceType,
 Reader theReader)
                                                        throws DataFormatException

Throws:

DataFormatException

encodeResourceToString

public String encodeResourceToString(IBaseResource theResource)
                              throws DataFormatException

Specified by:

encodeResourceToString in interface IParser

Throws:

DataFormatException

encodeResourceToWriter

public final void encodeResourceToWriter(IBaseResource theResource,
 Writer theWriter)
                                  throws IOException,
DataFormatException

Specified by:

encodeResourceToWriter in interface IParser

Throws:

IOException

DataFormatException

encodeResourceToWriter

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

Throws:

IOException

fixContainedResourceId

protected IIdType fixContainedResourceId(String theValue)

getCompositeElementId

protected String getCompositeElementId(IBase theElement)

getDontStripVersionsFromReferencesAtPaths

public Set<String> getDontStripVersionsFromReferencesAtPaths()

Description copied from interface: IParser

Returns the value supplied to IParser.setDontStripVersionsFromReferencesAtPaths(String...) or null if no value has been set for this parser (in which case the default from the ParserOptions will be used}

Specified by:

getDontStripVersionsFromReferencesAtPaths in interface IParser

See Also:

• IParser.setDontStripVersionsFromReferencesAtPaths(String...)
• IParser.setStripVersionsFromReferences(Boolean)
• ParserOptions

getEncodeForceResourceId

public IIdType getEncodeForceResourceId()

Description copied from interface: IParser

If not set to null (as is the default) this ID will be used as the ID in any resources encoded by this parser

Specified by:

getEncodeForceResourceId in interface IParser

setEncodeForceResourceId

public BaseParser setEncodeForceResourceId(IIdType theEncodeForceResourceId)

Description copied from interface: IParser

When encoding, force this resource ID to be encoded as the resource ID

Specified by:

setEncodeForceResourceId in interface IParser

getErrorHandler

protected IParserErrorHandler getErrorHandler()

getExtensionMetadataKeys

protected List<Map.Entry<ResourceMetadataKeyEnum<?>,Object>> getExtensionMetadataKeys(IResource resource)

getExtensionUrl

protected String getExtensionUrl(String extensionUrl)

getMetaTagsForEncoding

protected TagList getMetaTagsForEncoding(IResource theIResource,
 BaseParser.EncodeContext theEncodeContext)

getPreferTypes

public List<Class<? extends IBaseResource>> getPreferTypes()

Description copied from interface: IParser

Gets the preferred types, as set using IParser.setPreferTypes(List)

Specified by:

getPreferTypes in interface IParser

Returns:

Returns the preferred types, or null

See Also:

• IParser.setPreferTypes(List)

setPreferTypes

public void setPreferTypes(List<Class<? extends IBaseResource>> thePreferTypes)

Description copied from interface: IParser

If set, when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type.

This feature is related to, but not the same as the FhirContext.setDefaultTypeForProfile(String, Class) feature. setDefaultTypeForProfile is used to specify a type to be used when a resource explicitly declares support for a given profile. This feature specifies a type to be used irrespective of the profile declaration in the metadata statement.

Specified by:

setPreferTypes in interface IParser

Parameters:

thePreferTypes - The preferred types, or null

getProfileTagsForEncoding

protected <T extends IPrimitiveType<String>>
List<T> getProfileTagsForEncoding(IBaseResource theResource,
 List<T> theProfiles)

getServerBaseUrl

protected String getServerBaseUrl()

getStripVersionsFromReferences

public Boolean getStripVersionsFromReferences()

Description copied from interface: IParser

If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false.

Specified by:

getStripVersionsFromReferences in interface IParser

Returns:

Returns the parser instance's configuration setting for stripping versions from resource references when encoding. This method will retun null if no value is set, in which case the value from the ParserOptions will be used (default is true)

See Also:

• ParserOptions

getSuppressNarratives

@Deprecated
public boolean getSuppressNarratives()

Deprecated.

Use isSuppressNarratives()

If set to true (default is false), narratives will not be included in the encoded values.

isChildContained

protected boolean isChildContained(BaseRuntimeElementDefinition<?> childDef,
 boolean theIncludedResource)

isEncodeElementsAppliesToChildResourcesOnly

public boolean isEncodeElementsAppliesToChildResourcesOnly()

Description copied from interface: IParser

If set to true (default is false), the values supplied to IParser.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)

Specified by:

isEncodeElementsAppliesToChildResourcesOnly in interface IParser

setEncodeElementsAppliesToChildResourcesOnly

public void setEncodeElementsAppliesToChildResourcesOnly(boolean theEncodeElementsAppliesToChildResourcesOnly)

Description copied from interface: IParser

If set to true (default is false), the values supplied to IParser.setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)

Specified by:

setEncodeElementsAppliesToChildResourcesOnly in interface IParser

isOmitResourceId

public boolean isOmitResourceId()

Description copied from interface: IParser

Returns true if resource IDs should be omitted

Specified by:

isOmitResourceId in interface IParser

See Also:

• IParser.setOmitResourceId(boolean)

isSummaryMode

public boolean isSummaryMode()

Description copied from interface: IParser

Is the parser in "summary mode"? See IParser.setSummaryMode(boolean) for information

Specified by:

isSummaryMode in interface IParser

isSuppressNarratives

public boolean isSuppressNarratives()

If set to true (default is false), narratives will not be included in the encoded values.

Since:

1.2

parseResource

public IBaseResource parseResource(InputStream theInputStream)
                            throws DataFormatException

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

Parameters:

theInputStream - The InputStream to parse input from (charset is assumed to be UTF-8). Note that the stream will not be closed by the parser upon completion.

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

parseResource

public <T extends IBaseResource> T parseResource(Class<T> theResourceType,
 InputStream theInputStream)
                                          throws DataFormatException

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

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)

theInputStream - The InputStream to parse input from, with an implied charset of UTF-8. Note that the InputStream will not be closed by the parser upon completion.

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 <T extends IBaseResource> T parseResource(Class<T> theResourceType,
 Reader theReader)
                                          throws DataFormatException

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

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)

theReader - The reader to parse input from. Note that the Reader will not be closed by the parser upon completion.

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 <T extends IBaseResource> T parseResource(Class<T> theResourceType,
 String theMessageString)

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

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)

theMessageString - The string to parse

Returns:

A parsed resource

parseResource

public IBaseResource parseResource(Reader theReader)
                            throws ConfigurationException,
DataFormatException

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

Parameters:

theReader - The reader to parse input from. Note that the Reader will not be closed by the parser upon completion.

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

ConfigurationException

parseResource

public IBaseResource parseResource(String theMessageString)
                            throws ConfigurationException,
DataFormatException

Description copied from interface: IParser

Parses a resource

Specified by:

parseResource in interface IParser

Parameters:

theMessageString - The string 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

ConfigurationException

preProcessValues

protected List<? extends IBase> preProcessValues(BaseRuntimeChildDefinition theMetaChildUncast,
 IBaseResource theResource,
 List<? extends IBase> theValues,
 BaseParser.CompositeChildElement theCompositeChildElement,
 BaseParser.EncodeContext theEncodeContext)

setDontStripVersionsFromReferencesAtPaths

public IParser setDontStripVersionsFromReferencesAtPaths(String... thePaths)

Description copied from interface: IParser

If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process.

This method provides a finer-grained level of control than IParser.setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if IParser.setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

Specified by:

setDontStripVersionsFromReferencesAtPaths in interface IParser

Parameters:

thePaths - A collection of paths for which the resource versions will not be removed automatically when serializing, e.g. "Patient.managingOrganization" or "AuditEvent.object.reference". Note that only resource name and field names with dots separating is allowed here (no repetition indicators, FluentPath expressions, etc.). Set to null to use the value set in the ParserOptions

Returns:

Returns a reference to this parser so that method calls can be chained together

See Also:

• IParser.setStripVersionsFromReferences(Boolean)
• ParserOptions

setDontStripVersionsFromReferencesAtPaths

public IParser setDontStripVersionsFromReferencesAtPaths(Collection<String> thePaths)

Description copied from interface: IParser

If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process.

This method provides a finer-grained level of control than IParser.setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if IParser.setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

Specified by:

setDontStripVersionsFromReferencesAtPaths in interface IParser

Parameters:

thePaths - A collection of paths for which the resource versions will not be removed automatically when serializing, e.g. "Patient.managingOrganization" or "AuditEvent.object.reference". Note that only resource name and field names with dots separating is allowed here (no repetition indicators, FluentPath expressions, etc.). Set to null to use the value set in the ParserOptions

Returns:

Returns a reference to this parser so that method calls can be chained together

See Also:

• IParser.setStripVersionsFromReferences(Boolean)
• ParserOptions

setOmitResourceId

public IParser setOmitResourceId(boolean theOmitResourceId)

Description copied from interface: IParser

If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.

If the resource being encoded is a Bundle or Parameters resource, this setting only applies to the outer resource being encoded, not any resources contained wihthin.

Specified by:

setOmitResourceId in interface IParser

Parameters:

theOmitResourceId - Should resource IDs be omitted

Returns:

Returns a reference to this parser so that method calls can be chained together

setOverrideResourceIdWithBundleEntryFullUrl

public IParser setOverrideResourceIdWithBundleEntryFullUrl(Boolean theOverrideResourceIdWithBundleEntryFullUrl)

Description copied from interface: IParser

If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).

Specified by:

setOverrideResourceIdWithBundleEntryFullUrl in interface IParser

Parameters:

theOverrideResourceIdWithBundleEntryFullUrl - Set this to false to prevent the parser from overriding resource ids with the Bundle.entry.fullUrl (or null to apply the default setting from the ParserOptions)

Returns:

Returns a reference to this parser so that method calls can be chained together

See Also:

• ParserOptions

setParserErrorHandler

public IParser setParserErrorHandler(IParserErrorHandler theErrorHandler)

Description copied from interface: IParser

Registers an error handler which will be invoked when any parse errors are found

Specified by:

setParserErrorHandler in interface IParser

Parameters:

theErrorHandler - The error handler to set. Must not be null.

setServerBaseUrl

public IParser setServerBaseUrl(String theUrl)

Description copied from interface: IParser

Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base.

Specified by:

setServerBaseUrl in interface IParser

Parameters:

theUrl - The base URL, e.g. "http://example.com/base"

Returns:

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

setStripVersionsFromReferences

public IParser setStripVersionsFromReferences(Boolean theStripVersionsFromReferences)

Description copied from interface: IParser

If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false.

This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use IParser.setDontStripVersionsFromReferencesAtPaths(String...)

Specified by:

setStripVersionsFromReferences in interface IParser

Parameters:

theStripVersionsFromReferences - Set this to false to prevent the parser from removing resource versions from references (or null to apply the default setting from the ParserOptions

Returns:

Returns a reference to this parser so that method calls can be chained together

See Also:

• IParser.setDontStripVersionsFromReferencesAtPaths(String...)
• ParserOptions

setSummaryMode

public IParser setSummaryMode(boolean theSummaryMode)

Description copied from interface: IParser

If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.

Specified by:

setSummaryMode in interface IParser

Returns:

Returns a reference to this parser so that method calls can be chained together

setSuppressNarratives

public IParser setSuppressNarratives(boolean theSuppressNarratives)

Description copied from interface: IParser

If set to true (default is false), narratives will not be included in the encoded values.

Specified by:

setSuppressNarratives in interface IParser

shouldAddSubsettedTag

protected boolean shouldAddSubsettedTag(BaseParser.EncodeContext theEncodeContext)

shouldEncodeResourceId

protected boolean shouldEncodeResourceId(IBaseResource theResource,
 BaseParser.EncodeContext theEncodeContext)

shouldEncodeResourceMeta

protected boolean shouldEncodeResourceMeta(IResource theResource)

Used for DSTU2 only

shouldEncodePath

protected boolean shouldEncodePath(IResource theResource,
 String thePath)

Used for DSTU2 only

throwExceptionForUnknownChildType

protected void throwExceptionForUnknownChildType(BaseRuntimeChildDefinition nextChild,
 Class<? extends IBase> theType)

shouldEncodeResource

protected boolean shouldEncodeResource(String theName)

isFhirVersionLessThanOrEqualTo

protected boolean isFhirVersionLessThanOrEqualTo(FhirVersionEnum theFhirVersionEnum)

extractMetadataListNotNull

protected static <T> List<T> extractMetadataListNotNull(IResource resource,
 ResourceMetadataKeyEnum<List<T>> key)