com.cerner.bunsen.spark.codes

Class Hierarchies

java.lang.Object

com.cerner.bunsen.spark.codes.Hierarchies

public class Hierarchies
extends Object

An immutable collection of hierarchical systems. This class is used to import ancestor content from hierarchical systems, explore it, and persist it to a database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Hierarchies.HierarchicalElement A JavaBean to represent an element in a hierarchical system from which transitive ancestors can be computed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANCESTORS_TABLE Default table name where expanded ancestor information is stored.
static String	HIERARCHIES_DATABASE Default database name where the ancestor information is stored.
static String	HIERARCHY_URI_PREFIX A URI prefix for hierarchical systems.

Method Summary

Modifier and Type	Method and Description
org.apache.spark.sql.Dataset<Ancestor>	getAncestors() Returns a dataset of all ancestors in this collection.
static Hierarchies	getDefault(org.apache.spark.sql.SparkSession spark) Returns the collection of ancestors from the default database and table.
static Hierarchies	getEmpty(org.apache.spark.sql.SparkSession spark) Returns an empty Hierarchies instance.
static Hierarchies	getFromDatabase(org.apache.spark.sql.SparkSession spark, String database) Returns the collection of ancestors from the table in the given database.
static org.apache.spark.sql.Encoder<Hierarchies.HierarchicalElement>	getHierarchicalElementEncoder() Returns the encoder for hierarchical elements.
Map<String,String>	getLatestVersions() Returns the latest version of all hierarchies.
Map<String,String>	getLatestVersions(Set<String> uris) Returns latest versions of the given hierarchies.
org.apache.spark.sql.Dataset<UrlAndVersion>	getMembers() Returns a dataset of UrlAndVersion members of this collection.
static org.apache.spark.sql.Encoder<UrlAndVersion>	getUriAndVersionEncoder() Returns the encoder for UrlAndVersion tuples.
Hierarchies	withHierarchies(Hierarchies hierarchies) Returns a new hierarchies instance with the given hierarchies.
Hierarchies	withHierarchyElements(String hierarchyUri, String hierarchyVersion, org.apache.spark.sql.Dataset<Hierarchies.HierarchicalElement> elements) Returns a new hierarchies instance with the transitive ancestors computed from the given dataset of Hierarchies.HierarchicalElement.
void	writeToDatabase() Writes the ancestors to the default database "ontologies" using the default table "ancestors".
void	writeToDatabase(String database) Writes the ancestors to the given database using the default table name "ancestors".
void	writeToTables(String ancestorsTable) Writes the ancestors to the given table.

Methods inherited from class java.lang.Object

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

Field Detail

HIERARCHIES_DATABASE

public static final String HIERARCHIES_DATABASE

Default database name where the ancestor information is stored.

See Also:

Constant Field Values

ANCESTORS_TABLE

public static final String ANCESTORS_TABLE

Default table name where expanded ancestor information is stored.

See Also:

Constant Field Values

HIERARCHY_URI_PREFIX

public static final String HIERARCHY_URI_PREFIX

A URI prefix for hierarchical systems. A Hierarchy URI is "complete" when an identifier suffix for the hierarchy is appended to this value.

See Also:

Constant Field Values

Method Detail

getUriAndVersionEncoder

public static org.apache.spark.sql.Encoder<UrlAndVersion> getUriAndVersionEncoder()

Returns the encoder for UrlAndVersion tuples.

Returns:

the encoder for UrlAndVersion tuples.

getHierarchicalElementEncoder

public static org.apache.spark.sql.Encoder<Hierarchies.HierarchicalElement> getHierarchicalElementEncoder()

Returns the encoder for hierarchical elements.

Returns:

the encoder for hierarchical elements.

getDefault

public static Hierarchies getDefault(org.apache.spark.sql.SparkSession spark)

Returns the collection of ancestors from the default database and table.

Parameters:

spark - the spark session

Returns:

hierarchies instance.

getFromDatabase

public static Hierarchies getFromDatabase(org.apache.spark.sql.SparkSession spark,
                                          String database)

Returns the collection of ancestors from the table in the given database.

Parameters:

spark - the spark session

database - name of the database containing the ancestors table

Returns:

a Hierarchies instance.

getEmpty

public static Hierarchies getEmpty(org.apache.spark.sql.SparkSession spark)

Returns an empty Hierarchies instance.

Parameters:

spark - the spark session

Returns:

an empty Hierarchies instance.

getAncestors

public org.apache.spark.sql.Dataset<Ancestor> getAncestors()

Returns a dataset of all ancestors in this collection. This is generally used for inspection and debugging of ancestors.

Returns:

a dataset of all ancestors.

getMembers

public org.apache.spark.sql.Dataset<UrlAndVersion> getMembers()

Returns a dataset of UrlAndVersion members of this collection.

Returns:

a dataset of UrlAndVersion members in this collection.

getLatestVersions

public Map<String,String> getLatestVersions()

Returns the latest version of all hierarchies.

Returns:

a map of hierarchy URI to the latest version for that hierarchy.

getLatestVersions

public Map<String,String> getLatestVersions(Set<String> uris)

Returns latest versions of the given hierarchies.

Parameters:

uris - a set of URIs for which to retrieve the latest versions, or null to load them all

Returns:

a map of value set URIs to the latest versions for them.

withHierarchyElements

public Hierarchies withHierarchyElements(String hierarchyUri,
                                         String hierarchyVersion,
                                         org.apache.spark.sql.Dataset<Hierarchies.HierarchicalElement> elements)

Returns a new hierarchies instance with the transitive ancestors computed from the given dataset of Hierarchies.HierarchicalElement.

Parameters:

hierarchyUri - the URI of the hierarchical system to add

hierarchyVersion - the version of the hierarchical system to add

elements - the elements from which to calculate the ancestors

Returns:

an instance of Hierarchies with the ancestors computed from the given elements

withHierarchies

public Hierarchies withHierarchies(Hierarchies hierarchies)

Returns a new hierarchies instance with the given hierarchies.

Parameters:

hierarchies - the hierarchies to add to this instance

Returns:

a new instance of Hierarchies.

writeToDatabase

public void writeToDatabase()

Writes the ancestors to the default database "ontologies" using the default table "ancestors".

writeToDatabase

public void writeToDatabase(String database)

Writes the ancestors to the given database using the default table name "ancestors".

Parameters:

database - the name of the database to which the ancestors are saved

writeToTables

public void writeToTables(String ancestorsTable)

Writes the ancestors to the given table.

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:

ancestorsTable - the name of the table to which the ancestors are saved