com.ibm.fhir.term.graph.loader.FHIRTermGraphLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fhir-term-graph-loader Show documentation

There is a newer version: 4.11.1

Show newest version

/*
 * (C) Copyright IBM Corp. 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.fhir.term.graph.loader;

import java.util.Map;

import org.apache.commons.cli.Options;

import com.ibm.fhir.term.graph.FHIRTermGraph;

public interface FHIRTermGraphLoader {
    enum Type {
        CODESYSTEM {
            @Override
            public Options options() {
                return new Options()
                    .addRequiredOption("config", null, true, "Configuration properties file")
                    .addOption("url", null, true, "CodeSystem url")
                    .addOption("file", null, true, "CodeSystem file");
            }
        },
        SNOMED {
            @Override
            public Options options() {
                return new Options()
                    .addRequiredOption("config", null, true, "Configuration properties file")
                    .addRequiredOption("base", null, true, "SNOMED-CT base directory")
                    .addRequiredOption("concept", null, true, "SNOMED-CT concept file")
                    .addRequiredOption("relation", null, true, "SNOMED-CT relationship file")
                    .addRequiredOption("desc", null, true, "SNOMED-CT description file")
                    .addRequiredOption("lang", null, true, "SNOMED-CT language refset file")
                    .addOption("labels", null, true, "labels");
            }
        },
        UMLS {
            @Override
            public Options options() {
                return new Options()
                    .addOption("config", null, true, "Configuration properties file")
                    .addOption("labels", null, true, "labels");
            }
        };

        public abstract Options options();
    }

    /**
     * Load the {@link FHIRTermGraph}.
     */
    void load();

    /**
     * Close the loader and its underlying resources.
     */
    void close();

    /**
     * Get the options used to create this {@link FHIRTermGraphLoader}.
     *
     * @return
     *     the options
     */
    Map options();

    /**
     * Get the underlying {@link FHIRTermGraph} instance.
     *
     * @return
     *     the {@link FHIRTermGraph} instance
     */
    FHIRTermGraph getGraph();
}