com.cerner.bunsen.spark

Class ValueSetUdfs

java.lang.Object

com.cerner.bunsen.spark.ValueSetUdfs

public class ValueSetUdfs
extends Object

Support for user-defined functions that use valuesets. This class offers users a stack to push and pop valuesets used in the in_valuesets UDF, allowing callers to temporarily override valuesets and then simply pop them to revert to the previous state.

The in_valueset UDF allows the user to check whether a given CodeableConcept (or sequence of CodeableConcepts) have a Coding field in a ValueSet specified by a Reference name. It can be called SparkSQL as in_valueset(codeProperty, 'Reference').

Constructor Summary

Constructors

Constructor and Description
ValueSetUdfs()

Method Summary

Modifier and Type	Method and Description
static org.apache.spark.broadcast.Broadcast<BroadcastableValueSets>	currentValueSets() Returns the broadcast variable of the current valuesets so they can be used in other user-defined functions.
static boolean	popUdf(org.apache.spark.sql.SparkSession spark) Pops a BroadcastableValueSets from the user-defined function stack.
static void	pushUdf(org.apache.spark.sql.SparkSession spark, org.apache.spark.broadcast.Broadcast<BroadcastableValueSets> broadcast) Pushes an "in_valueset" UDF that uses an already broadcast instance of BroadcastableValueSets for its content.
static void	pushUdf(org.apache.spark.sql.SparkSession spark, BroadcastableValueSets valueSets) Pushes an "in_valueset" UDF that uses the given BroadcastableValueSets for its content.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueSetUdfs

public ValueSetUdfs()

Method Detail

pushUdf

public static void pushUdf(org.apache.spark.sql.SparkSession spark,
                           BroadcastableValueSets valueSets)

Pushes an "in_valueset" UDF that uses the given BroadcastableValueSets for its content.

Parameters:

spark - the spark session

valueSets - the valuesets to use in the UDF

pushUdf

public static void pushUdf(org.apache.spark.sql.SparkSession spark,
                           org.apache.spark.broadcast.Broadcast<BroadcastableValueSets> broadcast)

Pushes an "in_valueset" UDF that uses an already broadcast instance of BroadcastableValueSets for its content.

Parameters:

spark - the spark session

broadcast - the broadcast valuesets to use in the UDF

popUdf

public static boolean popUdf(org.apache.spark.sql.SparkSession spark)

Pops a BroadcastableValueSets from the user-defined function stack.

Parameters:

spark - the spark session

Returns:

true if there is still a registered in_valuset UDF, false otherwise

currentValueSets

public static org.apache.spark.broadcast.Broadcast<BroadcastableValueSets> currentValueSets()

Returns the broadcast variable of the current valuesets so they can be used in other user-defined functions.

Returns:

the broadcast variable of the current valuesets, or null if none exists.