Package org.hl7.fhir.r4.formats

Class XmlParserBase

java.lang.Object

org.hl7.fhir.r4.formats.FormatUtilities

org.hl7.fhir.r4.formats.ParserBase

org.hl7.fhir.r4.formats.XmlParserBase

All Implemented Interfaces:

IParser

Direct Known Subclasses:

XmlParser

public abstract class XmlParserBase
extends ParserBase
implements IParser

General parser for XML content. You instantiate an XmlParser of these, but you actually use parse or parseGeneral defined on this class The two classes are separated to keep generated and manually maintained code apart.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	XmlParserBase.XmlVersion

Nested classes/interfaces inherited from interface org.hl7.fhir.r4.formats.IParser

IParser.OutputStyle

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	comments
protected boolean	htmlPretty
protected org.hl7.fhir.utilities.xml.IXMLWriter	xml

Fields inherited from class org.hl7.fhir.r4.formats.ParserBase

allowComments, allowUnknownContent, handleComments, idMap, style, xhtmlMessage

Fields inherited from class org.hl7.fhir.r4.formats.FormatUtilities

FHIR_NS, ID_REGEX, NS_XSI, XHTML_NS

Constructor Summary

Constructors

Constructor	Description
XmlParserBase()
XmlParserBase(XmlParserBase.XmlVersion ver)

Method Summary

Modifier and Type	Method	Description
void	compose(OutputStream stream, String rootName, Type type)	Compose a type to a stream (used in the spec, for example, but not normally in production) @
void	compose(OutputStream stream, Resource resource)	Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) @
void	compose(OutputStream stream, Resource resource, boolean htmlPretty)	Compose a resource to a stream, possibly using pretty presentation for a human reader, and maybe a different choice in the xhtml narrative (used in the spec in one place, but should not be used in production) @
void	compose(OutputStream stream, Type type, String rootName)	Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations. rootName is ignored in the JSON format
void	compose(org.hl7.fhir.utilities.xml.IXMLWriter writer, Resource resource, boolean htmlPretty)
protected void	composeDomainResource(String name, DomainResource res)
protected void	composeElementAttributes(Element element)
protected void	composeElementClose(Base base)
protected abstract void	composeResource(String name, Resource res)
protected abstract void	composeResource(Resource resource)
protected void	composeString(String name, org.hl7.fhir.instance.model.api.IIdType value)
protected abstract void	composeString(String name, StringType value)
protected abstract void	composeType(String prefix, Type type)
protected void	composeTypeAttributes(Type type)
protected void	composeXhtml(String name, org.hl7.fhir.utilities.xhtml.XhtmlNode html)
ParserType	getType()	check what kind of parser this is
protected org.xmlpull.v1.XmlPullParser	loadXml(InputStream stream)
protected org.xmlpull.v1.XmlPullParser	loadXml(String source)
protected int	next(org.xmlpull.v1.XmlPullParser xpp)
protected int	nextNoWhitespace(org.xmlpull.v1.XmlPullParser xpp)
Resource	parse(InputStream input)	Parse content that is known to be a resource @
Resource	parse(org.xmlpull.v1.XmlPullParser xpp)	parse xml that is known to be a resource, and that is already being read by an XML Pull Parser This is if a resource is in a bigger piece of XML
Type	parseAnyType(InputStream input, String knownType)
protected abstract Type	parseAnyType(org.xmlpull.v1.XmlPullParser xml, String type)
protected void	parseBackboneAttributes(org.xmlpull.v1.XmlPullParser xpp, Element e)
protected DomainResource	parseDomainResourceContained(org.xmlpull.v1.XmlPullParser xpp)
protected void	parseElementAttributes(org.xmlpull.v1.XmlPullParser xpp, Element e)
protected void	parseElementClose(Base e)
protected abstract Resource	parseResource(org.xmlpull.v1.XmlPullParser xpp)
protected Resource	parseResourceContained(org.xmlpull.v1.XmlPullParser xpp)
Type	parseType(InputStream input, String knownType)	This is used to parse a type - a fragment of a resource.
protected abstract Type	parseType(org.xmlpull.v1.XmlPullParser xml, String type)
protected void	parseTypeAttributes(org.xmlpull.v1.XmlPullParser xpp, Type t)
protected org.hl7.fhir.utilities.xhtml.XhtmlNode	parseXhtml(org.xmlpull.v1.XmlPullParser xpp)
protected void	skipElementWithContent(org.xmlpull.v1.XmlPullParser xpp)
protected void	skipEmptyElement(org.xmlpull.v1.XmlPullParser xpp)
protected void	unknownContent(org.xmlpull.v1.XmlPullParser xpp)

Methods inherited from class org.hl7.fhir.r4.formats.ParserBase

composeBytes, composeBytes, composeString, composeString, getHandleComments, getOutputStyle, isAllowComments, isAllowUnknownContent, parse, parse, parseAnyType, parseAnyType, parseBase64BinaryPrimitive, parseBooleanPrimitive, parseBooleanPrimitive, parseCodePrimitive, parseDecimalPrimitive, parseDecimalPrimitive, parseIdPrimitive, parseIntegerPrimitive, parseIntegerPrimitive, parseOidPrimitive, parseStringPrimitive, parseTimePrimitive, parseType, parseType, parseUriPrimitive, parseUuidPrimitive, setAllowComments, setAllowUnknownContent, setHandleComments, setOutputStyle, setSuppressXhtml

Methods inherited from class org.hl7.fhir.r4.formats.FormatUtilities

determineFormat, determineFormat, isValidId, loadFile, loadFile, loadFileTight, loadFileTight, makeId, makeParser, makeParser, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.r4.formats.IParser

composeBytes, composeBytes, composeString, composeString, getHandleComments, getOutputStyle, isAllowUnknownContent, parse, parse, parseType, parseType, setAllowUnknownContent, setHandleComments, setOutputStyle, setSuppressXhtml

Field Details

comments

protected List<String> comments

xml

protected org.hl7.fhir.utilities.xml.IXMLWriter xml

htmlPretty

protected boolean htmlPretty

Constructor Details

XmlParserBase

public XmlParserBase(XmlParserBase.XmlVersion ver)

XmlParserBase

public XmlParserBase()

Method Details

getType

public ParserType getType()

Description copied from interface: IParser

check what kind of parser this is

Specified by:

getType in interface IParser

Returns:

what kind of parser this is

parseResource

protected abstract Resource parseResource(org.xmlpull.v1.XmlPullParser xpp)
                                   throws org.xmlpull.v1.XmlPullParserException,
IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

org.hl7.fhir.exceptions.FHIRFormatError

parseType

protected abstract Type parseType(org.xmlpull.v1.XmlPullParser xml,
 String type)
                           throws org.xmlpull.v1.XmlPullParserException,
IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

org.hl7.fhir.exceptions.FHIRFormatError

parseAnyType

protected abstract Type parseAnyType(org.xmlpull.v1.XmlPullParser xml,
 String type)
                              throws org.xmlpull.v1.XmlPullParserException,
IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

org.hl7.fhir.exceptions.FHIRFormatError

composeType

protected abstract void composeType(String prefix,
 Type type)
                             throws IOException

Throws:

IOException

parse

public Resource parse(InputStream input)
               throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Parse content that is known to be a resource @

Specified by:

parse in interface IParser

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

parse

public Resource parse(org.xmlpull.v1.XmlPullParser xpp)
               throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError,
org.xmlpull.v1.XmlPullParserException

parse xml that is known to be a resource, and that is already being read by an XML Pull Parser This is if a resource is in a bigger piece of XML. @

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

org.xmlpull.v1.XmlPullParserException

parseType

public Type parseType(InputStream input,
 String knownType)
               throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Description copied from interface: IParser

This is used to parse a type - a fragment of a resource. There's no reason to use this in production - it's used in the build tools Not supported by all implementations

Specified by:

parseType in interface IParser

Parameters:

input -

knownType - . if this is blank, the parser may try to infer the type (xml only)

Returns:

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

parseAnyType

public Type parseAnyType(InputStream input,
 String knownType)
                  throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Specified by:

parseAnyType in interface IParser

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

compose

public void compose(OutputStream stream,
 Resource resource)
             throws IOException

Compose a resource to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) @

Specified by:

compose in interface IParser

Throws:

IOException

compose

public void compose(OutputStream stream,
 Resource resource,
 boolean htmlPretty)
             throws IOException

Compose a resource to a stream, possibly using pretty presentation for a human reader, and maybe a different choice in the xhtml narrative (used in the spec in one place, but should not be used in production) @

Throws:

IOException

compose

public void compose(OutputStream stream,
 String rootName,
 Type type)
             throws IOException

Compose a type to a stream (used in the spec, for example, but not normally in production) @

Throws:

IOException

compose

public void compose(OutputStream stream,
 Type type,
 String rootName)
             throws IOException

Description copied from interface: IParser

Compose a type to a stream, possibly using pretty presentation for a human reader (used in the spec, for example, but not normally in production) Not supported by all implementations. rootName is ignored in the JSON format

Specified by:

compose in interface IParser

Throws:

IOException

loadXml

protected org.xmlpull.v1.XmlPullParser loadXml(String source)
                                        throws UnsupportedEncodingException,
org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

UnsupportedEncodingException

org.xmlpull.v1.XmlPullParserException

IOException

loadXml

protected org.xmlpull.v1.XmlPullParser loadXml(InputStream stream)
                                        throws org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

next

protected int next(org.xmlpull.v1.XmlPullParser xpp)
            throws org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

nextNoWhitespace

protected int nextNoWhitespace(org.xmlpull.v1.XmlPullParser xpp)
                        throws org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

skipElementWithContent

protected void skipElementWithContent(org.xmlpull.v1.XmlPullParser xpp)
                               throws org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

skipEmptyElement

protected void skipEmptyElement(org.xmlpull.v1.XmlPullParser xpp)
                         throws org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

parseTypeAttributes

protected void parseTypeAttributes(org.xmlpull.v1.XmlPullParser xpp,
 Type t)

parseElementAttributes

protected void parseElementAttributes(org.xmlpull.v1.XmlPullParser xpp,
 Element e)

parseElementClose

protected void parseElementClose(Base e)

parseBackboneAttributes

protected void parseBackboneAttributes(org.xmlpull.v1.XmlPullParser xpp,
 Element e)

unknownContent

protected void unknownContent(org.xmlpull.v1.XmlPullParser xpp)
                       throws org.hl7.fhir.exceptions.FHIRFormatError,
org.xmlpull.v1.XmlPullParserException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.xmlpull.v1.XmlPullParserException

IOException

parseXhtml

protected org.hl7.fhir.utilities.xhtml.XhtmlNode parseXhtml(org.xmlpull.v1.XmlPullParser xpp)
                                                     throws org.xmlpull.v1.XmlPullParserException,
IOException,
org.hl7.fhir.exceptions.FHIRFormatError

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

org.hl7.fhir.exceptions.FHIRFormatError

parseDomainResourceContained

protected DomainResource parseDomainResourceContained(org.xmlpull.v1.XmlPullParser xpp)
                                               throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError,
org.xmlpull.v1.XmlPullParserException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

org.xmlpull.v1.XmlPullParserException

parseResourceContained

protected Resource parseResourceContained(org.xmlpull.v1.XmlPullParser xpp)
                                   throws IOException,
org.hl7.fhir.exceptions.FHIRFormatError,
org.xmlpull.v1.XmlPullParserException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRFormatError

org.xmlpull.v1.XmlPullParserException

compose

public void compose(org.hl7.fhir.utilities.xml.IXMLWriter writer,
 Resource resource,
 boolean htmlPretty)
             throws IOException

Throws:

IOException

composeResource

protected abstract void composeResource(Resource resource)
                                 throws IOException

Throws:

IOException

composeElementAttributes

protected void composeElementAttributes(Element element)
                                 throws IOException

Throws:

IOException

composeElementClose

protected void composeElementClose(Base base)
                            throws IOException

Throws:

IOException

composeTypeAttributes

protected void composeTypeAttributes(Type type)
                              throws IOException

Throws:

IOException

composeXhtml

protected void composeXhtml(String name,
 org.hl7.fhir.utilities.xhtml.XhtmlNode html)
                     throws IOException

Throws:

IOException

composeString

protected abstract void composeString(String name,
 StringType value)
                               throws IOException

Throws:

IOException

composeString

protected void composeString(String name,
 org.hl7.fhir.instance.model.api.IIdType value)
                      throws IOException

Throws:

IOException

composeDomainResource

protected void composeDomainResource(String name,
 DomainResource res)
                              throws IOException

Throws:

IOException

composeResource

protected abstract void composeResource(String name,
 Resource res)
                                 throws IOException

Throws:

IOException