• Home
• com.ibm.fhir
• fhir-cql
• 4.11.1
• source code
• InJVMCqlTranslationProvider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.ibm.fhir.cql.translator.impl.InJVMCqlTranslationProvider Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package com.ibm.fhir.cql.translator.impl;

import java.io.InputStream;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;
import java.util.stream.Collectors;

import org.cqframework.cql.cql2elm.CqlTranslator;
import org.cqframework.cql.cql2elm.CqlTranslator.Options;
import org.cqframework.cql.cql2elm.CqlTranslatorException;
import org.cqframework.cql.cql2elm.FhirLibrarySourceProvider;
import org.cqframework.cql.cql2elm.LibraryBuilder;
import org.cqframework.cql.cql2elm.LibraryManager;
import org.cqframework.cql.cql2elm.LibrarySourceProvider;
import org.cqframework.cql.cql2elm.ModelManager;
import org.cqframework.cql.elm.execution.Library;
import org.cqframework.cql.elm.tracking.TrackBack;
import org.fhir.ucum.UcumService;
import org.opencds.cqf.cql.engine.execution.CqlLibraryReader;

import com.ibm.fhir.cql.translator.CqlTranslationException;

/**
 * Provide an implementation of the CqlTranslationProvider interface that uses
 * the CQL translator directly inside the JVM. 
 */
public class InJVMCqlTranslationProvider extends BaseCqlTranslationProvider {

    private static final Logger LOG = Logger.getLogger(InJVMCqlTranslationProvider.class.getName());
    
    private ModelManager modelManager;
    private LibraryManager libraryManager;
    
    public InJVMCqlTranslationProvider() {
        this.modelManager = new ModelManager();
        this.libraryManager = new LibraryManager(modelManager);
        addLibrarySourceProvider(new FhirLibrarySourceProvider());
    }

    public InJVMCqlTranslationProvider(LibraryManager libraryManager, ModelManager modelManager) {
        this.modelManager = modelManager;
        this.libraryManager = libraryManager;
    }

    public InJVMCqlTranslationProvider(LibrarySourceProvider provider) {
        this();
        addLibrarySourceProvider(provider);
    }

    public InJVMCqlTranslationProvider addLibrarySourceProvider(LibrarySourceProvider provider) {
        libraryManager.getLibrarySourceLoader().registerProvider(provider);
        return this;
    }

    @Override
    public List translate(InputStream cql, List options, Format targetFormat) throws CqlTranslationException {
        List result = new ArrayList<>();

        UcumService ucumService = null;
        LibraryBuilder.SignatureLevel signatureLevel = LibraryBuilder.SignatureLevel.None;

        List optionsList;
        if (options != null) {
            optionsList = options.stream().map( o -> CqlTranslator.Options.valueOf( o.name() ) ).collect(Collectors.toList());
        } else {
            optionsList = Collections.emptyList();
        }

        try {
            CqlTranslator translator =
                    CqlTranslator.fromStream(cql, modelManager, libraryManager, ucumService, CqlTranslatorException.ErrorSeverity.Info, signatureLevel, optionsList.toArray(new Options[optionsList.size()]));
    
            LOG.info( String.format("Translated CQL contains %d errors, %d exceptions", translator.getErrors().size(), translator.getExceptions().size()) );
            
            List badStuff = new ArrayList<>();
            // the translator will duplicate exceptions with assigned severity in the errors, warnings, and messages lists
            badStuff.addAll(translator.getExceptions().stream().filter( e -> e.getSeverity() == null ).collect(Collectors.toList()));
            badStuff.addAll(translator.getErrors());
            if (!badStuff.isEmpty()) {                
                throw new CqlTranslationException(formatMsg(badStuff));
            }
            
            if( translator.getWarnings().size() > 0 ) {
                LOG.warning(String.format("Translated CQL contains warnings: %s", formatMsg(translator.getWarnings())));
            }
    
            switch (targetFormat) {
            case XML:
                Library fromStream = CqlLibraryReader.read(new StringReader(translator.toXml()));
                result.add(fromStream);
                
                // Anything else that was translated via includes and the LibrarySourceProvider
                // interface will get returned as well
                for( Map.Entry entry : translator.getLibrariesAsXML().entrySet() ) {
                    Library dependency = CqlLibraryReader.read(new StringReader(entry.getValue()));
                    result.add(dependency);
                }   
                break;
            default:
                throw new CqlTranslationException(String.format("The CQL Engine does not support format %s", targetFormat.name()));
            }
        } catch( CqlTranslationException cqex ) {
            throw cqex;
        } catch( Exception ex ) {
            throw new CqlTranslationException("CQL translation failed", ex);
        }

        return result;
    }
    
    /**
     * This was cribbed from the CQL Translation Server TranslationFailureException.
     * 
     * @param translationErrs List of translation errors.
     * @return String representation of the list of translation errors.
     */
    private static String formatMsg(List translationErrs) {
        StringBuilder msg = new StringBuilder();
        msg.append("Translation failed due to errors:");
        for (CqlTranslatorException error : translationErrs) {
          TrackBack tb = error.getLocator();
          String lines = tb == null ? "[n/a]" : String.format("[%s:%s %d:%d-%d:%d]",
                  tb.getLibrary().getId(), tb.getLibrary().getVersion(),
                  tb.getStartLine(), tb.getStartChar(), tb.getEndLine(),
                  tb.getEndChar());
          msg.append(String.format("%s %s%n", lines, error.getMessage()));
        }
        return msg.toString();
    }
}