Package com.ibm.fhir.path.util

Class FHIRPathUtil

java.lang.Object

com.ibm.fhir.path.util.FHIRPathUtil

public final class FHIRPathUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FHIRPathUtil.UnorderedCollection

Field Summary

Fields

Modifier and Type	Field	Description
static BigDecimal	DECIMAL_FALSE
static BigDecimal	DECIMAL_TRUE
static Integer	INTEGER_FALSE
static Integer	INTEGER_TRUE
static Set<String>	STRING_FALSE_VALUES
static Set<String>	STRING_TRUE_VALUES
static Map<String,String>	UNESCAPED

Method Summary

Modifier and Type	Method	Description
static <T extends Visitable> T	add(T elementOrResource, String fhirPath, String elementName, Visitable value)	The content will be appended to the element identified in the path, using the name specified.
static ClassInfo	buildClassInfo(FHIRPathType type)
static ClassInfoElement	buildClassInfoElement(ModelSupport.ElementInfo elementInfo)
static SimpleTypeInfo	buildSimpleTypeInfo(FHIRPathType type)
static TupleTypeInfo	buildTupleTypeInfo(Class<?> modelClass)
static TupleTypeInfoElement	buildTupleTypeInfoElement(ModelSupport.ElementInfo elementInfo)
static FHIRPathParser.ExpressionContext	compile(String expr)
static boolean	convertsToBoolean(Collection<FHIRPathNode> nodes)	Indicates whether the input collection can be implicitly or explicitly converted to a boolean value per: Boolean Conversion Functions
static boolean	convertsToDate(Collection<FHIRPathNode> nodes)
static boolean	convertsToDateTime(Collection<FHIRPathNode> nodes)
static boolean	convertsToTime(Collection<FHIRPathNode> nodes)
static <T extends Visitable> T	delete(T elementOrResource, String fhirPath)	Only a single element can be deleted
static Collection<FHIRPathNode>	empty()
static boolean	evaluatesToBoolean(Collection<FHIRPathNode> nodes)
static boolean	evaluatesToTrue(Collection<FHIRPathNode> nodes)	Indicates whether the input collection evaluates to a boolean value per: Singleton Evaluation of Collections
static Boolean	getBoolean(Collection<FHIRPathNode> nodes)
static FHIRPathBooleanValue	getBooleanValue(Collection<FHIRPathNode> nodes)
static ChronoUnit	getChronoUnit(String unit)
static TemporalAccessor	getDate(Collection<FHIRPathNode> nodes)
static TemporalAccessor	getDateTime(Collection<FHIRPathNode> nodes)
static FHIRPathDateTimeValue	getDateTimeValue(Collection<FHIRPathNode> nodes)
static FHIRPathDateValue	getDateValue(Collection<FHIRPathNode> nodes)
static BigDecimal	getDecimal(Collection<FHIRPathNode> nodes)
static FHIRPathDecimalValue	getDecimalValue(Collection<FHIRPathNode> nodes)
static String	getDisplay(FHIRPathTree tree, FHIRPathElementNode elementNode)	Get the String-typed sibling of the given element node with name "display".
static FHIRPathElementNode	getElementNode(Collection<FHIRPathNode> nodes)
static Integer	getInteger(Collection<FHIRPathNode> nodes)
static FHIRPathIntegerValue	getIntegerValue(Collection<FHIRPathNode> nodes)
static FHIRPathNumberValue	getNumberValue(Collection<FHIRPathNode> nodes)
static ChronoField	getPrecision(TemporalAccessor temporalAccessor)
static ChronoField	getPrecision(TemporalAccessor temporalAccessor, String text)
static FHIRPathQuantityNode	getQuantityNode(Collection<FHIRPathNode> nodes)
static FHIRPathQuantityValue	getQuantityValue(Collection<FHIRPathNode> nodes)
static FHIRPathResourceNode	getResourceNode(FHIRPathTree tree, FHIRPathNode node)	Get the resource node to use as a value for the %resource external constant.
static FHIRPathResourceNode	getResourceNode(Collection<FHIRPathNode> nodes)
static FHIRPathResourceNode	getRootResourceNode(FHIRPathTree tree, FHIRPathNode node)	Get the resource node to use as a value for the %rootResource external constant.
static FHIRPathNode	getSingleton(Collection<FHIRPathNode> nodes)
static <T extends FHIRPathNode> T	getSingleton(Collection<FHIRPathNode> nodes, Class<T> nodeType)
static String	getString(Collection<FHIRPathNode> nodes)
static FHIRPathStringValue	getStringValue(Collection<FHIRPathNode> nodes)
static Uri	getSystem(FHIRPathTree tree, FHIRPathElementNode elementNode)	Get the URI-typed sibling of the given element node with name "system".
static FHIRPathSystemValue	getSystemValue(FHIRPathNode node)
static FHIRPathSystemValue	getSystemValue(Collection<FHIRPathNode> nodes)
static Temporal	getTemporal(TemporalAccessor temporalAccessor)
static TemporalAccessor	getTemporalAccessor(Temporal temporal, Class<?> targetType)
static TemporalAmount	getTemporalAmount(FHIRPathQuantityValue quantityValue)
static FHIRPathTemporalValue	getTemporalValue(FHIRPathNode node)
static FHIRPathTemporalValue	getTemporalValue(Collection<FHIRPathNode> nodes)
static TemporalAccessor	getTime(Collection<FHIRPathNode> nodes)
static FHIRPathTimeValue	getTimeValue(Collection<FHIRPathNode> nodes)
static String	getVersion(FHIRPathTree tree, FHIRPathElementNode elementNode)	Get the String-typed sibling of the given element node with name "version".
static boolean	hasBooleanValue(Collection<FHIRPathNode> nodes)
static boolean	hasDateTimeValue(Collection<FHIRPathNode> nodes)
static boolean	hasDateValue(Collection<FHIRPathNode> nodes)
static boolean	hasDecimalValue(Collection<FHIRPathNode> nodes)
static boolean	hasIntegerValue(Collection<FHIRPathNode> nodes)
static boolean	hasNumberValue(Collection<FHIRPathNode> nodes)
static boolean	hasQuantityValue(Collection<FHIRPathNode> nodes)
static boolean	hasStringValue(Collection<FHIRPathNode> nodes)
static boolean	hasSystemValue(FHIRPathNode node)
static boolean	hasSystemValue(Collection<FHIRPathNode> nodes)
static boolean	hasTemporalValue(FHIRPathNode node)
static boolean	hasTemporalValue(Collection<FHIRPathNode> nodes)
static boolean	hasTimeValue(Collection<FHIRPathNode> nodes)
static <T extends Visitable> T	insert(T elementOrResource, String fhirPath, int index, Visitable value)	The content will be inserted into the nominated list at the index specified (0 based).
static boolean	isBooleanValue(Collection<FHIRPathNode> nodes)
static boolean	isCodedElement(Element element)
static boolean	isCodedElementNode(FHIRPathElementNode elementNode)
static boolean	isCodedElementNode(Collection<FHIRPathNode> nodes)
static boolean	isDecimalValue(Collection<FHIRPathNode> nodes)
static boolean	isElementNode(Collection<FHIRPathNode> nodes)
static boolean	isFalse(Collection<FHIRPathNode> nodes)	Indicates whether convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a false value for the input collection
static boolean	isIntegerValue(Collection<FHIRPathNode> nodes)
static boolean	isOrdered(Collection<FHIRPathNode> nodes)
static boolean	isQuantityNode(Collection<FHIRPathNode> nodes)
static boolean	isResourceNode(Collection<FHIRPathNode> nodes)
static boolean	isSingleton(Collection<FHIRPathNode> nodes)
static <T extends FHIRPathNode> boolean	isSingleton(Collection<FHIRPathNode> nodes, Class<T> nodeType)
static boolean	isStringElementNode(FHIRPathElementNode elementNode)
static boolean	isStringElementNode(Collection<FHIRPathNode> nodes)
static boolean	isStringValue(Collection<FHIRPathNode> nodes)
static boolean	isSystemValue(Collection<FHIRPathNode> nodes)
static boolean	isTrue(Collection<FHIRPathNode> nodes)	Indicates whether convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a true value for the input collection
static boolean	isTypeCompatible(FHIRPathSystemValue leftValue, FHIRPathSystemValue rightValue)
static boolean	isUnordered(Collection<FHIRPathNode> nodes)
static boolean	isUriElementNode(Collection<FHIRPathNode> nodes)
static <T extends Visitable> T	move(T elementOrResource, String fhirPath, int source, int target)	Move an element within a single list
static <T extends Visitable> T	replace(T elementOrResource, String fhirPath, Visitable value)
static Collection<FHIRPathNode>	singleton(FHIRPathNode node)
static boolean	toBoolean(Collection<FHIRPathNode> nodes)
static FHIRPathDateValue	toDate(Collection<FHIRPathNode> nodes)
static FHIRPathDateTimeValue	toDateTime(Collection<FHIRPathNode> nodes)
static FHIRPathTimeValue	toTime(Collection<FHIRPathNode> nodes)
static String	unescape(String s)
static Collection<FHIRPathNode>	unordered(Collection<FHIRPathNode> nodes)

Methods inherited from class java.lang.Object

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

Field Detail

STRING_TRUE_VALUES

public static final Set<String> STRING_TRUE_VALUES

STRING_FALSE_VALUES

public static final Set<String> STRING_FALSE_VALUES

INTEGER_TRUE

public static final Integer INTEGER_TRUE

INTEGER_FALSE

public static final Integer INTEGER_FALSE

DECIMAL_TRUE

public static final BigDecimal DECIMAL_TRUE

DECIMAL_FALSE

public static final BigDecimal DECIMAL_FALSE

UNESCAPED

public static final Map<String,String> UNESCAPED

Method Detail

compile

public static FHIRPathParser.ExpressionContext compile(String expr)

isTypeCompatible

public static boolean isTypeCompatible(FHIRPathSystemValue leftValue,
                                       FHIRPathSystemValue rightValue)

isResourceNode

public static boolean isResourceNode(Collection<FHIRPathNode> nodes)

getResourceNode

public static FHIRPathResourceNode getResourceNode(Collection<FHIRPathNode> nodes)

isElementNode

public static boolean isElementNode(Collection<FHIRPathNode> nodes)

getElementNode

public static FHIRPathElementNode getElementNode(Collection<FHIRPathNode> nodes)

isCodedElementNode

public static boolean isCodedElementNode(Collection<FHIRPathNode> nodes)

isCodedElementNode

public static boolean isCodedElementNode(FHIRPathElementNode elementNode)

isCodedElement

public static boolean isCodedElement(Element element)

isStringElementNode

public static boolean isStringElementNode(Collection<FHIRPathNode> nodes)

isStringElementNode

public static boolean isStringElementNode(FHIRPathElementNode elementNode)

isUriElementNode

public static boolean isUriElementNode(Collection<FHIRPathNode> nodes)

isQuantityNode

public static boolean isQuantityNode(Collection<FHIRPathNode> nodes)

getQuantityNode

public static FHIRPathQuantityNode getQuantityNode(Collection<FHIRPathNode> nodes)

getDecimal

public static BigDecimal getDecimal(Collection<FHIRPathNode> nodes)

getInteger

public static Integer getInteger(Collection<FHIRPathNode> nodes)

getString

public static String getString(Collection<FHIRPathNode> nodes)

getBoolean

public static Boolean getBoolean(Collection<FHIRPathNode> nodes)

getDate

public static TemporalAccessor getDate(Collection<FHIRPathNode> nodes)

getDateTime

public static TemporalAccessor getDateTime(Collection<FHIRPathNode> nodes)

getTime

public static TemporalAccessor getTime(Collection<FHIRPathNode> nodes)

hasSystemValue

public static boolean hasSystemValue(Collection<FHIRPathNode> nodes)

getSystemValue

public static FHIRPathSystemValue getSystemValue(Collection<FHIRPathNode> nodes)

hasSystemValue

public static boolean hasSystemValue(FHIRPathNode node)

getSystemValue

public static FHIRPathSystemValue getSystemValue(FHIRPathNode node)

getStringValue

public static FHIRPathStringValue getStringValue(Collection<FHIRPathNode> nodes)

getQuantityValue

public static FHIRPathQuantityValue getQuantityValue(Collection<FHIRPathNode> nodes)

getIntegerValue

public static FHIRPathIntegerValue getIntegerValue(Collection<FHIRPathNode> nodes)

getDecimalValue

public static FHIRPathDecimalValue getDecimalValue(Collection<FHIRPathNode> nodes)

getNumberValue

public static FHIRPathNumberValue getNumberValue(Collection<FHIRPathNode> nodes)

getTemporalValue

public static FHIRPathTemporalValue getTemporalValue(Collection<FHIRPathNode> nodes)

getBooleanValue

public static FHIRPathBooleanValue getBooleanValue(Collection<FHIRPathNode> nodes)

hasBooleanValue

public static boolean hasBooleanValue(Collection<FHIRPathNode> nodes)

hasNumberValue

public static boolean hasNumberValue(Collection<FHIRPathNode> nodes)

hasDecimalValue

public static boolean hasDecimalValue(Collection<FHIRPathNode> nodes)

hasIntegerValue

public static boolean hasIntegerValue(Collection<FHIRPathNode> nodes)

hasTemporalValue

public static boolean hasTemporalValue(Collection<FHIRPathNode> nodes)

hasDateValue

public static boolean hasDateValue(Collection<FHIRPathNode> nodes)

getDateValue

public static FHIRPathDateValue getDateValue(Collection<FHIRPathNode> nodes)

hasDateTimeValue

public static boolean hasDateTimeValue(Collection<FHIRPathNode> nodes)

getDateTimeValue

public static FHIRPathDateTimeValue getDateTimeValue(Collection<FHIRPathNode> nodes)

hasTimeValue

public static boolean hasTimeValue(Collection<FHIRPathNode> nodes)

getTimeValue

public static FHIRPathTimeValue getTimeValue(Collection<FHIRPathNode> nodes)

hasStringValue

public static boolean hasStringValue(Collection<FHIRPathNode> nodes)

hasQuantityValue

public static boolean hasQuantityValue(Collection<FHIRPathNode> nodes)

evaluatesToBoolean

public static boolean evaluatesToBoolean(Collection<FHIRPathNode> nodes)

evaluatesToTrue

public static boolean evaluatesToTrue(Collection<FHIRPathNode> nodes)

Indicates whether the input collection evaluates to a boolean value per: Singleton Evaluation of Collections

Parameters:

nodes - the input collection

Returns:

true if the input collection evaluates to a boolean value, false otherwise

isTrue

public static boolean isTrue(Collection<FHIRPathNode> nodes)

Indicates whether convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a true value for the input collection

Parameters:

nodes - the input collection

Returns:

true iff convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a true value for the input collection, false otherwise

isFalse

public static boolean isFalse(Collection<FHIRPathNode> nodes)

Indicates whether convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a false value for the input collection

Parameters:

nodes - the input collection

Returns:

true iff convertsToBoolean(java.util.Collection<com.ibm.fhir.path.FHIRPathNode>) returns a false value for the input collection, false otherwise

convertsToBoolean

public static boolean convertsToBoolean(Collection<FHIRPathNode> nodes)

Indicates whether the input collection can be implicitly or explicitly converted to a boolean value per: Boolean Conversion Functions

Parameters:

nodes - the input collection

Returns:

true if the input collection can be explicitly or implicitly converted to a boolean value, false otherwise

toBoolean

public static boolean toBoolean(Collection<FHIRPathNode> nodes)

convertsToDate

public static boolean convertsToDate(Collection<FHIRPathNode> nodes)

toDate

public static FHIRPathDateValue toDate(Collection<FHIRPathNode> nodes)

convertsToDateTime

public static boolean convertsToDateTime(Collection<FHIRPathNode> nodes)

toDateTime

public static FHIRPathDateTimeValue toDateTime(Collection<FHIRPathNode> nodes)

convertsToTime

public static boolean convertsToTime(Collection<FHIRPathNode> nodes)

toTime

public static FHIRPathTimeValue toTime(Collection<FHIRPathNode> nodes)

isSingleton

public static boolean isSingleton(Collection<FHIRPathNode> nodes)

isSingleton

public static <T extends FHIRPathNode> boolean isSingleton(Collection<FHIRPathNode> nodes,
                                                           Class<T> nodeType)

isSystemValue

public static boolean isSystemValue(Collection<FHIRPathNode> nodes)

isStringValue

public static boolean isStringValue(Collection<FHIRPathNode> nodes)

isBooleanValue

public static boolean isBooleanValue(Collection<FHIRPathNode> nodes)

isIntegerValue

public static boolean isIntegerValue(Collection<FHIRPathNode> nodes)

isDecimalValue

public static boolean isDecimalValue(Collection<FHIRPathNode> nodes)

getSingleton

public static FHIRPathNode getSingleton(Collection<FHIRPathNode> nodes)

Throws:

IllegalArgumentException - if the passed collection is not a singleton

getSingleton

public static <T extends FHIRPathNode> T getSingleton(Collection<FHIRPathNode> nodes,
                                                      Class<T> nodeType)

singleton

public static Collection<FHIRPathNode> singleton(FHIRPathNode node)

empty

public static Collection<FHIRPathNode> empty()

getTemporalAccessor

public static TemporalAccessor getTemporalAccessor(Temporal temporal,
                                                   Class<?> targetType)

getTemporal

public static Temporal getTemporal(TemporalAccessor temporalAccessor)

getTemporalAmount

public static TemporalAmount getTemporalAmount(FHIRPathQuantityValue quantityValue)

getChronoUnit

public static ChronoUnit getChronoUnit(String unit)

buildSimpleTypeInfo

public static SimpleTypeInfo buildSimpleTypeInfo(FHIRPathType type)

buildTupleTypeInfo

public static TupleTypeInfo buildTupleTypeInfo(Class<?> modelClass)

buildTupleTypeInfoElement

public static TupleTypeInfoElement buildTupleTypeInfoElement(ModelSupport.ElementInfo elementInfo)

buildClassInfo

public static ClassInfo buildClassInfo(FHIRPathType type)

buildClassInfoElement

public static ClassInfoElement buildClassInfoElement(ModelSupport.ElementInfo elementInfo)

unordered

public static Collection<FHIRPathNode> unordered(Collection<FHIRPathNode> nodes)

isOrdered

public static boolean isOrdered(Collection<FHIRPathNode> nodes)

isUnordered

public static boolean isUnordered(Collection<FHIRPathNode> nodes)

getPrecision

public static ChronoField getPrecision(TemporalAccessor temporalAccessor)

getPrecision

public static ChronoField getPrecision(TemporalAccessor temporalAccessor,
                                       String text)

hasTemporalValue

public static boolean hasTemporalValue(FHIRPathNode node)

getTemporalValue

public static FHIRPathTemporalValue getTemporalValue(FHIRPathNode node)

unescape

public static String unescape(String s)

add

public static <T extends Visitable> T add(T elementOrResource,
                                          String fhirPath,
                                          String elementName,
                                          Visitable value)
                                   throws FHIRPathException,
                                          FHIRPatchException

The content will be appended to the element identified in the path, using the name specified. Add can used for non-repeating elements as long as they do not already exist.

Throws:

FHIRPathException

FHIRPatchException

NullPointerException - if any of the passed arguments are null

delete

public static <T extends Visitable> T delete(T elementOrResource,
                                             String fhirPath)
                                      throws FHIRPathException,
                                             FHIRPatchException

Only a single element can be deleted

Throws:

FHIRPathException

FHIRPatchException

NullPointerException - if any of the passed arguments are null

replace

public static <T extends Visitable> T replace(T elementOrResource,
                                              String fhirPath,
                                              Visitable value)
                                       throws FHIRPathException,
                                              FHIRPatchException

Parameters:

fhirPath -

value -

Throws:

FHIRPathException

FHIRPatchException

NullPointerException - if any of the passed arguments are null

insert

public static <T extends Visitable> T insert(T elementOrResource,
                                             String fhirPath,
                                             int index,
                                             Visitable value)
                                      throws FHIRPathException,
                                             FHIRPatchException

The content will be inserted into the nominated list at the index specified (0 based). The index is mandatory and must be equal or less than the number of elements in the list. Note: add is easier than insert at the end of the list.

Throws:

FHIRPathException

FHIRPatchException

NullPointerException - if any of the passed arguments are null

move

public static <T extends Visitable> T move(T elementOrResource,
                                           String fhirPath,
                                           int source,
                                           int target)
                                    throws FHIRPathException,
                                           FHIRPatchException

Move an element within a single list

Throws:

FHIRPathException

FHIRPatchException

NullPointerException - if any of the passed arguments are null

getResourceNode

public static FHIRPathResourceNode getResourceNode(FHIRPathTree tree,
                                                   FHIRPathNode node)

Get the resource node to use as a value for the %resource external constant.

Parameters:

tree - the FHIRPath tree

node - the context node

Returns:

the resource node, or null if not exists

getRootResourceNode

public static FHIRPathResourceNode getRootResourceNode(FHIRPathTree tree,
                                                       FHIRPathNode node)

Get the resource node to use as a value for the %rootResource external constant.

Parameters:

tree - the FHIRPath tree

node - the context node

Returns:

the rootResource node, or null if not exists

getSystem

public static Uri getSystem(FHIRPathTree tree,
                            FHIRPathElementNode elementNode)

Get the URI-typed sibling of the given element node with name "system".

Parameters:

tree - the tree

elementNode - the element node

Returns:

the URI-typed sibling of the given element node with name "system", or null if no such sibling exists

getVersion

public static String getVersion(FHIRPathTree tree,
                                FHIRPathElementNode elementNode)

Get the String-typed sibling of the given element node with name "version".

Parameters:

tree - the tree

elementNode - the element node

Returns:

the String-typed sibling of the given element node with name "version", or null if no such sibling exists

getDisplay

public static String getDisplay(FHIRPathTree tree,
                                FHIRPathElementNode elementNode)

Get the String-typed sibling of the given element node with name "display".

Parameters:

tree - the tree

elementNode - the element node

Returns:

the String-typed sibling of the given element node with name "display", or null if no such sibling exists