com.cerner.bunsen.spark.codes.broadcast

Class BroadcastableValueSets.Builder

java.lang.Object

com.cerner.bunsen.spark.codes.broadcast.BroadcastableValueSets.Builder

Enclosing class:

BroadcastableValueSets

public static class BroadcastableValueSets.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BroadcastableValueSets.Builder	addCode(String referenceName, String system, String code) Adds a code under the given reference name to the value set.
BroadcastableValueSets.Builder	addDescendantsOf(String referenceName, String ancestorSystem, String ancestorValue, String hierarchyUri) Add "descendants" of a given code value, that is code values that are transitively subsumed by the given value in the given hierarchy.
BroadcastableValueSets.Builder	addDescendantsOf(String referenceName, String ancestorSystem, String ancestorValue, String hierarchyUri, String hierarchyVersion) Add "descendants" of a given code value, that is code values that are transitively subsumed by the given value in the given hierarchy.
BroadcastableValueSets.Builder	addReference(String referenceName, String valueSetUri) Add a "reference" to a value set, that is, create a user-defined reference name for a value set of codes.
BroadcastableValueSets.Builder	addReference(String referenceName, String valueSetUri, String valueSetVersion) Add a "reference" to a value set, that is, create a user-defined reference name for a value set of codes.
BroadcastableValueSets	build(org.apache.spark.sql.SparkSession spark, AbstractValueSets valueSets) Returns broadcastable value sets by loading reference data that was added to this builder and the default value sets.
BroadcastableValueSets	build(org.apache.spark.sql.SparkSession spark, AbstractValueSets valueSets, Hierarchies hierarchies) Returns broadcastable value sets by loading reference data that was added to this builder and the given value sets.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addCode

public BroadcastableValueSets.Builder addCode(String referenceName,
                                              String system,
                                              String code)

Adds a code under the given reference name to the value set.

Parameters:

referenceName - the reference name of the value set

system - the code system to add

code - the code value to add

Returns:

this builder.

addReference

public BroadcastableValueSets.Builder addReference(String referenceName,
                                                   String valueSetUri)

Add a "reference" to a value set, that is, create a user-defined reference name for a value set of codes. This method adds a reference using the latest version for the given value set uri.

Parameters:

referenceName - the value set reference name to be used in the user code

valueSetUri - the value set uri that contains codes to reference

Returns:

this builder.

addReference

public BroadcastableValueSets.Builder addReference(String referenceName,
                                                   String valueSetUri,
                                                   String valueSetVersion)

Add a "reference" to a value set, that is, create a user-defined reference name for a value set of codes.

Parameters:

referenceName - the value set reference name to be used in user code

valueSetUri - the value set uri that contains codes to reference

valueSetVersion - the value set version that contains codes to reference

Returns:

this builder.

addDescendantsOf

public BroadcastableValueSets.Builder addDescendantsOf(String referenceName,
                                                       String ancestorSystem,
                                                       String ancestorValue,
                                                       String hierarchyUri)

Add "descendants" of a given code value, that is code values that are transitively subsumed by the given value in the given hierarchy. This uses the latest version of the provided hierarchy.

This function creates a collection of ancestors to query, and the descendants are actually retrieved with the broadcastable value set is built.

Parameters:

referenceName - the valueset reference name to be used in user code.

ancestorSystem - the ancestor system of descendants to include

ancestorValue - the ancestor value of descendants to include

hierarchyUri - the hierarchy URI that defines the descendants

Returns:

this builder

addDescendantsOf

public BroadcastableValueSets.Builder addDescendantsOf(String referenceName,
                                                       String ancestorSystem,
                                                       String ancestorValue,
                                                       String hierarchyUri,
                                                       String hierarchyVersion)

Add "descendants" of a given code value, that is code values that are transitively subsumed by the given value in the given hierarchy.

This function creates a collection of ancestors to query, and the descendants are actually retrieved with the broadcastable value set is built.

Parameters:

referenceName - the valueset reference name to be used in user code.

ancestorSystem - the ancestor system of descendants to include

ancestorValue - the ancestor value of descendants to include

hierarchyUri - the hierarchy URI that defines the descendants

hierarchyVersion - the hierarchy version that defines the descendants

Returns:

this builder

build

public BroadcastableValueSets build(org.apache.spark.sql.SparkSession spark,
                                    AbstractValueSets valueSets)

Returns broadcastable value sets by loading reference data that was added to this builder and the default value sets.

Parameters:

spark - the Spark session used to load reference data

valueSets - a AbstractValueSets instance defining the value set data to load

Returns:

a BroadcastableValueSets instance.

build

public BroadcastableValueSets build(org.apache.spark.sql.SparkSession spark,
                                    AbstractValueSets valueSets,
                                    Hierarchies hierarchies)

Returns broadcastable value sets by loading reference data that was added to this builder and the given value sets.

Parameters:

spark - the Spark session used to load reference data

valueSets - a AbstractValueSets instance defining the value set data to load

hierarchies - a Hierarchies instance defining hierarchical reference data to load

Returns:

a BroadcastableValueSets instance.