com.cerner.bunsen.spark.converters

Class DefinitionToSparkVisitor

java.lang.Object

com.cerner.bunsen.spark.converters.DefinitionToSparkVisitor

All Implemented Interfaces:

DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

public class DefinitionToSparkVisitor
extends Object
implements DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

A visitor implementation to travers a FHIR resource definition and produce a converter class that translates from FHIR to Spark and vice versa.

Constructor Summary

Constructors

Constructor and Description
DefinitionToSparkVisitor(FhirConversionSupport fhirSupport, String basePackage, Map<String,HapiConverter<org.apache.spark.sql.types.DataType>> visitedConverters) Creates a visitor to construct Spark Row conversion objects.

Method Summary

Modifier and Type	Method and Description
int	getMaxDepth(String elementTypeUrl, String path) Returns the maximum depth to use for recursive structures of the given type.
HapiConverter<org.apache.spark.sql.types.DataType>	visitChoice(String elementName, Map<String,HapiConverter<org.apache.spark.sql.types.DataType>> choiceTypes) Visits a choice type.
HapiConverter<org.apache.spark.sql.types.DataType>	visitComposite(String elementName, String elementPath, String baseType, String elementTypeUrl, List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children) Visits a composite type.
HapiConverter	visitContained(String elementPath, String elementTypeUrl, Map<String,StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> contained) Visits a container type.
HapiConverter<org.apache.spark.sql.types.DataType>	visitLeafExtension(String elementName, String extensionUri, HapiConverter elementConverter) Visits a leaf extension, which contains some value.
HapiConverter<org.apache.spark.sql.types.DataType>	visitMultiValued(String elementName, HapiConverter arrayElement) Visits a multi-valued element.
HapiConverter	visitParentExtension(String elementName, String extensionUrl, List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children) Visits a non-leaf extension.
HapiConverter	visitPrimitive(String elementName, String primitiveType) Visits a primitive type.
HapiConverter	visitReference(String elementName, List<String> referenceTypes, List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children) Visits a reference type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefinitionToSparkVisitor

public DefinitionToSparkVisitor(FhirConversionSupport fhirSupport,
                                String basePackage,
                                Map<String,HapiConverter<org.apache.spark.sql.types.DataType>> visitedConverters)

Creates a visitor to construct Spark Row conversion objects.

Parameters:

fhirSupport - support for FHIR conversions.

basePackage - the base package to be used as a prefix for unique keys to cache generated converters.

visitedConverters - a mutable cache of generated converters that may be reused by types that contain them.

Method Detail

visitPrimitive

public HapiConverter visitPrimitive(String elementName,
                                    String primitiveType)

Description copied from interface: DefinitionVisitor

Visits a primitive type.

Specified by:

visitPrimitive in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

primitiveType - the FHIR type of the primitive.

Returns:

the visitor result.

visitComposite

public HapiConverter<org.apache.spark.sql.types.DataType> visitComposite(String elementName,
                                                                         String elementPath,
                                                                         String baseType,
                                                                         String elementTypeUrl,
                                                                         List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children)

Description copied from interface: DefinitionVisitor

Visits a composite type.

Specified by:

visitComposite in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

elementPath - the FHIR path to the element.

baseType - the type of the composite type.

elementTypeUrl - the URL of the resource containing the element.

children - the composite type's children.

Returns:

the visitor result.

visitContained

public HapiConverter visitContained(String elementPath,
                                    String elementTypeUrl,
                                    Map<String,StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> contained)

Description copied from interface: DefinitionVisitor

Visits a container type.

Specified by:

visitContained in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementPath - the FHIR path to the element.

elementTypeUrl - the type of the container type.

contained - the map of types to their contained elements.

Returns:

the visitor result.

visitReference

public HapiConverter visitReference(String elementName,
                                    List<String> referenceTypes,
                                    List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children)

Description copied from interface: DefinitionVisitor

Visits a reference type.

Specified by:

visitReference in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

referenceTypes - the types of resource that can be referenced

children - the child fields of the reference

Returns:

the visitor result.

visitParentExtension

public HapiConverter visitParentExtension(String elementName,
                                          String extensionUrl,
                                          List<StructureField<HapiConverter<org.apache.spark.sql.types.DataType>>> children)

Description copied from interface: DefinitionVisitor

Visits a non-leaf extension.

Specified by:

visitParentExtension in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

extensionUrl - the URL of the extension.

children - the children of the extension

Returns:

the visitor result.

visitLeafExtension

public HapiConverter<org.apache.spark.sql.types.DataType> visitLeafExtension(String elementName,
                                                                             String extensionUri,
                                                                             HapiConverter elementConverter)

Description copied from interface: DefinitionVisitor

Visits a leaf extension, which contains some value.

Specified by:

visitLeafExtension in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

extensionUri - the URL of the extension.

elementConverter - the children of the extension.

Returns:

the visitor result.

visitMultiValued

public HapiConverter<org.apache.spark.sql.types.DataType> visitMultiValued(String elementName,
                                                                           HapiConverter arrayElement)

Description copied from interface: DefinitionVisitor

Visits a multi-valued element.

Specified by:

visitMultiValued in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

arrayElement - the visitor result for a single element of the array.

Returns:

the visitor result.

visitChoice

public HapiConverter<org.apache.spark.sql.types.DataType> visitChoice(String elementName,
                                                                      Map<String,HapiConverter<org.apache.spark.sql.types.DataType>> choiceTypes)

Description copied from interface: DefinitionVisitor

Visits a choice type.

Specified by:

visitChoice in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementName - the element to visit.

choiceTypes - a map of the choice type with the returned children.

Returns:

the visitor result.

getMaxDepth

public int getMaxDepth(String elementTypeUrl,
                       String path)

Description copied from interface: DefinitionVisitor

Returns the maximum depth to use for recursive structures of the given type.

Specified by:

getMaxDepth in interface DefinitionVisitor<HapiConverter<org.apache.spark.sql.types.DataType>>

Parameters:

elementTypeUrl - the element type that is recursive

path - the path to the element that is recursive

Returns:

the depth the visitor should recur to.