BaseParser (HAPI FHIR - Core Library 1.4 API)

java.lang.Object
- ca.uhn.fhir.parser.BaseParser

All Implemented Interfaces:

IParser

Direct Known Subclasses:

JsonParser, XmlParser
```
public abstract class BaseParser
extends Object
implements IParser
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class BaseParser.CompositeChildElement

Nested Classes
Modifier and Type	Class and Description
`protected class`	`BaseParser.CompositeChildElement`

Constructor Summary

Constructors
Constructor and Description

BaseParser(FhirContext theContext, IParserErrorHandler theParserErrorHandler)
Constructor

Constructors
Constructor and 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 and Description
`protected Iterable<BaseParser.CompositeChildElement>`	`compositeChildIterator(List<? extends BaseRuntimeChildDefinition> theChildren, boolean theContainedResource, BaseParser.CompositeChildElement theParent)`
`protected void`	`containResourcesForEncoding(IBaseResource theResource)`
`protected String`	`determineReferenceText(IBaseReference theRef)`
`protected String`	`determineResourceBaseUrl(String bundleBaseUrl, BundleEntry theEntry)`
`protected abstract void`	`doEncodeBundleToWriter(Bundle theBundle, Writer theWriter)`
`protected abstract void`	`doEncodeResourceToWriter(IBaseResource theResource, Writer theWriter)`
`protected abstract <T extends IBaseResource> T`	`doParseResource(Class<T> theResourceType, Reader theReader)`
`String`	`encodeBundleToString(Bundle theBundle)`
`void`	`encodeBundleToWriter(Bundle theBundle, Writer theWriter)`
`String`	`encodeResourceToString(IBaseResource theResource)`
`void`	`encodeResourceToWriter(IBaseResource theResource, Writer theWriter)`
`String`	`encodeTagListToString(TagList theTagList)` Encodes a tag list, as defined in the FHIR Specification.
`protected static <T> List<T>`	`extractMetadataListNotNull(IResource resource, ResourceMetadataKeyEnum<List<T>> key)`
`protected String`	`fixContainedResourceId(String theValue)`
`Set<String>`	`getEncodeElements()` See `setEncodeElements(Set)`
`Set<String>`	`getEncodeElementsAppliesToResourceTypes()` See `setEncodeElementsAppliesToResourceTypes(Set)`
`protected IParserErrorHandler`	`getErrorHandler()`
`protected TagList`	`getMetaTagsForEncoding(IResource theIResource)`
`boolean`	`getSuppressNarratives()` Deprecated. Use `isSuppressNarratives()`
`protected boolean`	`isChildContained(BaseRuntimeElementDefinition<?> childDef, boolean theIncludedResource)`
`boolean`	`isOmitResourceId()` Returns true if resource IDs should be omitted
`boolean`	`isStripVersionsFromReferences()` If set to `true (which is the default), resource references containing a version will have the version removed when the resource is encoded.`
`boolean`	`isSummaryMode()` Is the parser in "summary mode"? See `IParser.setSummaryMode(boolean)` for information
`boolean`	`isSuppressNarratives()` If set to `true` (default is `false`), narratives will not be included in the encoded values.
`Bundle`	`parseBundle(Reader theReader)` Parse a DSTU1 style Atom Bundle.
`Bundle`	`parseBundle(String theXml)` Parse a DSTU1 style Atom Bundle.
`<T extends IBaseResource> T`	`parseResource(Class<T> theResourceType, Reader theReader)` Parses a resource
`<T extends IBaseResource> T`	`parseResource(Class<T> theResourceType, String theMessageString)` Parses a resource
`IBaseResource`	`parseResource(Reader theReader)` Parses a resource
`IBaseResource`	`parseResource(String theMessageString)` Parses a resource
`TagList`	`parseTagList(String theString)` Parses a tag list, as defined in the FHIR Specification.
`protected List<? extends IBase>`	`preProcessValues(BaseRuntimeChildDefinition metaChildUncast, IBaseResource theResource, List<? extends IBase> theValues)`
`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`	`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`	`setParserErrorHandler(IParserErrorHandler theErrorHandler)` Registers an error handler which will be invoked when any parse errors are found
`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.
`protected boolean`	`shouldAddSubsettedTag()`
`protected 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
encodeTagListToWriter, getEncoding, parseBundle, parseTagList, setPrettyPrint

- Constructor Detail
  - BaseParser
```
public BaseParser(FhirContext theContext,
                  IParserErrorHandler theParserErrorHandler)
```
    Constructor
    
    Parameters:
    
    theParserErrorHandler -
- Method Detail
  - compositeChildIterator
```
protected Iterable<BaseParser.CompositeChildElement> compositeChildIterator(List<? extends BaseRuntimeChildDefinition> theChildren,
                                                                            boolean theContainedResource,
                                                                            BaseParser.CompositeChildElement theParent)
```
  - containResourcesForEncoding
```
protected void containResourcesForEncoding(IBaseResource theResource)
```
  - determineReferenceText
```
protected String determineReferenceText(IBaseReference theRef)
```
  - determineResourceBaseUrl
```
protected String determineResourceBaseUrl(String bundleBaseUrl,
                                          BundleEntry theEntry)
```
  - doEncodeBundleToWriter
```
protected abstract void doEncodeBundleToWriter(Bundle theBundle,
                                               Writer theWriter)
                                        throws IOException,
                                               DataFormatException
```
    Throws:
    
    IOException
    
    DataFormatException
  - doEncodeResourceToWriter
```
protected abstract void doEncodeResourceToWriter(IBaseResource theResource,
                                                 Writer theWriter)
                                          throws IOException,
                                                 DataFormatException
```
    Throws:
    
    IOException
    
    DataFormatException
  - doParseResource
```
protected abstract <T extends IBaseResource> T doParseResource(Class<T> theResourceType,
                                                               Reader theReader)
                                                        throws DataFormatException
```
    Throws:
    
    DataFormatException
  - encodeBundleToString
```
public String encodeBundleToString(Bundle theBundle)
                            throws DataFormatException
```
    Specified by:
    
    encodeBundleToString in interface IParser
    
    Throws:
    
    DataFormatException
  - encodeBundleToWriter
```
public final void encodeBundleToWriter(Bundle theBundle,
                                       Writer theWriter)
                                throws IOException,
                                       DataFormatException
```
    Specified by:
    
    encodeBundleToWriter in interface IParser
    
    Throws:
    
    IOException
    
    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
  - encodeTagListToString
```
public String encodeTagListToString(TagList theTagList)
```
    Description copied from interface: IParser
    
    Encodes a tag list, as defined in the FHIR Specification.
    
    Specified by:
    
    encodeTagListToString in interface IParser
    
    Parameters:
    
    theTagList - The tag list to encode. Must not be null.
    
    Returns:
    
    An encoded tag list
  - fixContainedResourceId
```
protected String fixContainedResourceId(String theValue)
```
  - getEncodeElements
```
public Set<String> getEncodeElements()
```
    See setEncodeElements(Set)
    
    Specified by:
    
    getEncodeElements in interface IParser
  - getEncodeElementsAppliesToResourceTypes
```
public Set<String> getEncodeElementsAppliesToResourceTypes()
```
    See setEncodeElementsAppliesToResourceTypes(Set)
    
    Specified by:
    
    getEncodeElementsAppliesToResourceTypes in interface IParser
  - getErrorHandler
```
protected IParserErrorHandler getErrorHandler()
```
  - getMetaTagsForEncoding
```
protected TagList getMetaTagsForEncoding(IResource theIResource)
```
  - 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)
```
  - 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)
  - isStripVersionsFromReferences
```
public boolean isStripVersionsFromReferences()
```
    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: isStripVersionsFromReferences in interface IParser Returns: Returns the parser instance's configuration setting for stripping versions from resource references when encoding. Default is true.
  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 See Also: #setSummaryMode(boolean)} for information isSuppressNarratives public boolean isSuppressNarratives() If set to true (default is false), narratives will not be included in the encoded values. Since: 1.2 parseBundle public Bundle parseBundle(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 parseBundle public Bundle parseBundle(String theXml) throws ConfigurationException, DataFormatException 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, String) with the Bundle class found in the ca.uhn.hapi.fhir.model.[version].resource package instead. Specified by: parseBundle in interface IParser Throws: ConfigurationException DataFormatException 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 parseTagList public TagList parseTagList(String theString) Description copied from interface: IParser Parses a tag list, as defined in the FHIR Specification. Specified by: parseTagList in interface IParser Parameters: theString - A string containing a tag list Returns: A parsed tag list preProcessValues protected List<? extends IBase> preProcessValues(BaseRuntimeChildDefinition metaChildUncast, IBaseResource theResource, List<? extends IBase> theValues) setEncodeElements public void 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 - Encoding 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) Specified by: setEncodeElements in interface IParser Parameters: theEncodeElements - The elements to encode setEncodeElementsAppliesToResourceTypes public void setEncodeElementsAppliesToResourceTypes(Set<String> theEncodeElementsAppliesToResourceTypes) Description copied from interface: IParser 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. Specified by: setEncodeElementsAppliesToResourceTypes in interface IParser 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. 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 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. Specified by: setStripVersionsFromReferences in interface IParser Parameters: theStripVersionsFromReferences - Set this to false to prevent the parser from removing resource versions from references. Returns: Returns a reference to this parser so that method calls can be chained together 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() throwExceptionForUnknownChildType protected void throwExceptionForUnknownChildType(BaseRuntimeChildDefinition nextChild, Class<? extends IBase> theType) extractMetadataListNotNull protected static <T> List<T> extractMetadataListNotNull(IResource resource, ResourceMetadataKeyEnum<List<T>> key)

Class BaseParser

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.parser.IParser

Constructor Detail

BaseParser

Method Detail

compositeChildIterator

containResourcesForEncoding

determineReferenceText

determineResourceBaseUrl

doEncodeBundleToWriter

doEncodeResourceToWriter

doParseResource

encodeBundleToString

encodeBundleToWriter

encodeResourceToString

encodeResourceToWriter

encodeTagListToString

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

extractMetadataListNotNull