Package com.ibm.fhir.path

Class FHIRPathTree

java.lang.Object

com.ibm.fhir.path.FHIRPathTree

public class FHIRPathTree
extends java.lang.Object

A tree of FHIRPathNode nodes created from a Resource or an Element

Method Summary

Modifier and Type	Method	Description
FHIRPathNode	getNode(java.lang.String path)	Get the node at the location given by the path parameter
FHIRPathNode	getParent(FHIRPathNode node)	Get the parent of the node parameter
FHIRPathNode	getRoot()	The root node of this FHIRPathTree
FHIRPathNode	getSibling(FHIRPathNode node, java.lang.String name)	Get the first sibling of the node parameter with the given name
java.util.Collection<FHIRPathNode>	getSiblings(FHIRPathNode node)	Get the siblings of the node parameter
java.util.Collection<FHIRPathNode>	getSiblings(FHIRPathNode node, java.lang.String name)	Get the siblings of the node parameter with the given name
static FHIRPathTree	tree(Resource resource)	Static factory method for creating FHIRPathTree instances from a Resource
static FHIRPathTree	tree(Element element)	Static factory method for creating FHIRPathTree instances from an Element

Methods inherited from class java.lang.Object

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

Method Detail

getRoot

public FHIRPathNode getRoot()

The root node of this FHIRPathTree

Returns:

the root node of this FHIRPathTree

getNode

public FHIRPathNode getNode(java.lang.String path)

Get the node at the location given by the path parameter

Parameters:

path - the location of the node in the tree

Returns:

the node at the location given by the path parameter if exists, otherwise null

getParent

public FHIRPathNode getParent(FHIRPathNode node)

Get the parent of the node parameter

Parameters:

node - the node

Returns:

the parent of the node parameter if exists, otherwise null

getSiblings

public java.util.Collection<FHIRPathNode> getSiblings(FHIRPathNode node)

Get the siblings of the node parameter

Parameters:

node - the node

Returns:

the siblings of the node parameter if exists, otherwise empty collection

getSiblings

public java.util.Collection<FHIRPathNode> getSiblings(FHIRPathNode node,
                                                      java.lang.String name)

Get the siblings of the node parameter with the given name

Parameters:

node - the node

name - the name

Returns:

the siblings of the node parameter with the given name if exists, otherwise empty collection

getSibling

public FHIRPathNode getSibling(FHIRPathNode node,
                               java.lang.String name)

Get the first sibling of the node parameter with the given name

Parameters:

node - the node

name - the name

Returns:

the first sibling of the node parameter with the given name if exists, otherwise null

tree

public static FHIRPathTree tree(Resource resource)

Static factory method for creating FHIRPathTree instances from a Resource

Parameters:

resource - the resource

Returns:

a new FHIRPathTree instance

tree

public static FHIRPathTree tree(Element element)

Static factory method for creating FHIRPathTree instances from an Element

Parameters:

element - the element

Returns:

a new FHIRPathTree instance