com.cerner.bunsen.spark.codes.broadcast

Class BroadcastableValueSets

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class BroadcastableValueSets
extends Object
implements Serializable

An immutable collection of value sets that can be broadcast for use in Spark transformations or user-defined functions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BroadcastableValueSets.AncestorValue Bean-style class to represent ancestor values locally and as Spark datasets.
static class	BroadcastableValueSets.Builder
static class	BroadcastableValueSets.Reference Bean-style class to represent a reference to a value set.

Method Summary

Modifier and Type	Method and Description
Set<String>	getReferenceNames() Returns the reference names in the value set.
Map<String,Set<String>>	getValues(String referenceName) Returns a map of code systems to the set of code values within those systems used by the given valueset reference.
boolean	hasCode(String referenceName, String system, String code) Returns true if the value set with the given reference name includes the given code value.
static BroadcastableValueSets.Builder	newBuilder() Returns a BroadcastableValueSets builder.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static BroadcastableValueSets.Builder newBuilder()

Returns a BroadcastableValueSets builder.

Returns:

a BroadcastableValueSets builder.

hasCode

public boolean hasCode(String referenceName,
                       String system,
                       String code)

Returns true if the value set with the given reference name includes the given code value.

Parameters:

referenceName - the reference name registered for the value set

system - the code system to check if it is contained

code - the code value to check if it is contained

Returns:

true if contained, false otherwise.

Throws:

IllegalArgumentException - if the referenceName is not known to this object

getReferenceNames

public Set<String> getReferenceNames()

Returns the reference names in the value set.

Returns:

the set of reference names.

getValues

public Map<String,Set<String>> getValues(String referenceName)

Returns a map of code systems to the set of code values within those systems used by the given valueset reference.

Parameters:

referenceName - the reference name for which to retrieve values

Returns:

a map of the code systems to the code values used by the reference.