ConceptMaps (Bunsen Core 0.2.2 API)

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONCEPT_MAP_TABLE` Defalt table name where concept maps are stored.
`static String`	`MAPPING_DATABASE` Default database name where mapping information is stored.
`static String`	`MAPPING_TABLE` Default table name where expanded mapping information is stored.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static List<Mapping>`	`expandMappings(org.hl7.fhir.dstu3.model.ConceptMap map)` Given a concept map, returns a list of mapping records it contains.
`org.hl7.fhir.dstu3.model.ConceptMap`	`getConceptMap(String uri, String version)` Returns the concept map with the given uri and version, or null if there is no such map.
`static org.apache.spark.sql.Encoder<org.hl7.fhir.dstu3.model.ConceptMap>`	`getConceptMapEncoder()` Returns the encoder for concept maps.
`static ConceptMaps`	`getDefault(org.apache.spark.sql.SparkSession spark)` Returns the collection of concept maps from the default database and tables.
`static ConceptMaps`	`getEmpty(org.apache.spark.sql.SparkSession spark)` Returns an empty ConceptMaps instance.
`static ConceptMaps`	`getFromDatabase(org.apache.spark.sql.SparkSession spark, String databaseName)` Returns the collection of concept maps from the tables in the given database.
`org.apache.spark.sql.Dataset<Mapping>`	`getLatestMappings(Set<String> uris, boolean includeExperimental)` Returns a dataset with the latest mappings for each valueset here.
`Map<String,String>`	`getLatestVersions(boolean includeExperimental)` Returns the latest versions of all concept maps.
`Map<String,String>`	`getLatestVersions(Set<String> urls, boolean includeExperimental)` Returns the latest versions of a given set of concept maps.
`static org.apache.spark.sql.Encoder<Mapping>`	`getMappingEncoder()` Returns the encoder for mappings.
`org.apache.spark.sql.Dataset<Mapping>`	`getMappings()` Returns a dataset of all mappings in this collection.
`org.apache.spark.sql.Dataset<Mapping>`	`getMappings(Map<String,String> uriToVersion)` Returns a dataset with the mappings for each uri and version.
`org.apache.spark.sql.Dataset<Mapping>`	`getMappings(String uri, String version)` Returns the mappings for the given URI and version.
`org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ConceptMap>`	`getMaps()` Returns a dataset of concept maps to inspect metadata.
`static org.apache.spark.sql.Encoder<UrlAndVersion>`	`getUrlAndVersionEncoder()` Returns the encoder for UrlAndVersion tuples.
`ConceptMaps`	`withConceptMaps(org.hl7.fhir.dstu3.model.ConceptMap... conceptMap)` Returns a new ConceptMaps instance that includes the given map.
`ConceptMaps`	`withConceptMaps(org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ConceptMap> conceptMaps)` Returns a new ConceptMaps instance that includes the given maps.
`ConceptMaps`	`withConceptMaps(List<org.hl7.fhir.dstu3.model.ConceptMap> conceptMaps)` Returns a new ConceptMaps instance that includes the given maps.
`ConceptMaps`	`withDisjointMapsFromDirectory(String path)` Returns all concept maps that are disjoint with concept maps stored in the default database and adds them to our collection.
`ConceptMaps`	`withDisjointMapsFromDirectory(String path, String database)` Returns all concept maps that are disjoint with concept maps stored in the default database and adds them to our collection.
`ConceptMaps`	`withExpandedMap(org.hl7.fhir.dstu3.model.ConceptMap conceptMap, org.apache.spark.sql.Dataset<Mapping> mappings)` Returns a new ConceptMaps instance that includes the given map and expanded mappings.
`ConceptMaps`	`withMapsFromDirectory(String path)` Reads all concept maps from a given directory and adds them to our collection.
`void`	`writeToDatabase(String database)` Writes the updated concept maps to a database using the default "mappings" and "conceptmaps" table names.
`void`	`writeToTables(String mappingsTable, String conceptMapTable)` Writes mappings to the given tables.

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

- Field Detail
  - MAPPING_DATABASE
```
public static final String MAPPING_DATABASE
```
    Default database name where mapping information is stored.
    
    See Also:
    
    Constant Field Values
  - MAPPING_TABLE
```
public static final String MAPPING_TABLE
```
    Default table name where expanded mapping information is stored.
    
    See Also:
    
    Constant Field Values
  - CONCEPT_MAP_TABLE
```
public static final String CONCEPT_MAP_TABLE
```
    Defalt table name where concept maps are stored.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMappingEncoder
```
public static org.apache.spark.sql.Encoder<Mapping> getMappingEncoder()
```
    Returns the encoder for mappings.
    
    Returns:
    
    an encoder for mappings.
  - getConceptMapEncoder
```
public static org.apache.spark.sql.Encoder<org.hl7.fhir.dstu3.model.ConceptMap> getConceptMapEncoder()
```
    Returns the encoder for concept maps.
    
    Returns:
    
    an encoder for concept maps.
  - getUrlAndVersionEncoder
```
public static org.apache.spark.sql.Encoder<UrlAndVersion> getUrlAndVersionEncoder()
```
    Returns the encoder for UrlAndVersion tuples.
    
    Returns:
    
    an encoder for UrlAndVersion tuples.
  - getDefault
```
public static ConceptMaps getDefault(org.apache.spark.sql.SparkSession spark)
```
    Returns the collection of concept maps from the default database and tables.
    
    Parameters:
    
    spark - the spark session
    
    Returns:
    
    a ConceptMaps instance.
  - getFromDatabase
```
public static ConceptMaps getFromDatabase(org.apache.spark.sql.SparkSession spark,
                                          String databaseName)
```
    Returns the collection of concept maps from the tables in the given database.
    
    Parameters:
    
    spark - the spark session
    
    databaseName - name of the database containing the conceptmaps and mappings tables.
    
    Returns:
    
    a ConceptMaps instance.
  - getEmpty
```
public static ConceptMaps getEmpty(org.apache.spark.sql.SparkSession spark)
```
    Returns an empty ConceptMaps instance.
    
    Parameters:
    
    spark - the spark session
    
    Returns:
    
    an empty ConceptMaps instance.
  - expandMappings
```
public static List<Mapping> expandMappings(org.hl7.fhir.dstu3.model.ConceptMap map)
```
    Given a concept map, returns a list of mapping records it contains.
    
    Parameters:
    
    map - a concept map
    
    Returns:
    
    a list of Mapping records.
  - withConceptMaps
```
public ConceptMaps withConceptMaps(org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ConceptMap> conceptMaps)
```
    Returns a new ConceptMaps instance that includes the given maps.
    
    Parameters:
    
    conceptMaps - concept maps to add to the returned collection.
    
    Returns:
    
    a new ConceptMaps instance with the values added.
  - withConceptMaps
```
public ConceptMaps withConceptMaps(org.hl7.fhir.dstu3.model.ConceptMap... conceptMap)
```
    Returns a new ConceptMaps instance that includes the given map.
    
    Parameters:
    
    conceptMap - concept maps to add
    
    Returns:
    
    a new ConceptMaps instance with the values added.
  - withConceptMaps
```
public ConceptMaps withConceptMaps(List<org.hl7.fhir.dstu3.model.ConceptMap> conceptMaps)
```
    Returns a new ConceptMaps instance that includes the given maps.
    
    Parameters:
    
    conceptMaps - concept maps to add
    
    Returns:
    
    a new ConceptMaps instance with the values added.
  - withExpandedMap
```
public ConceptMaps withExpandedMap(org.hl7.fhir.dstu3.model.ConceptMap conceptMap,
                                   org.apache.spark.sql.Dataset<Mapping> mappings)
```
    Returns a new ConceptMaps instance that includes the given map and expanded mappings. This method is convenient when mappings themselves are loaded from some ETL operation that produces them.
    
    Parameters:
    
    conceptMap - concept map to add
    
    mappings - dataset of mappings to add to add
    
    Returns:
    
    a new ConceptMaps instance with the values added.
  - withMapsFromDirectory
```
public ConceptMaps withMapsFromDirectory(String path)
```
    Reads all concept maps 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 concept maps will be loaded
    
    Returns:
    
    a instance of ConceptMaps that includes the contents from that directory.
  - withDisjointMapsFromDirectory
```
public ConceptMaps withDisjointMapsFromDirectory(String path)
```
    Returns all concept maps that are disjoint with concept maps 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 concept maps will be loaded
    
    Returns:
    
    an instance of ConceptMaps that includes content from that directory that is disjoint with content already contained in the default database.
  - withDisjointMapsFromDirectory
```
public ConceptMaps withDisjointMapsFromDirectory(String path,
                                                 String database)
```
    Returns all concept maps that are disjoint with concept maps 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 concept maps will be loaded
    
    database - the database to check concept maps against
    
    Returns:
    
    an instance of ConceptMaps that includes content from that directory that is disjoint with content already contained in the default database.
  - getConceptMap
```
public org.hl7.fhir.dstu3.model.ConceptMap getConceptMap(String uri,
                                                         String version)
```
    Returns the concept map with the given uri and version, or null if there is no such map.
    
    Parameters:
    
    uri - the uri of the map to return
    
    version - the version of the map to return
    
    Returns:
    
    the specified concept map.
  - getMaps
```
public org.apache.spark.sql.Dataset<org.hl7.fhir.dstu3.model.ConceptMap> getMaps()
```
    Returns a dataset of concept maps to inspect metadata. Since the mappings themselves can be quite large, the maps in this dataset do not contain them. Instead, users should use the getMappings() method to query mappings in depth.
    
    Returns:
    
    a dataset of concept maps that do not contain mappings.
  - getMappings
```
public org.apache.spark.sql.Dataset<Mapping> getMappings()
```
    Returns a dataset of all mappings in this collection. This is generally used for inspection and debugging of mappings.
    
    Returns:
    
    a dataset of all mappings.
  - getMappings
```
public org.apache.spark.sql.Dataset<Mapping> getMappings(String uri,
                                                         String version)
```
    Returns the mappings for the given URI and version.
    
    Parameters:
    
    uri - the uri of the concept map for which we get mappings
    
    version - the version of the concept map for which we get mappings
    
    Returns:
    
    a dataset of mappings for the given URI and version.
  - getMappings
```
public org.apache.spark.sql.Dataset<Mapping> getMappings(Map<String,String> uriToVersion)
```
    Returns a dataset with the mappings for each uri and version.
    
    Parameters:
    
    uriToVersion - a map of concept map URI to the version to load
    
    Returns:
    
    a dataset of mappings for the given URIs and versions.
  - getLatestMappings
```
public org.apache.spark.sql.Dataset<Mapping> getLatestMappings(Set<String> uris,
                                                               boolean includeExperimental)
```
    Returns a dataset with the latest mappings for each valueset here.
    
    Parameters:
    
    uris - URIs for the value sets
    
    includeExperimental - include valuesets labeled as experimental
    
    Returns:
    
    a dataset of the latest mappings for them.
  - getLatestVersions
```
public Map<String,String> getLatestVersions(boolean includeExperimental)
```
    Returns the latest versions of all concept maps.
    
    Parameters:
    
    includeExperimental - flag to include concept maps marked as experimental
    
    Returns:
    
    a map of concept map URLs to the latest version for them.
  - getLatestVersions
```
public Map<String,String> getLatestVersions(Set<String> urls,
                                            boolean includeExperimental)
```
    Returns the latest versions of a given set of concept maps.
    
    Parameters:
    
    urls - a set of URLs to retrieve the latest version for, or null to load them all.
    
    includeExperimental - flag to include concept maps marked as experimental
    
    Returns:
    
    a map of concept map URLs to the latest version for them.
  - writeToDatabase
```
public void writeToDatabase(String database)
```
    Writes the updated concept maps to a database using the default "mappings" and "conceptmaps" table names.
    
    Parameters:
    
    database - the database name to which the concepts are saved.
  - writeToTables
```
public void writeToTables(String mappingsTable,
                          String conceptMapTable)
```
    Writes mappings 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:
    
    mappingsTable - name of the table containing the mapping records
    
    conceptMapTable - name of the table containing the concept map metadata

Class ConceptMaps

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAPPING_DATABASE

MAPPING_TABLE

CONCEPT_MAP_TABLE

Method Detail

getMappingEncoder

getConceptMapEncoder

getUrlAndVersionEncoder

getDefault

getFromDatabase

getEmpty

expandMappings

withConceptMaps

withConceptMaps

withConceptMaps

withExpandedMap

withMapsFromDirectory

withDisjointMapsFromDirectory

withDisjointMapsFromDirectory

getConceptMap

getMaps

getMappings

getMappings

getMappings

getLatestMappings

getLatestVersions

getLatestVersions

writeToDatabase

writeToTables