org.ehrbase.aql.containment.IdentifierMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of service Show documentation
There is a newer version: 2.12.0
/*
 * Copyright (c) 2019 vitasystems GmbH and Hannover Medical School.
 *
 * This file is part of project EHRbase
 *
 * 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
 *
 *     https://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 org.ehrbase.aql.containment;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.ehrbase.aql.definition.FromEhrDefinition;
import org.ehrbase.aql.definition.FromForeignDataDefinition;
import org.ehrbase.aql.sql.queryimpl.JsonbEntryQuery;

/**
 * Map identifiers in an AQL expression with their container and query strategy.
 * 
 * The query strategy specifies whether an identifier is associated to an ARCHETYPED structure
 * or is bound to "static" data (such as a composition composer)
 * 
 * Created by christian on 4/12/2016.
 */
@SuppressWarnings({"java:S3776", "java:S3740", "java:S1452"})
public class IdentifierMapper {

    public static final String SYMBOL_ALREADY_EXISTS = "Symbol already exists:";
    public static final String COMPOSITION = "COMPOSITION";

    public class Mapper {
        private Class queryStrategy; // specifies the constructor to use depending on the identifier
        private Object container;

        public Mapper(Object container) {
            this.container = container;
        }

        public Class getQueryStrategy() {
            return queryStrategy;
        }

        public Object getContainer() {
            return container;
        }

        public void setQueryStrategy(Class queryStrategy) {
            this.queryStrategy = queryStrategy;
        }

        public void setContainer(Object container) {
            this.container = container;
        }
    }

    private Map mapper = new HashMap<>();

    public void add(Object definition) {
        if (definition instanceof Containment) {
            Containment containment = (Containment) definition;
            if (mapper.containsKey(containment.getSymbol()))
                throw new IllegalArgumentException(SYMBOL_ALREADY_EXISTS + containment.getSymbol());
            Mapper def = new Mapper(containment);
            mapper.put(containment.getSymbol(), def);
        } else if (definition instanceof FromEhrDefinition.EhrPredicate) {
            FromEhrDefinition.EhrPredicate ehrPredicate = (FromEhrDefinition.EhrPredicate) definition;
            if (mapper.containsKey(ehrPredicate.getField()))
                throw new IllegalArgumentException(SYMBOL_ALREADY_EXISTS + ehrPredicate.getField());
            Mapper def = new Mapper(ehrPredicate);
            mapper.put(ehrPredicate.getIdentifier(), def);
        } else if (definition instanceof FromForeignDataDefinition.NodePredicate) {
            FromForeignDataDefinition.NodePredicate nodePredicate =
                    (FromForeignDataDefinition.NodePredicate) definition;
            if (mapper.containsKey(nodePredicate.getField()))
                throw new IllegalArgumentException(SYMBOL_ALREADY_EXISTS + nodePredicate.getField());
            Mapper def = new Mapper(nodePredicate);
            mapper.put(nodePredicate.getIdentifier(), def);
        }
    }

    public Object getContainer(String symbol) {
        Mapper mapped = mapper.get(symbol);
        if (mapped == null) return null;
        return mapped.getContainer();
    }

    public Containment getRootContainment() {
        for (Map.Entry containment : mapper.entrySet()) {
            if (containment.getValue().getContainer() instanceof Containment
                    && ((Containment) containment.getValue().getContainer())
                            .getClassName()
                            .equals(COMPOSITION))
                return (Containment) containment.getValue().getContainer();
        }
        return new Containment(COMPOSITION, "", "");
    }

    public FromEhrDefinition.EhrPredicate getEhrContainer() {
        for (Map.Entry containment : mapper.entrySet()) {
            if (containment.getValue().getContainer() instanceof FromEhrDefinition.EhrPredicate
                    && !((FromEhrDefinition.EhrPredicate) containment.getValue().getContainer()).isVoid())
                return (FromEhrDefinition.EhrPredicate) containment.getValue().getContainer();
        }
        return null;
    }

    public boolean hasPathExpression() {
        for (Map.Entry containment : mapper.entrySet()) {
            if (containment.getValue().getQueryStrategy() != null
                    && containment.getValue().getQueryStrategy().equals(JsonbEntryQuery.class)) return true;
        }
        return false;
    }

    public boolean hasEhrContainer() {
        for (Map.Entry containment : mapper.entrySet()) {
            if (containment.getValue().getContainer() instanceof FromEhrDefinition.EhrPredicate) return true;
        }
        return false;
    }

    public Class getQueryStrategy(String symbol) {
        Mapper mapped = mapper.get(symbol);
        if (mapped == null) return null;
        return mapped.getQueryStrategy();
    }

    public Set getPath(String template, String symbol) {
        Mapper definition = mapper.get(symbol);
        if (definition == null) throw new IllegalArgumentException("Could not resolve identifier:" + symbol);

        Object containment = definition.getContainer();
        if (containment instanceof Containment) {
            return ((Containment) containment).getPath(template);
        }
        return Collections.emptySet();
    }

    public void setPath(String template, String symbol, Set path) {
        Mapper definition = mapper.get(symbol);
        Object containment = definition.getContainer();
        if (containment instanceof Containment) {
            ((Containment) containment).setPath(template, path);
        }
    }

    public void setQueryStrategy(String symbol, Class queryImplementation) {
        Mapper definition = mapper.get(symbol);
        definition.setQueryStrategy(queryImplementation);
    }

    public String getArchetypeId(String symbol) {
        Mapper definition = mapper.get(symbol);
        Object containment = definition.getContainer();
        if (containment instanceof Containment) {
            return ((Containment) containment).getArchetypeId();
        }
        return null;
    }

    public String getClassName(String symbol) {
        Mapper definition = mapper.get(symbol);
        if (definition == null)
            throw new IllegalArgumentException("Identifier is not defined in FROM/CONTAIN clause:" + symbol);

        Object containment = definition.getContainer();
        if (containment instanceof Containment) {
            return ((Containment) containment).getClassName();
        } else if (containment instanceof FromEhrDefinition.EhrPredicate) return "EHR";

        return null;
    }

    public Set identifiers() {
        return mapper.keySet();
    }

    public String dump() {

        StringBuilder sb = new StringBuilder();

        for (Map.Entry objectEntry : mapper.entrySet()) {
            sb.append(objectEntry.getKey() + "::" + objectEntry.getValue().toString());
            sb.append("\n");
        }
        return sb.toString();
    }

    public boolean requiresTemplateWhereClause() {
        boolean resolveTemplateRequired = false;

        for (Map.Entry map : mapper.entrySet()) {
            Mapper mapper1 = (Mapper) map.getValue();
            if (mapper1.getContainer() instanceof Containment) {
                Containment containment = (Containment) mapper1.getContainer();
                // check if this containment specifies an archetype (triggering a template resolution)
                // f.e. COMPOSITION a [openEHR-EHR-COMPOSITION.report-result.v1] contains OBSERVATION
                if (!containment.getClassName().equals(COMPOSITION) || containment.getArchetypeId() != null) {
                    resolveTemplateRequired = true; // a composition node constrained with an archetype
                    break;
                }
            }
        }
        return resolveTemplateRequired;
    }
}