ValueSets (Bunsen Core 0.2.2 API)

java.lang.Object
- com.cerner.bunsen.codes.ValueSets

```
public class ValueSets
extends Object
```
An immutable collection of FHIR ValueSets. This class is used to import value set content, explore it, and persist it to a database.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`VALUE_SETS_DATABASE` Default database name where the value sets information is stored.
`static String`	`VALUE_SETS_TABLE` Default table name where value sets metadata is stored.
`static String`	`VALUES_TABLE` Default table name where the expanded values information is stored.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static List<Value>`	`expandValues(org.hl7.fhir.dstu3.model.ValueSet valueSet)` Given a value set, returns a list of value records it contains.
`static ValueSets`	`getDefault(org.apache.spark.sql.SparkSession spark)` Returns the collection of value sets from the default database and tables.
`static ValueSets`	`getEmpty(org.apache.spark.sql.SparkSession spark)` Returns an empty ValueSets instance.
`static ValueSets`	`getFromDatabase(org.apache.spark.sql.SparkSession spark, String databaseName)` Returns the collection of value sets from the tables in the given database.
`org.apache.spark.sql.Dataset<Value>`	`getLatestValues(Set<String> uris, boolean includeExperimental)` Returns a dataset with the latest values for each valueset of the given uris.
`Map<String,String>`	`getLatestVersions(boolean includeExperimental)` Returns the latest version of all value sets.
`Map<String,String>`	`getLatestVersions(Set<String> uris, boolean includeExperimental)` Returns the latest versions of a given set of value sets.
`static org.apache.spark.sql.Encoder<UrlAndVersion>`	`getUrlAndVersionEncoder()` Returns the encoder for UrlAndVersion tuples.
`static org.apache.spark.sql.Encoder<Value>`	`getValueEncoder()` Returns the encoder for values.
`org.apache.spark.sql.Dataset<Value>`	`getValues()` Returns a dataset of all values in this collection.
`org.apache.spark.sql.Dataset<Value>`	`getValues(Map<String,String> uriToVersion)` Returns a dataset with the values for each element in the map of uri to version.
`org.apache.spark.sql.Dataset<Value>`	`getValues(String uri, String version)` Returns the values for the given URI and version.
`org.hl7.fhir.dstu3.model.ValueSet`	`getValueSet(String uri, String version)` Returns the value set with the given uri and version, or null if there is no such value set.
`static org.apache.spark.sql.Encoder<org.hl7.fhir.dstu3.model.ValueSet>`	`getValueSetEncoder()` Returns the encoder for value sets.
`org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ValueSet>`	`getValueSets()` Returns a dataset of value sets to inspect metadata.
`ValueSets`	`withDisjointValueSetsFromDirectory(String path)` Returns all value sets that are disjoint with value sets stored in the default database and adds them to our collection.
`ValueSets`	`withDisjointValueSetsFromDirectory(String path, String database)` Returns all value sets that are disjoint with value sets stored in the given database and adds them to our collection.
`ValueSets`	`withValueSets(org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ValueSet> valueSets)` Returns a new ValueSets instance that includes the given value sets.
`ValueSets`	`withValueSets(List<org.hl7.fhir.dstu3.model.ValueSet> valueSets)`
`ValueSets`	`withValueSets(org.hl7.fhir.dstu3.model.ValueSet... valueSets)` Returns a new ValueSets instance that includes the given value sets.
`ValueSets`	`withValueSetsFromDirectory(String path)` Reads all value sets from a given directory and adds them to our collection.
`void`	`writeToDatabase()` Writes the the value sets to the default database "ontologies" using default table names: "values", and "valuesets".
`void`	`writeToDatabase(String database)` Writes the value sets to the given database using default table names: "values", "valuesets", and "ancestors".
`void`	`writeToTables(String valuesTable, String valueSetTable)` Writes value sets to the given tables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VALUE_SETS_DATABASE
```
public static final String VALUE_SETS_DATABASE
```
    Default database name where the value sets information is stored.
    
    See Also:
    
    Constant Field Values
  - VALUES_TABLE
```
public static final String VALUES_TABLE
```
    Default table name where the expanded values information is stored.
    
    See Also:
    
    Constant Field Values
  - VALUE_SETS_TABLE
```
public static final String VALUE_SETS_TABLE
```
    Default table name where value sets metadata is stored.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getValueEncoder
```
public static org.apache.spark.sql.Encoder<Value> getValueEncoder()
```
    Returns the encoder for values.
    
    Returns:
    
    the encoder for values.
  - getValueSetEncoder
```
public static org.apache.spark.sql.Encoder<org.hl7.fhir.dstu3.model.ValueSet> getValueSetEncoder()
```
    Returns the encoder for value sets.
    
    Returns:
    
    the encoder for value sets.
  - getUrlAndVersionEncoder
```
public static org.apache.spark.sql.Encoder<UrlAndVersion> getUrlAndVersionEncoder()
```
    Returns the encoder for UrlAndVersion tuples.
    
    Returns:
    
    the encoder for UrlAndVersion tuples.
  - getDefault
```
public static ValueSets getDefault(org.apache.spark.sql.SparkSession spark)
```
    Returns the collection of value sets from the default database and tables.
    
    Parameters:
    
    spark - the spark session
    
    Returns:
    
    a ValueSets instance.
  - getFromDatabase
```
public static ValueSets getFromDatabase(org.apache.spark.sql.SparkSession spark,
                                        String databaseName)
```
    Returns the collection of value sets from the tables in the given database.
    
    Parameters:
    
    spark - the spark session
    
    databaseName - name of the database containing the value sets and values tables
    
    Returns:
    
    a ValueSets instance.
  - getEmpty
```
public static ValueSets getEmpty(org.apache.spark.sql.SparkSession spark)
```
    Returns an empty ValueSets instance.
    
    Parameters:
    
    spark - the spark session
    
    Returns:
    
    an empty ValueSets instance.
  - getValues
```
public org.apache.spark.sql.Dataset<Value> getValues()
```
    Returns a dataset of all values in this collection. This is generally used for inspection and debugging of values.
    
    Returns:
    
    a dataset of all values.
  - getValues
```
public org.apache.spark.sql.Dataset<Value> getValues(String uri,
                                                     String version)
```
    Returns the values for the given URI and version.
    
    Parameters:
    
    uri - the uri of the value set for which we get values
    
    version - the version of the value set for which we get values
    
    Returns:
    
    a dataset of values for the given URI and version.
  - getValues
```
public org.apache.spark.sql.Dataset<Value> getValues(Map<String,String> uriToVersion)
```
    Returns a dataset with the values for each element in the map of uri to version.
    
    Parameters:
    
    uriToVersion - a map of value set URI to the version to load
    
    Returns:
    
    a dataset of values for the given URIs and versions.
  - getLatestVersions
```
public Map<String,String> getLatestVersions(boolean includeExperimental)
```
    Returns the latest version of all value sets.
    
    Parameters:
    
    includeExperimental - whether to include value sets marked as experimental
    
    Returns:
    
    a map of value set URIs to the latest version for them.
  - getLatestVersions
```
public Map<String,String> getLatestVersions(Set<String> uris,
                                            boolean includeExperimental)
```
    Returns the latest versions of a given set of value sets.
    
    Parameters:
    
    uris - a set of URIs for which to retrieve the latest versions, or null to load them all
    
    includeExperimental - whether to include value sets marked as experimental
    
    Returns:
    
    a map of value set URIs to the latest versions for them.
  - getLatestValues
```
public org.apache.spark.sql.Dataset<Value> getLatestValues(Set<String> uris,
                                                           boolean includeExperimental)
```
    Returns a dataset with the latest values for each valueset of the given uris.
    
    Parameters:
    
    uris - URIs for the value sets
    
    includeExperimental - whether to include value sets marked as experimental
    
    Returns:
    
    a dataset of the latest mappings for them.
  - getValueSet
```
public org.hl7.fhir.dstu3.model.ValueSet getValueSet(String uri,
                                                     String version)
```
    Returns the value set with the given uri and version, or null if there is no such value set.
    
    Parameters:
    
    uri - the uri of the value set to return
    
    version - the version of the value set to return
    
    Returns:
    
    the specified value set.
  - getValueSets
```
public org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ValueSet> getValueSets()
```
    Returns a dataset of value sets to inspect metadata. Since the value sets themselves can be quite large, the values in this dataset do not contain them. Instead, users should use the getValues() method to query values in depth.
    
    Returns:
    
    a dataset of value sets that do not contain concept values.
  - withValueSetsFromDirectory
```
public ValueSets withValueSetsFromDirectory(String path)
```
    Reads all value sets from a given directory and adds them to our collection. The directory may be anything readable from a Spark path, including local filesystems, HDFS, S3, or others.
    
    Parameters:
    
    path - a path from which value sets will be loaded
    
    Returns:
    
    an instance of ValueSets that includes the contents from that directory.
  - withDisjointValueSetsFromDirectory
```
public ValueSets withDisjointValueSetsFromDirectory(String path)
```
    Returns all value sets that are disjoint with value sets stored in the default database and adds them to our collection. The directory may be anything readable from a Spark path, including local filesystems, HDFS, S3, or others.
    
    Parameters:
    
    path - a path from which disjoint value sets will be loaded
    
    Returns:
    
    an instance of ValueSets that includes content from that directory that is disjoint with content already contained in the default database.
  - withDisjointValueSetsFromDirectory
```
public ValueSets withDisjointValueSetsFromDirectory(String path,
                                                    String database)
```
    Returns all value sets that are disjoint with value sets stored in the given database and adds them to our collection. The directory may be anything readable from a Spark path, including local filesystems, HDFS, S3, or others.
    
    Parameters:
    
    path - a path from which disjoint value sets will be loaded
    
    database - the database to check value sets against
    
    Returns:
    
    an instance of ValueSets that includes content from that directory that is disjoint with content already contained in the given database.
  - withValueSets
```
public ValueSets withValueSets(org.hl7.fhir.dstu3.model.ValueSet... valueSets)
```
    Returns a new ValueSets instance that includes the given value sets.
    
    Parameters:
    
    valueSets - the value sets to add to the returned collection.
    
    Returns:
    
    a new ValueSets instance with the added value sets.
  - withValueSets
```
public ValueSets withValueSets(List<org.hl7.fhir.dstu3.model.ValueSet> valueSets)
```
  - withValueSets
```
public ValueSets withValueSets(org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ValueSet> valueSets)
```
    Returns a new ValueSets instance that includes the given value sets.
    
    Parameters:
    
    valueSets - the value sets to add to the returned collection.
    
    Returns:
    
    a new ValueSets instance with the added value sets.
  - expandValues
```
public static List<Value> expandValues(org.hl7.fhir.dstu3.model.ValueSet valueSet)
```
    Given a value set, returns a list of value records it contains.
    
    Parameters:
    
    valueSet - a value set
    
    Returns:
    
    a list of Value records.
  - writeToDatabase
```
public void writeToDatabase()
```
    Writes the the value sets to the default database "ontologies" using default table names: "values", and "valuesets".
  - writeToDatabase
```
public void writeToDatabase(String database)
```
    Writes the value sets to the given database using default table names: "values", "valuesets", and "ancestors".
    
    Parameters:
    
    database - the name of the database to which the value sets are saved
  - writeToTables
```
public void writeToTables(String valuesTable,
                          String valueSetTable)
```
    Writes value sets to the given tables.
    Warning: these updates are likely not atomic due to the lack of transactional semantics in the underlying data store. Concurrent users may see previous items removed before new ones are added, or items appear separately than others. This is intended for use in a user-specific sandbox or staging environment.
    
    Parameters:
    
    valuesTable - name of the table to which the value records are saved
    
    valueSetTable - name of the table to which the value set metadata is saved

Class ValueSets

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VALUE_SETS_DATABASE

VALUES_TABLE

VALUE_SETS_TABLE

Method Detail

getValueEncoder

getValueSetEncoder

getUrlAndVersionEncoder

getDefault

getFromDatabase

getEmpty

getValues

getValues

getValues

getLatestVersions

getLatestVersions

getLatestValues

getValueSet

getValueSets

withValueSetsFromDirectory

withDisjointValueSetsFromDirectory

withDisjointValueSetsFromDirectory

withValueSets

withValueSets

withValueSets

expandValues

writeToDatabase

writeToDatabase

writeToTables