com.cerner.bunsen.definitions

Class StructureField<T>

java.lang.Object

com.cerner.bunsen.definitions.StructureField<T>

Type Parameters:

T - the type produced by the visitor.

public class StructureField<T>
extends Object

This is a container for a field in a FHIR composite type that defines the field, its FHIR property, and a transformed result produced by the visitor itself.

Constructor Summary

Constructors

Constructor and Description
StructureField(String propertyName, String fieldName, String extensionUrl, boolean isModifier, boolean isChoice, T visitorResult) Constructor.

Method Summary

Modifier and Type	Method and Description
static <T> StructureField<T>	extension(String fieldName, String extensionUrl, boolean isModifier, T visitorResult) Creates a new StructField for the given extension.
String	extensionUrl() The URL of the extension represented by this field, or null if the given field is not an extension.
String	fieldName() The field name of the converted result.
boolean	isChoice() An indicator whether the field is a choice type.
boolean	isModifier() An indicator whether the field is a modifier extension.
static <T> StructureField<T>	property(String propertyName, T visitorResult) Creates a new StructureField for the given property.
String	propertyName() The FHIR property name for the field.
T	result() The result produced by the visitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureField

public StructureField(String propertyName,
                      String fieldName,
                      String extensionUrl,
                      boolean isModifier,
                      boolean isChoice,
                      T visitorResult)

Constructor.

Parameters:

propertyName - the FHIR property name

fieldName - the field name for which the property is encoded

extensionUrl - the URL, if this is for an extension

isModifier - flag indicating whether this is a modifier extension

isChoice - flag indicating whether this is a choice type

visitorResult - the result of the visitor.

Method Detail

propertyName

public String propertyName()

The FHIR property name for the field.

Returns:

the FHIR property name.

fieldName

public String fieldName()

The field name of the converted result. This generally be the same as the FHIR property name, only changing for special cases like fields generated to directly represent extensions.

Returns:

the field name

extensionUrl

public String extensionUrl()

The URL of the extension represented by this field, or null if the given field is not an extension.

Returns:

the URL for the extension, or null if it is not an extension.

isModifier

public boolean isModifier()

An indicator whether the field is a modifier extension.

Returns:

true if it is a modifier extension, false otherwise.

isChoice

public boolean isChoice()

An indicator whether the field is a choice type.

Returns:

true if it is a choice type, false otherwise.

result

public T result()

The result produced by the visitor.

Returns:

the result produced by the visitor.

property

public static <T> StructureField<T> property(String propertyName,
                                             T visitorResult)

Creates a new StructureField for the given property.

Type Parameters:

T - the return type of the visitor.

Parameters:

propertyName - the name of the property.

visitorResult - the visitor result.

Returns:

the StructField for the given property.

extension

public static <T> StructureField<T> extension(String fieldName,
                                              String extensionUrl,
                                              boolean isModifier,
                                              T visitorResult)

Creates a new StructField for the given extension.

Type Parameters:

T - the return type of the visitor.

Parameters:

fieldName - the name of the field in which the extension is represented.

extensionUrl - the URL for the extension.

isModifier - flag indicating whether this is a modifier extension

visitorResult - the visitor result.

Returns:

the StructField for the given extension.