t

au.csiro.pathling.encoders

SchemaProcessor

trait SchemaProcessor[DT, SF] extends SchemaVisitor[DT, SF] with EncoderSettings

A specialized SchemaVisitor for building schema encoders and converters.

DT

the type which represents the final result of traversing a resource (or composite), e.g: for a schema converter this can be org.apache.spark.sql.types.DataType.

SF

the type which represents the result of traversing an element of a composite, e.g: for a schema converter this can be org.apache.spark.sql.types.StructField.

Linear Supertypes
EncoderSettings, SchemaVisitor[DT, SF], AnyRef, Any
Known Subclasses
SchemaProcessorWithTypeMappings
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaProcessor
  2. EncoderSettings
  3. SchemaVisitor
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def buildComposite(definition: BaseRuntimeElementCompositeDefinition[_], fields: Seq[SF]): DT

    Builds the representation of the composite from the representations of its elements.

    Builds the representation of the composite from the representations of its elements.

    definition

    the HAPI definition of a composite

    fields

    the list of representations of the composite elements.

    returns

    the representation of the composite.

  2. abstract def buildValue(childDefinition: BaseRuntimeChildDefinition, elementDefinition: BaseRuntimeElementDefinition[_], elementName: String): Seq[SF]

    Builds a representation for an child element with resolved name.

    Builds a representation for an child element with resolved name.

    childDefinition

    the HAPI child definition.

    elementDefinition

    the HAPI element definition.

    elementName

    the element name.

    returns

    the representation of of the named child element.

  3. abstract def generateFid: Boolean

    Indicates if unique field ids (_fid) should be added to the schema.

    Indicates if unique field ids (_fid) should be added to the schema. This is required to support extension but it's an option at the moment to allow for backward compatibility with V1 encodes. Once V2 has matured this can be removed together with all V1 related classes and tests.

    returns

    if unique field ids (_fid) should be added to the schema.

    Definition Classes
    EncoderSettings
  4. abstract def getValidChoiceTypes(choice: RuntimeChildChoiceDefinition): Seq[Class[_ <: IBase]]

    Returns the list of valid child types of given choice.

    Returns the list of valid child types of given choice.

    choice

    the choice child definition.

    returns

    list of valid types for this

    Definition Classes
    SchemaVisitor
  5. abstract def maxNestingLevel: Int

    Gets the max nesting that recursive data types should be expanded to.

    Gets the max nesting that recursive data types should be expanded to. Zero indicates that fields ot type T should not be expanded in the composite of type T.

    returns

    the max nesting that recursive data types should be expanded to

    Definition Classes
    EncoderSettings
  6. abstract def openTypes: Set[String]

    The list of types that are encoded within open types, such as extensions.

    The list of types that are encoded within open types, such as extensions.

    Definition Classes
    EncoderSettings
  7. abstract def shouldExpandChild(definition: BaseRuntimeElementCompositeDefinition[_], childDefinition: BaseRuntimeChildDefinition): Boolean

    Determines if the representation of a child should be included in the representation of its composite.

    Determines if the representation of a child should be included in the representation of its composite.

    definition

    the HAPI definition of a composite.

    childDefinition

    the HAPI definition of the composite child.

    returns

    true if the child representation should be included.

  8. abstract def supportsExtensions: Boolean

    Indicates if support for FHIR extension should be enabled.

    Indicates if support for FHIR extension should be enabled.

    returns

    if support for FHIR extension should be enabled.

    Definition Classes
    EncoderSettings

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def aggregateComposite(compositeCtx: CompositeCtx[DT, SF], sfs: Seq[SF]): DT

    Transforms the SF representations of the composite elements to the DT representation of the composite.

    Transforms the SF representations of the composite elements to the DT representation of the composite.

    compositeCtx

    the composite context.

    sfs

    the list of the SF representations of the composite elements.

    returns

    the DT representation of the composite.

    Definition Classes
    SchemaProcessor → SchemaVisitor
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. def combineChoiceElements(ctx: ChoiceChildCtx[DT, SF], seq: Seq[Seq[SF]]): Seq[SF]
    Definition Classes
    SchemaProcessor → SchemaVisitor
  8. def combineChoiceOptions(choiceDefinition: RuntimeChildChoiceDefinition, optionValues: Seq[Seq[SF]]): Seq[SF]

    Combines the representations of the choice options to the representation of the choice.

    Combines the representations of the choice options to the representation of the choice.

    choiceDefinition

    the HAPI choice child definition.

    optionValues

    the list of representations of choice options.

    returns

    the representation of the choice element.

  9. def compositeBuilder(compositeDefinition: BaseRuntimeElementCompositeDefinition[_]): DT
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def getOrderedListOfChoiceChildNames(choice: RuntimeChildChoiceDefinition): Seq[String]

    Returns a deterministically ordered list of child names of a choice.

    Returns a deterministically ordered list of child names of a choice.

    choice

    the choice child definition.

    returns

    ordered list of child names of the choice.

    Definition Classes
    SchemaVisitor
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def proceedCompositeChildren(value: CompositeCtx[DT, SF]): Seq[SF]
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. def visitChild(childCtx: ChildCtx[DT, SF]): Seq[SF]

    Visitor method for HAPI RuntimeChild definition.

    Visitor method for HAPI RuntimeChild definition.

    childCtx

    the child context.

    returns

    the list of the SF representations of the elements of the child definition.

    Definition Classes
    SchemaProcessor → SchemaVisitor
  23. def visitChoiceChild(choiceChildCtx: ChoiceChildCtx[DT, SF]): Seq[SF]

    Visitor method for HAPI RuntimeChild definition of a choice.

    Visitor method for HAPI RuntimeChild definition of a choice.

    choiceChildCtx

    the choice child context.

    returns

    the list of the SF representations of the elements of the child definition.

    Definition Classes
    SchemaVisitor
  24. def visitComposite(compositeCtx: CompositeCtx[DT, SF]): DT

    Visitor method for HAPI ElementComposite definition.

    Visitor method for HAPI ElementComposite definition.

    compositeCtx

    the composite element context.

    returns

    DT representation of the composite element.

    Definition Classes
    SchemaProcessor → SchemaVisitor
  25. def visitElement(elementCtx: ElementCtx[DT, SF]): Seq[SF]

    Visitor method for a HAPI Element definition

    Visitor method for a HAPI Element definition

    elementCtx

    the element context.

    returns

    the list of the SF representations of the element.

    Definition Classes
    SchemaProcessor → SchemaVisitor
  26. def visitElementChild(elementChildCtx: ElementChildCtx[DT, SF]): Seq[SF]

    Visitor method for HAPI RuntimeChild definition with a single element.

    Visitor method for HAPI RuntimeChild definition with a single element.

    elementChildCtx

    child context.

    returns

    the list of the SF representations of the elements of the child definition.

    Definition Classes
    SchemaProcessor → SchemaVisitor
  27. def visitResource(resourceCtx: ResourceCtx[DT, SF]): DT

    Visitor method for HAPI Resource definitions.

    Visitor method for HAPI Resource definitions.

    resourceCtx

    the resource context.

    returns

    DT representation of the resource.

    Definition Classes
    SchemaVisitor
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from EncoderSettings

Inherited from SchemaVisitor[DT, SF]

Inherited from AnyRef

Inherited from Any

Ungrouped