com.cerner.bunsen.definitions

Interface DefinitionVisitor<T>

Type Parameters:

T - the type produced by the visitor.

All Known Implementing Classes:

DefinitionToAvroVisitor, DefinitionToSparkVisitor

public interface DefinitionVisitor<T>

Visitor for each field in a FHIR StructureDefinition.

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.
T	visitChoice(String elementName, Map<String,T> fhirToChoiceTypes) Visits a choice type.
T	visitComposite(String elementName, String elementPath, String baseType, String elementTypeUrl, List<StructureField<T>> children) Visits a composite type.
T	visitContained(String elementPath, String baseType, Map<String,StructureField<T>> contained) Visits a container type.
T	visitLeafExtension(String elementName, String extensionUrl, T element) Visits a leaf extension, which contains some value.
T	visitMultiValued(String elementName, T arrayElement) Visits a multi-valued element.
T	visitParentExtension(String elementName, String extensionUrl, List<StructureField<T>> children) Visits a non-leaf extension.
T	visitPrimitive(String elementName, String primitiveType) Visits a primitive type.
T	visitReference(String elementName, List<String> referenceTypes, List<StructureField<T>> children) Visits a reference type.

Method Detail

visitPrimitive

T visitPrimitive(String elementName,
                 String primitiveType)

Visits a primitive type.

Parameters:

elementName - the element to visit.

primitiveType - the FHIR type of the primitive.

Returns:

the visitor result.

visitComposite

T visitComposite(String elementName,
                 String elementPath,
                 String baseType,
                 String elementTypeUrl,
                 List<StructureField<T>> children)

Visits a composite type.

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

T visitContained(String elementPath,
                 String baseType,
                 Map<String,StructureField<T>> contained)

Visits a container type.

Parameters:

elementPath - the FHIR path to the element.

baseType - the type of the container type.

contained - the map of types to their contained elements.

Returns:

the visitor result.

visitReference

T visitReference(String elementName,
                 List<String> referenceTypes,
                 List<StructureField<T>> children)

Visits a reference type.

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

T visitParentExtension(String elementName,
                       String extensionUrl,
                       List<StructureField<T>> children)

Visits a non-leaf extension.

Parameters:

elementName - the element to visit.

extensionUrl - the URL of the extension.

children - the children of the extension

Returns:

the visitor result.

visitLeafExtension

T visitLeafExtension(String elementName,
                     String extensionUrl,
                     T element)

Visits a leaf extension, which contains some value.

Parameters:

elementName - the element to visit.

extensionUrl - the URL of the extension.

element - the children of the extension.

Returns:

the visitor result.

visitMultiValued

T visitMultiValued(String elementName,
                   T arrayElement)

Visits a multi-valued element.

Parameters:

elementName - the element to visit.

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

Returns:

the visitor result.

visitChoice

T visitChoice(String elementName,
              Map<String,T> fhirToChoiceTypes)

Visits a choice type.

Parameters:

elementName - the element to visit.

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

Returns:

the visitor result.

getMaxDepth

int getMaxDepth(String elementTypeUrl,
                String path)

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

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.