Package org.hl7.fhir.r5.utils

Class DefinitionNavigator

java.lang.Object

org.hl7.fhir.r5.utils.DefinitionNavigator

public class DefinitionNavigator
extends Object

Constructor Summary

Constructors

Constructor	Description
DefinitionNavigator(IWorkerContext context, StructureDefinition structure, boolean diff, boolean followTypes)
DefinitionNavigator(DefinitionNavigator other, boolean followTypes)	Special case - changing the value of followTypes, for special use case

Method Summary

Modifier and Type	Method	Description
DefinitionNavigator	childByName(String name)
DefinitionNavigator	childByPath(String path)
List<DefinitionNavigator>	children()
List<DefinitionNavigator>	childrenFromType(ElementDefinition.TypeRefComponent type, Resource res)
ElementDefinition	current()
String	getId()
ElementDefinition.TypeRefComponent	getManualType()
List<String>	getNames()	When you walk a tree, and you walk into a typed structure, an element can simultaineously be covered by multiple types at once.
ElementDefinition.ElementDefinitionSlicingComponent	getSlicing()
StructureDefinition	getStructure()
boolean	hasChildren()
boolean	hasInlineChildren()
boolean	hasSlices()
boolean	hasTypeChildren(ElementDefinition.TypeRefComponent type, Resource res)	if you have a typed element, the tree might end at that point.
boolean	isManualSliced()
String	nameTail()
Base	parent()
String	path()
void	setManualSliced(ElementDefinition.ElementDefinitionSlicingComponent manualSliced)
boolean	sliced()
List<DefinitionNavigator>	slices()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefinitionNavigator

public DefinitionNavigator(IWorkerContext context,
 StructureDefinition structure,
 boolean diff,
 boolean followTypes)
                    throws org.hl7.fhir.exceptions.DefinitionException

Throws:

org.hl7.fhir.exceptions.DefinitionException

DefinitionNavigator

public DefinitionNavigator(DefinitionNavigator other,
 boolean followTypes)

Special case - changing the value of followTypes, for special use case

Parameters:

other -

followTypes -

Method Details

getNames

public List<String> getNames()

When you walk a tree, and you walk into a typed structure, an element can simultaineously be covered by multiple types at once. Take, for example, the string label for an identifer value. It has the following paths: Patient.identifier.value.value Identifier.value.value String.value value If you started in a bundle, the list might be even longer and deeper Any of these names might be relevant. This function returns the names in an ordered list in the order above

Returns:

current

public ElementDefinition current()

slices

public List<DefinitionNavigator> slices()
                                 throws org.hl7.fhir.exceptions.DefinitionException

Throws:

org.hl7.fhir.exceptions.DefinitionException

children

public List<DefinitionNavigator> children()
                                   throws org.hl7.fhir.exceptions.DefinitionException

Throws:

org.hl7.fhir.exceptions.DefinitionException

path

public String path()

nameTail

public String nameTail()

hasTypeChildren

public boolean hasTypeChildren(ElementDefinition.TypeRefComponent type,
 Resource res)
                        throws org.hl7.fhir.exceptions.DefinitionException

if you have a typed element, the tree might end at that point. And you may or may not want to walk into the tree of that type It depends what you are doing. So this is a choice. You can ask for the children, and then, if you get no children, you can see if there are children defined for the type, and then get them you have to provide a type if there's more than one type for current() since this library doesn't know how to choose

Parameters:

res -

Throws:

org.hl7.fhir.exceptions.DefinitionException

childrenFromType

public List<DefinitionNavigator> childrenFromType(ElementDefinition.TypeRefComponent type,
 Resource res)
                                           throws org.hl7.fhir.exceptions.DefinitionException

Parameters:

res -

Returns:

Throws:

org.hl7.fhir.exceptions.DefinitionException

getStructure

public StructureDefinition getStructure()

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

parent

public Base parent()

sliced

public boolean sliced()

childByPath

public DefinitionNavigator childByPath(String path)

hasChildren

public boolean hasChildren()

hasSlices

public boolean hasSlices()

hasInlineChildren

public boolean hasInlineChildren()

childByName

public DefinitionNavigator childByName(String name)

isManualSliced

public boolean isManualSliced()

getSlicing

public ElementDefinition.ElementDefinitionSlicingComponent getSlicing()

setManualSliced

public void setManualSliced(ElementDefinition.ElementDefinitionSlicingComponent manualSliced)

getManualType

public ElementDefinition.TypeRefComponent getManualType()