Package org.hl7.fhir.r5.elementmodel

Class Element

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.elementmodel.Element

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.utilities.NamedItemList.NamedItem

public class Element
extends Base
implements org.hl7.fhir.utilities.NamedItemList.NamedItem

This class represents the underlying reference model of FHIR A resource is nothing but a set of elements, where every element has a name, maybe a stated type, maybe an id, and either a value or child elements (one or the other, but not both or neither)

Author:

Grahame Grieve

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Element.ElementSortComparator
class	Element.ICodingImpl
class	Element.SliceDefinition
static enum	Element.SpecialElement

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Constructor Summary

Constructors

Constructor	Description
Element(String name)
Element(String name, Property property)
Element(String name, Property property, String type, String value)
Element(Element other)

Method Summary

Modifier and Type	Method	Description
Base.ValidationInfo	addDefinition(StructureDefinition source, ElementDefinition defn, Base.ValidationMode mode)
Element	addElement(String name)
void	addMessage(org.hl7.fhir.utilities.validation.ValidationMessage vm)
void	addSliceDefinition(StructureDefinition profile, ElementDefinition definition, ElementDefinition slice)
DataType	asType()
boolean	canHaveChild(String name)
boolean	canHavePrimitiveValue()
void	clear()
void	clearDecorations()
int	col()
Base	copy()
void	copyValues(Base dst)
int	countDescendents()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
String	fhirTypeRoot()
Element	forceElement(String name)
ICoding	getAsICoding()
String	getBasePath()
org.hl7.fhir.utilities.NamedItemList<Element>	getChildren()
List<Element>	getChildren(String name)
List<Element>	getChildrenByName(String name)
String	getChildValue(String name)
List<String>	getComments()
int	getDescendentCount()
Property	getElementProperty()
String	getExplicitType()
Element	getExtension(String url)
Element	getExtension(String... urls)
List<Element>	getExtensions(String url)
String	getExtensionString(String url)
Base	getExtensionValue(String... url)
org.hl7.fhir.utilities.FhirPublication	getFHIRPublicationVersion()
Manager.FhirFormat	getFormat()
String	getIdBase()
int	getIndex()
int	getInstanceId()
String	getJsonName()
String	getListName()
List<org.hl7.fhir.utilities.validation.ValidationMessage>	getMessages()
String	getName()
Element	getNamedChild(String name)
Element	getNamedChild(String name, boolean exception)
void	getNamedChildren(String name, List<Element> list)
void	getNamedChildrenWithWildcard(String string, List<Element> values)
Element	getNamedChildSingle(String name, boolean exception)
String	getNamedChildValue(String... names)
String	getNamedChildValue(String name, boolean exception)
String	getNamedChildValueSingle(String... names)
String	getNamedChildValueSingle(String name, boolean exception)
Object	getNativeObject()
Element	getParentForValidator()	this is set by the instance validator.
String	getPath()
Property	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
Base	getSource()
Element.SpecialElement	getSpecial()
String	getStatedResourceId()
String	getTranslation(String lang)
String	getType()
String[]	getTypesForProperty(int hash, String name)
List<Base.ValidationInfo>	getValidationInfo()	A list of definitions that the validator matched this element to.
String	getValue()
String	getWebPath()
org.hl7.fhir.utilities.xhtml.XhtmlNode	getXhtml()	return XHTML if this is an XHTML node, else null
boolean	hasChild(String name)
boolean	hasChild(String name, boolean exception)
boolean	hasChildren()
boolean	hasChildren(String name)
boolean	hasComments()
boolean	hasDescendant(Element element)
boolean	hasElementProperty()
boolean	hasExtension(String... url)
boolean	hasIndex()
boolean	hasMessages()
boolean	hasParentForValidator()
boolean	hasPrimitiveValue()
boolean	hasSlice(StructureDefinition sd, String sliceName)
boolean	hasSource()
boolean	hasType()
boolean	hasValidationInfo()
boolean	hasValue()
boolean	hasWebPath()
boolean	hasXhtml()
boolean	isBaseList()
boolean	isBooleanPrimitive()
boolean	isElided()
boolean	isEmpty()
boolean	isIgnorePropertyOrder()
boolean	isList()
boolean	isMetadataBased()
boolean	isNull()
boolean	isPrimitive()
boolean	isProhibited()
boolean	isRequired()
boolean	isResource()
int	line()
protected void	listChildren(List<Property> childProps)
Element	makeElement(String name)
Base	makeProperty(int hash, String name)
Element	markLocation(int line, int col)
Element	markLocation(Element src)
Element	markLocation(org.hl7.fhir.utilities.SourceLocation loc)
void	markValidation(StructureDefinition profile, ElementDefinition definition)
void	numberChildren()
void	populatePaths(String path)
String	primitiveValue()
void	printToOutput()
void	printToOutput(PrintStream stream)
void	removeChild(String name)
void	removeChild(Element child)
void	removeExtension(String url)
void	setChildValue(String name, String value)
void	setChildValue(String name, Base value)
void	setDescendentCount(int descendentCount)
void	setElement(String string, Element map)
void	setElided(boolean elided)
void	setExplicitType(String explicitType)
Element	setFormat(Manager.FhirFormat format)
void	setIdBase(String value)
void	setIgnorePropertyOrder(boolean ignorePropertyOrder)
void	setIndex(int index)
void	setInstanceId(int instanceId)
Element	setNativeObject(Object nativeObject)
void	setNull(boolean isNull)
void	setParentForValidator(Element parentForValidator)
void	setPath(String path)
void	setProhibited(boolean prohibited)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
void	setRequired(boolean required)
void	setSource(Base source)
void	setTranslation(String lang, String translation)
Element	setType(String type)
void	setValue(String value)
void	setWebPath(String webPath)
Element	setXhtml(org.hl7.fhir.utilities.xhtml.XhtmlNode xhtml)	return set XHTML if this is an XHTML node, else error
void	sort()
void	sortChildren(Comparator<Element> sorter)
void	stripLocations()
String	toString()
void	updateProperty(Property property, Element.SpecialElement special, Property elementProperty)

Methods inherited from class org.hl7.fhir.r5.model.Base

addChild, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getNamedProperty, getUserData, getUserInt, getUserString, getValidationMessages, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasType, hasUserData, hasValidated, hasValidationMessages, isCopyUserData, isDateTime, listChildrenByName, listChildrenByName, removeChild, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Constructor Details

Element

public Element(String name)

Element

public Element(Element other)

Element

public Element(String name,
 Property property)

Element

public Element(String name,
 Property property,
 String type,
 String value)

Method Details

updateProperty

public void updateProperty(Property property,
 Element.SpecialElement special,
 Property elementProperty)

getSpecial

public Element.SpecialElement getSpecial()

getName

public String getName()

getJsonName

public String getJsonName()

getType

public String getType()

getValue

public String getValue()

hasChildren

public boolean hasChildren()

getChildren

public org.hl7.fhir.utilities.NamedItemList<Element> getChildren()

hasComments

public boolean hasComments()

getComments

public List<String> getComments()

getProperty

public Property getProperty()

setValue

public void setValue(String value)

setType

public Element setType(String type)

isNull

public boolean isNull()

setNull

public void setNull(boolean isNull)

hasValue

public boolean hasValue()

getChildrenByName

public List<Element> getChildrenByName(String name)

numberChildren

public void numberChildren()

getIndex

public int getIndex()

hasIndex

public boolean hasIndex()

setIndex

public void setIndex(int index)

getChildValue

public String getChildValue(String name)

setChildValue

public void setChildValue(String name,
 String value)

setChildValue

public void setChildValue(String name,
 Base value)

getChildren

public List<Element> getChildren(String name)

hasType

public boolean hasType()

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Specified by:

fhirType in class Base

Returns:

the FHIR type name of the instance (not the java class name)

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

listChildren

protected void listChildren(List<Property> childProps)

Overrides:

listChildren in class Base

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

makeElement

public Element makeElement(String name)
                    throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

forceElement

public Element forceElement(String name)
                     throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isPrimitive

public boolean isPrimitive()

Overrides:

isPrimitive in class Base

Returns:

true if the data type is a primitive type and might have a primitive value (which will be accessed as a string, irrespective of the stated value)

isBooleanPrimitive

public boolean isBooleanPrimitive()

Overrides:

isBooleanPrimitive in class Base

Returns:

true if the type is boolean, and the primitive value can only be 'true' or 'false'

isResource

public boolean isResource()

Overrides:

isResource in class Base

hasPrimitiveValue

public boolean hasPrimitiveValue()

Overrides:

hasPrimitiveValue in class Base

Returns:

true if the type is primitive, and there's value (e.g. no Data-Absent-Reason extension etc)

canHavePrimitiveValue

public boolean canHavePrimitiveValue()

Overrides:

canHavePrimitiveValue in class Base

Returns:

true if the type is primitive, and there could be a value (irrespective of whether it's present e.g. no Data-Absent-Reason extension etc)

primitiveValue

public String primitiveValue()

Overrides:

primitiveValue in class Base

Returns:

the primitive value if there is one, as a string irrespective of the actual type (e.g. dates converted to their FHIR string representation) return null if the value is not a primitive or there is no value (might be extensions instead)

line

public int line()

col

public int col()

markLocation

public Element markLocation(int line,
 int col)

markLocation

public Element markLocation(org.hl7.fhir.utilities.SourceLocation loc)

markLocation

public Element markLocation(Element src)

clearDecorations

public void clearDecorations()

markValidation

public void markValidation(StructureDefinition profile,
 ElementDefinition definition)

getNamedChild

public Element getNamedChild(String name)

getNamedChild

public Element getNamedChild(String name,
 boolean exception)

getNamedChildSingle

public Element getNamedChildSingle(String name,
 boolean exception)

getNamedChildren

public void getNamedChildren(String name,
 List<Element> list)

getNamedChildValue

public String getNamedChildValue(String... names)

getNamedChildValue

public String getNamedChildValue(String name,
 boolean exception)

getNamedChildValueSingle

public String getNamedChildValueSingle(String... names)

getNamedChildValueSingle

public String getNamedChildValueSingle(String name,
 boolean exception)

getNamedChildrenWithWildcard

public void getNamedChildrenWithWildcard(String string,
 List<Element> values)

getXhtml

public org.hl7.fhir.utilities.xhtml.XhtmlNode getXhtml()

Description copied from class: Base

return XHTML if this is an XHTML node, else null

Overrides:

getXhtml in class Base

Returns:

setXhtml

public Element setXhtml(org.hl7.fhir.utilities.xhtml.XhtmlNode xhtml)

Description copied from class: Base

return set XHTML if this is an XHTML node, else error

Overrides:

setXhtml in class Base

Returns:

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Base

getElementProperty

public Property getElementProperty()

hasElementProperty

public boolean hasElementProperty()

hasChild

public boolean hasChild(String name)

hasChild

public boolean hasChild(String name,
 boolean exception)

canHaveChild

public boolean canHaveChild(String name)

hasChildren

public boolean hasChildren(String name)

toString

public String toString()

Overrides:

toString in class Object

getIdBase

public String getIdBase()

Specified by:

getIdBase in class Base

setIdBase

public void setIdBase(String value)

Specified by:

setIdBase in class Base

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Base

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Base

asType

public DataType asType()
                throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isMetadataBased

public boolean isMetadataBased()

Overrides:

isMetadataBased in class Base

isList

public boolean isList()

isBaseList

public boolean isBaseList()

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

sort

public void sort()

getAsICoding

public ICoding getAsICoding()
                     throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

getExplicitType

public String getExplicitType()

setExplicitType

public void setExplicitType(String explicitType)

hasDescendant

public boolean hasDescendant(Element element)

getExtension

public Element getExtension(String url)

getExtension

public Element getExtension(String... urls)

getExtensionString

public String getExtensionString(String url)

getExtensions

public List<Element> getExtensions(String url)

getExtensionValue

public Base getExtensionValue(String... url)

hasExtension

public boolean hasExtension(String... url)

getParentForValidator

public Element getParentForValidator()

this is set by the instance validator. There's no reason to maintain this when working with an element tree, and so it should be ignored outside the validator

setParentForValidator

public void setParentForValidator(Element parentForValidator)

hasParentForValidator

public boolean hasParentForValidator()

clear

public void clear()

getPath

public String getPath()

setPath

public void setPath(String path)

addMessage

public void addMessage(org.hl7.fhir.utilities.validation.ValidationMessage vm)

hasMessages

public boolean hasMessages()

getMessages

public List<org.hl7.fhir.utilities.validation.ValidationMessage> getMessages()

removeChild

public void removeChild(String name)

removeChild

public void removeChild(Element child)

isProhibited

public boolean isProhibited()

setProhibited

public void setProhibited(boolean prohibited)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getDescendentCount

public int getDescendentCount()

setDescendentCount

public void setDescendentCount(int descendentCount)

countDescendents

public int countDescendents()

getInstanceId

public int getInstanceId()

setInstanceId

public void setInstanceId(int instanceId)

hasValidationInfo

public boolean hasValidationInfo()

Overrides:

hasValidationInfo in class Base

getValidationInfo

public List<Base.ValidationInfo> getValidationInfo()

Description copied from class: Base

A list of definitions that the validator matched this element to. Note that the element doesn't have to conform to these definitions - check whether they're valid Some of the definitions will be noted because of slice matching

Overrides:

getValidationInfo in class Base

Returns:

addDefinition

public Base.ValidationInfo addDefinition(StructureDefinition source,
 ElementDefinition defn,
 Base.ValidationMode mode)

Overrides:

addDefinition in class Base

hasSource

public boolean hasSource()

getSource

public Base getSource()

setSource

public void setSource(Base source)

printToOutput

public void printToOutput()

printToOutput

public void printToOutput(PrintStream stream)

populatePaths

public void populatePaths(String path)

fhirTypeRoot

public String fhirTypeRoot()

setElement

public void setElement(String string,
 Element map)

addElement

public Element addElement(String name)

copy

public Base copy()

Specified by:

copy in class Base

copyValues

public void copyValues(Base dst)

Overrides:

copyValues in class Base

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

isIgnorePropertyOrder

public boolean isIgnorePropertyOrder()

setIgnorePropertyOrder

public void setIgnorePropertyOrder(boolean ignorePropertyOrder)

hasWebPath

public boolean hasWebPath()

getWebPath

public String getWebPath()

setWebPath

public void setWebPath(String webPath)

getTranslation

public String getTranslation(String lang)

getBasePath

public String getBasePath()

setTranslation

public void setTranslation(String lang,
 String translation)

getListName

public String getListName()

Specified by:

getListName in interface org.hl7.fhir.utilities.NamedItemList.NamedItem

getFormat

public Manager.FhirFormat getFormat()

setFormat

public Element setFormat(Manager.FhirFormat format)

getNativeObject

public Object getNativeObject()

setNativeObject

public Element setNativeObject(Object nativeObject)

removeExtension

public void removeExtension(String url)

addSliceDefinition

public void addSliceDefinition(StructureDefinition profile,
 ElementDefinition definition,
 ElementDefinition slice)

hasSlice

public boolean hasSlice(StructureDefinition sd,
 String sliceName)

getFHIRPublicationVersion

public org.hl7.fhir.utilities.FhirPublication getFHIRPublicationVersion()

Specified by:

getFHIRPublicationVersion in class Base

setElided

public void setElided(boolean elided)

isElided

public boolean isElided()

stripLocations

public void stripLocations()

sortChildren

public void sortChildren(Comparator<Element> sorter)

getStatedResourceId

public String getStatedResourceId()

hasXhtml

public boolean hasXhtml()