
Class BaseParser
- java.lang.Object
-
- ca.uhn.fhir.parser.BaseParser
-
- All Implemented Interfaces:
IParser
- Direct Known Subclasses:
JsonParser
,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 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
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Iterable<BaseParser.CompositeChildElement>
compositeChildIterator(IBase theCompositeElement, boolean theContainedResource, BaseParser.CompositeChildElement theParent, BaseParser.EncodeContext theEncodeContext)
protected void
containResourcesForEncoding(IBaseResource theResource)
protected abstract void
doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter, BaseParser.EncodeContext theEncodeContext)
protected abstract <T extends IBaseResource>
TdoParseResource(Class<T> theResourceType, Reader theReader)
String
encodeResourceToString(IBaseResource theResource)
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 void
findBaseReferences(List<IBaseReference> allElements, IBase theElement, BaseRuntimeElementDefinition<?> theDefinition)
A customised traversal of the tree to find the 'top level' base references.protected IIdType
fixContainedResourceId(String theValue)
protected List<IBaseReference>
getAllBaseReferences(IBaseResource theResource)
protected String
getCompositeElementId(IBase theElement)
Set<String>
getDontStripVersionsFromReferencesAtPaths()
Returns the value supplied toIParser.setDontStripVersionsFromReferencesAtPaths(String...)
ornull
if no value has been set for this parser (in which case the default from theParserOptions
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 parserprotected 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 usingIParser.setPreferTypes(List)
protected <T extends IPrimitiveType<String>>
List<T>getProfileTagsForEncoding(IBaseResource theResource, List<T> theProfiles)
protected String
getServerBaseUrl()
Boolean
getStripVersionsFromReferences()
If set totrue
(which is the default), resource references containing a version will have the version removed when the resource is encoded.
boolean
getSuppressNarratives()
Deprecated.protected boolean
isChildContained(BaseRuntimeElementDefinition<?> childDef, boolean theIncludedResource)
boolean
isEncodeElementsAppliesToChildResourcesOnly()
If set totrue
(default is false), the values supplied toIParser.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.boolean
isOmitResourceId()
Returns true if resource IDs should be omittedboolean
isSummaryMode()
Is the parser in "summary mode"? SeeIParser.setSummaryMode(boolean)
for informationboolean
isSuppressNarratives()
If set totrue
(default isfalse
), narratives will not be included in the encoded values.IBaseResource
parseResource(InputStream theInputStream)
Parses a resourceIBaseResource
parseResource(Reader theReader)
Parses a resource<T extends IBaseResource>
TparseResource(Class<T> theResourceType, InputStream theInputStream)
Parses a resource<T extends IBaseResource>
TparseResource(Class<T> theResourceType, Reader theReader)
Parses a resource<T extends IBaseResource>
TparseResource(Class<T> theResourceType, String theMessageString)
Parses a resourceIBaseResource
parseResource(String theMessageString)
Parses a resourceprotected List<? extends IBase>
preProcessValues(BaseRuntimeChildDefinition theMetaChildUncast, IBaseResource theResource, List<? extends IBase> theValues, BaseParser.CompositeChildElement theCompositeChildElement, BaseParser.EncodeContext theEncodeContext)
IParser
setDontEncodeElements(Set<String> theDontEncodeElements)
If provided, specifies the elements which should NOT be encoded.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.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
setEncodeElements(Set<String> theEncodeElements)
If provided, specifies the elements which should be encoded, to the exclusion of all others.void
setEncodeElementsAppliesToChildResourcesOnly(boolean theEncodeElementsAppliesToChildResourcesOnly)
If set totrue
(default is false), the values supplied toIParser.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.BaseParser
setEncodeForceResourceId(IIdType theEncodeForceResourceId)
When encoding, force this resource ID to be encoded as the resource IDIParser
setOmitResourceId(boolean theOmitResourceId)
If set totrue
(default isfalse
) the ID of any resources being encoded will not be included in the output.IParser
setOverrideResourceIdWithBundleEntryFullUrl(Boolean theOverrideResourceIdWithBundleEntryFullUrl)
If set totrue
(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 foundvoid
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
setServerBaseUrl(String theUrl)
Sets the server's base URL used by this parser.IParser
setStripVersionsFromReferences(Boolean theStripVersionsFromReferences)
If set totrue
(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 totrue
(default isfalse
) only elements marked by the FHIR specification as being "summary elements" will be included.IParser
setSuppressNarratives(boolean theSuppressNarratives)
If set totrue
(default isfalse
), narratives will not be included in the encoded values.protected boolean
shouldAddSubsettedTag(BaseParser.EncodeContext theEncodeContext)
protected boolean
shouldEncodePath(IResource theResource, String thePath)
Used for DSTU2 onlyprotected boolean
shouldEncodeResource(String theName)
protected boolean
shouldEncodeResourceId(IBaseResource theResource, BaseParser.EncodeContext theEncodeContext)
protected boolean
shouldEncodeResourceMeta(IResource theResource)
Used for DSTU2 onlyprotected void
throwExceptionForUnknownChildType(BaseRuntimeChildDefinition nextChild, Class<? extends IBase> theType)
-
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 Detail
-
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 auser data
property with this key.- Since:
- 5.0.0
-
-
Constructor Detail
-
BaseParser
public BaseParser(FhirContext theContext, IParserErrorHandler theParserErrorHandler)
Constructor
-
-
Method Detail
-
setDontEncodeElements
public IParser setDontEncodeElements(Set<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 asPatient.meta.lastUpdated
will only work in DSTU3+ mode.- Specified by:
setDontEncodeElements
in interfaceIParser
- 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 interfaceIParser
- Parameters:
theEncodeElements
- The elements to encode- See Also:
IParser.setDontEncodeElements(Set)
-
compositeChildIterator
protected Iterable<BaseParser.CompositeChildElement> compositeChildIterator(IBase theCompositeElement, boolean theContainedResource, BaseParser.CompositeChildElement theParent, BaseParser.EncodeContext theEncodeContext)
-
containResourcesForEncoding
protected void containResourcesForEncoding(IBaseResource theResource)
-
getAllBaseReferences
protected List<IBaseReference> getAllBaseReferences(IBaseResource theResource)
-
findBaseReferences
protected void findBaseReferences(List<IBaseReference> allElements, IBase theElement, BaseRuntimeElementDefinition<?> theDefinition)
A customised traversal of the tree to find the 'top level' base references. Nested references are found via the recursive traversal of contained resources.
-
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 interfaceIParser
- Throws:
DataFormatException
-
encodeResourceToWriter
public final void encodeResourceToWriter(IBaseResource theResource, Writer theWriter) throws IOException, DataFormatException
- Specified by:
encodeResourceToWriter
in interfaceIParser
- 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 toIParser.setDontStripVersionsFromReferencesAtPaths(String...)
ornull
if no value has been set for this parser (in which case the default from theParserOptions
will be used}- Specified by:
getDontStripVersionsFromReferencesAtPaths
in interfaceIParser
- 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 interfaceIParser
-
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 interfaceIParser
-
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 usingIParser.setPreferTypes(List)
- Specified by:
getPreferTypes
in interfaceIParser
- 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 interfaceIParser
- Parameters:
thePreferTypes
- The preferred types, ornull
-
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 totrue
(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 interfaceIParser
- 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 theParserOptions
will be used (default istrue
) - See Also:
ParserOptions
-
getSuppressNarratives
@Deprecated public boolean getSuppressNarratives()
Deprecated.If set totrue
(default isfalse
), 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 totrue
(default is false), the values supplied toIParser.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 interfaceIParser
-
setEncodeElementsAppliesToChildResourcesOnly
public void setEncodeElementsAppliesToChildResourcesOnly(boolean theEncodeElementsAppliesToChildResourcesOnly)
Description copied from interface:IParser
If set totrue
(default is false), the values supplied toIParser.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 interfaceIParser
-
isOmitResourceId
public boolean isOmitResourceId()
Description copied from interface:IParser
Returns true if resource IDs should be omitted- Specified by:
isOmitResourceId
in interfaceIParser
- See Also:
IParser.setOmitResourceId(boolean)
-
isSummaryMode
public boolean isSummaryMode()
Description copied from interface:IParser
Is the parser in "summary mode"? SeeIParser.setSummaryMode(boolean)
for information- Specified by:
isSummaryMode
in interfaceIParser
-
isSuppressNarratives
public boolean isSuppressNarratives()
If set totrue
(default isfalse
), 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 interfaceIParser
- 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
orIAnyResource
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 interfaceIParser
- 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 interfaceIParser
- 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 interfaceIParser
- 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 interfaceIParser
- 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
orIAnyResource
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 reasonConfigurationException
-
parseResource
public IBaseResource parseResource(String theMessageString) throws ConfigurationException, DataFormatException
Description copied from interface:IParser
Parses a resource- Specified by:
parseResource
in interfaceIParser
- Parameters:
theMessageString
- The string to parse- Returns:
- A parsed resource. Note that the returned object will be an instance of
IResource
orIAnyResource
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 reasonConfigurationException
-
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 ifIParser.setStripVersionsFromReferences(Boolean)
has been set totrue
(which is the default)- Specified by:
setDontStripVersionsFromReferencesAtPaths
in interfaceIParser
- 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 tonull
to use the value set in theParserOptions
- 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 ifIParser.setStripVersionsFromReferences(Boolean)
has been set totrue
(which is the default)- Specified by:
setDontStripVersionsFromReferencesAtPaths
in interfaceIParser
- 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 tonull
to use the value set in theParserOptions
- 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 totrue
(default isfalse
) 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 totrue
, 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 interfaceIParser
- 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 totrue
(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 tofalse
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 interfaceIParser
- Parameters:
theOverrideResourceIdWithBundleEntryFullUrl
- Set this tofalse
to prevent the parser from overriding resource ids with the Bundle.entry.fullUrl (ornull
to apply the default setting from theParserOptions
)- 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 interfaceIParser
- 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 interfaceIParser
- 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 totrue
(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 interfaceIParser
- Parameters:
theStripVersionsFromReferences
- Set this tofalse
to prevent the parser from removing resource versions from references (or
null
to apply the default setting from theParserOptions
- 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 totrue
(default isfalse
) only elements marked by the FHIR specification as being "summary elements" will be included.- Specified by:
setSummaryMode
in interfaceIParser
- 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 totrue
(default isfalse
), narratives will not be included in the encoded values.- Specified by:
setSuppressNarratives
in interfaceIParser
-
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)
-
extractMetadataListNotNull
protected static <T> List<T> extractMetadataListNotNull(IResource resource, ResourceMetadataKeyEnum<List<T>> key)
-
-