All Known Subinterfaces:: IJsonLikeParser

All Known Implementing Classes:: BaseParser, JsonParser, RDFParser, 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	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}
`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?
`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`	`isEncodeElementsAppliesToChildResourcesOnly()`	If set to `true` (default is false), the values supplied to `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 omitted
`boolean`	`isSummaryMode()`	Is the parser in "summary mode"? See `setSummaryMode(boolean)` for information
`IBaseResource`	`parseResource(InputStream theInputStream)`	Parses a resource
`IBaseResource`	`parseResource(Reader theReader)`	Parses a resource
`<T extends IBaseResource> T`	`parseResource(Class<T> theResourceType, InputStream theInputStream)`	Parses a resource
`<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(String theMessageString)`	Parses a resource
`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 to `true` (default is false), the values supplied to `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.
`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 Details
- encodeResourceToString
  
  String encodeResourceToString(IBaseResource theResource) throws DataFormatException
  
  Throws:
  
  DataFormatException
- encodeResourceToWriter
  
  void encodeResourceToWriter(IBaseResource theResource, Writer theWriter) throws IOException, DataFormatException
  
  Throws:
  
  IOException
  
  DataFormatException
- 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

Interface IParser

Method Summary

Method Details