au.csiro.pathling.sql.udf.TerminologyUdfRegistrar Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of terminology Show documentation

Interact with a FHIR terminology server from Spark.

There is a newer version: 7.0.1

/*
 * Copyright 2023 Commonwealth Scientific and Industrial Research
 * Organisation (CSIRO) ABN 41 687 119 230.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package au.csiro.pathling.sql.udf;

import au.csiro.pathling.terminology.TerminologyServiceFactory;
import com.google.common.collect.ImmutableList;
import java.util.Collections;
import java.util.List;
import javax.annotation.Nonnull;
import org.apache.spark.sql.SparkSession;

/**
 * The {@link SqlFunctionRegistrar} for terminology UDFs.
 */
public class TerminologyUdfRegistrar extends SqlFunctionRegistrar {

  public TerminologyUdfRegistrar(@Nonnull final TerminologyServiceFactory tsf) {
    super(List.of(
            new DisplayUdf(tsf)),
        ImmutableList.>builder()
            .add(new MemberOfUdf(tsf))
            .addAll(PropertyUdf.createAll(tsf))
            .build(),
        List.of(
            new SubsumesUdf(tsf),
            new DesignationUdf(tsf)),
        Collections.emptyList(),
        List.of(new TranslateUdf(tsf)));
  }

  /**
   * Registers terminology UDFs in provided spark session.
   *
   * @param spark the session to configure.
   * @param terminologyServiceFactory the {@link TerminologyServiceFactory} to use for the UDFs.
   */
  public static void registerUdfs(@Nonnull final SparkSession spark,
      @Nonnull final TerminologyServiceFactory terminologyServiceFactory) {
    new TerminologyUdfRegistrar(terminologyServiceFactory).configure(spark);
  }
}