ca.uhn.fhir.parser

Interface IParser

All Known Subinterfaces:

IJsonLikeParser

All Known Implementing Classes:

BaseParser, JsonParser, XmlParser

public interface IParser

A parser, which can be used to convert between HAPI FHIR model/structure objects, and their respective String wire formats, in either XML or JSON.

Thread safety: Parsers are not guaranteed to be thread safe. Create a new parser instance for every thread or every message being parsed/encoded.

Method Summary

Modifier and Type	Method and Description
String	encodeResourceToString(IBaseResource theResource)
void	encodeResourceToWriter(IBaseResource theResource, Writer theWriter)
Set<String>	getDontStripVersionsFromReferencesAtPaths() Returns the value supplied to setDontStripVersionsFromReferencesAtPaths(String...) or null if no value has been set for this parser (in which case the default from the ParserOptions will be used}
Set<String>	getEncodeElements() See setEncodeElements(Set)
Set<String>	getEncodeElementsAppliesToResourceTypes() See setEncodeElementsAppliesToResourceTypes(Set)
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
EncodingEnum	getEncoding() Which encoding does this parser instance produce?
Boolean	getOverrideResourceIdWithBundleEntryFullUrl() 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.
List<Class<? extends IBaseResource>>	getPreferTypes() Gets the preferred types, as set using setPreferTypes(List)
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.
boolean	isOmitResourceId() Returns true if resource IDs should be omitted
boolean	isSummaryMode() Is the parser in "summary mode"? See setSummaryMode(boolean) for information
<T extends IBaseResource> T	parseResource(Class<T> theResourceType, Reader theReader) Parses a resource
<T extends IBaseResource> T	parseResource(Class<T> theResourceType, String theString) Parses a resource
IBaseResource	parseResource(Reader theReader) Parses a resource
IBaseResource	parseResource(String theMessageString) Parses a resource
void	setDontEncodeElements(Set<String> theDontEncodeElements) If provided, specifies the elements which should NOT be encoded.
IParser	setDontStripVersionsFromReferencesAtPaths(Collection<String> thePaths) 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.
IParser	setDontStripVersionsFromReferencesAtPaths(String... thePaths) 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.
void	setEncodeElements(Set<String> theEncodeElements) If provided, specifies the elements which should be encoded, to the exclusion of all others.
void	setEncodeElementsAppliesToResourceTypes(Set<String> theEncodeElementsAppliesToResourceTypes) If provided, tells the parse which resource types to apply encode elements to.
IParser	setEncodeForceResourceId(IIdType theForceResourceId) When encoding, force this resource ID to be encoded as the resource ID
IParser	setOmitResourceId(boolean theOmitResourceId) If set to true (default is false) the ID of any resources being encoded will not be included in the output.
IParser	setOverrideResourceIdWithBundleEntryFullUrl(Boolean theOverrideResourceIdWithBundleEntryFullUrl) 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.
IParser	setParserErrorHandler(IParserErrorHandler theErrorHandler) Registers an error handler which will be invoked when any parse errors are found
void	setPreferTypes(List<Class<? extends IBaseResource>> thePreferTypes) 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).
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.
IParser	setServerBaseUrl(String theUrl) Sets the server's base URL used by this parser.
IParser	setStripVersionsFromReferences(Boolean theStripVersionsFromReferences) If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded.
IParser	setSummaryMode(boolean theSummaryMode) If set to true (default is false) only elements marked by the FHIR specification as being "summary elements" will be included.
IParser	setSuppressNarratives(boolean theSuppressNarratives) If set to true (default is false), narratives will not be included in the encoded values.

Method Detail

encodeResourceToString

String encodeResourceToString(IBaseResource theResource)
                       throws DataFormatException

Throws:

DataFormatException

encodeResourceToWriter

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

Throws:

IOException

DataFormatException

getEncodeElements

Set<String> getEncodeElements()

See setEncodeElements(Set)

getEncodeElementsAppliesToResourceTypes

Set<String> getEncodeElementsAppliesToResourceTypes()

See setEncodeElementsAppliesToResourceTypes(Set)

getEncodeForceResourceId

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

getEncoding

EncodingEnum getEncoding()

Which encoding does this parser instance produce?

getPreferTypes

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

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

Returns:

Returns the preferred types, or null

See Also:

setPreferTypes(List)

isOmitResourceId

boolean isOmitResourceId()

Returns true if resource IDs should be omitted

Since:

1.1

See Also:

setOmitResourceId(boolean)

getStripVersionsFromReferences

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. 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.

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

getOverrideResourceIdWithBundleEntryFullUrl

Boolean getOverrideResourceIdWithBundleEntryFullUrl()

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

Returns:

Returns the parser instance's configuration setting for overriding resource ids with Bundle.entry.fullUrl when parsing the source data into a Bundle object. This method will return null if no value is set, in which case the value from the ParserOptions will be used (default is true)

See Also:

ParserOptions

isSummaryMode

boolean isSummaryMode()

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

See Also:

#setSummaryMode(boolean)} for information

parseResource

<T extends IBaseResource> T parseResource(Class<T> theResourceType,
                                          Reader theReader)
                                   throws DataFormatException

Parses a resource

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

<T extends IBaseResource> T parseResource(Class<T> theResourceType,
                                          String theString)
                                   throws DataFormatException

Parses a resource

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)

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

IBaseResource parseResource(Reader theReader)
                     throws ConfigurationException,
                            DataFormatException

Parses a resource

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

IBaseResource parseResource(String theMessageString)
                     throws ConfigurationException,
                            DataFormatException

Parses a resource

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

setDontEncodeElements

void setDontEncodeElements(Set<String> theDontEncodeElements)

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.

Parameters:

theDontEncodeElements - The elements to encode

See Also:

setEncodeElements(Set)

setEncodeElements

void setEncodeElements(Set<String> theEncodeElements)

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

Parameters:

theEncodeElements - The elements to encode

See Also:

setDontEncodeElements(Set)

setEncodeElementsAppliesToResourceTypes

void setEncodeElementsAppliesToResourceTypes(Set<String> theEncodeElementsAppliesToResourceTypes)

If provided, tells the parse which resource types to apply encode elements to. Any resource types not specified here will be encoded completely, with no elements excluded.

Parameters:

theEncodeElementsAppliesToResourceTypes -

setEncodeForceResourceId

IParser setEncodeForceResourceId(IIdType theForceResourceId)

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

setOmitResourceId

IParser setOmitResourceId(boolean theOmitResourceId)

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.

Parameters:

theOmitResourceId - Should resource IDs be omitted

Returns:

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

Since:

1.1

setParserErrorHandler

IParser setParserErrorHandler(IParserErrorHandler theErrorHandler)

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

Parameters:

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

setPreferTypes

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

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.

Parameters:

thePreferTypes - The preferred types, or null

setPrettyPrint

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.

Parameters:

thePrettyPrint - The flag

Returns:

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

setServerBaseUrl

IParser setServerBaseUrl(String theUrl)

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.

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

IParser setStripVersionsFromReferences(Boolean theStripVersionsFromReferences)

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 setDontStripVersionsFromReferencesAtPaths(String...)

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:

setDontStripVersionsFromReferencesAtPaths(String...), ParserOptions

setOverrideResourceIdWithBundleEntryFullUrl

IParser setOverrideResourceIdWithBundleEntryFullUrl(Boolean theOverrideResourceIdWithBundleEntryFullUrl)

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

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

setSummaryMode

IParser setSummaryMode(boolean theSummaryMode)

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

Returns:

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

setSuppressNarratives

IParser setSuppressNarratives(boolean theSuppressNarratives)

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

setDontStripVersionsFromReferencesAtPaths

IParser setDontStripVersionsFromReferencesAtPaths(String... thePaths)

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 setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

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:

setStripVersionsFromReferences(Boolean), ParserOptions

setDontStripVersionsFromReferencesAtPaths

IParser setDontStripVersionsFromReferencesAtPaths(Collection<String> thePaths)

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 setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)

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:

setStripVersionsFromReferences(Boolean), ParserOptions

getDontStripVersionsFromReferencesAtPaths

Set<String> getDontStripVersionsFromReferencesAtPaths()

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

See Also:

setDontStripVersionsFromReferencesAtPaths(String...), setStripVersionsFromReferences(Boolean), ParserOptions