com.ibm.fhir.persistence.jdbc.domain.SearchQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fhir-persistence-jdbc Show documentation
There is a newer version: 4.11.1
Show newest version
/*
 * (C) Copyright IBM Corp. 2021, 2022
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.fhir.persistence.jdbc.domain;

import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;

import com.ibm.fhir.persistence.exception.FHIRPersistenceException;

/**
 * Abstract model of a FHIR search query we intend to build.
 * The purpose of this class and its sub-classes is to drive
 * calls to a {@link SearchQueryVisitor} implementation to render
 * a runnable SQL statement.
 */
public abstract class SearchQuery {
    private static final String CLASSNAME = SearchQuery.class.getName();
    private static final Logger logger = Logger.getLogger(CLASSNAME);

    // constant to improve readability of method calls
    public static final boolean INCLUDE_RESOURCE_TYPE_ID = true;

    private final String rootResourceType;
    private final List searchParams = new ArrayList<>();

    // A list of non-parameter related extensions (e.g. location processing)
    protected final List extensions = new ArrayList<>();

    /**
     * Public constructor
     * @param rootResourceType
     */
    public SearchQuery(String rootResourceType) {
        this.rootResourceType = rootResourceType;
    }

    /**
     * Getter for the root resource type for this search query
     * @return
     */
    public String getRootResourceType() {
        return this.rootResourceType;
    }

    /**
     * Add the search parameter to the model
     * @param sp
     */
    public void add(SearchParam sp) {
        this.searchParams.add(sp);
    }

    /**
     * Add the search extension to the model
     * @param ext
     */
    public void add(SearchExtension ext) {
        this.extensions.add(ext);
    }

    /**
     * Get the root query and attach the parameter filters to it
     * @param 
     * @param visitor
     * @return
     */
    public  T visit(SearchQueryVisitor visitor) throws FHIRPersistenceException {
        logger.entering(CLASSNAME, "visit");

        // Get the root query and process extensions for it
        T query = getRoot(visitor);
        visitExtensions(query, visitor);

        // Add the parameters subquery
        T parameterBase = visitor.getParameterBaseQuery(query);
        visitSearchParams(parameterBase, visitor);

        logger.exiting(CLASSNAME, "visit");
        return query;
    }

    /**
     * Visit each of the extensions configured for this query
     * @param 
     * @param query
     * @param visitor
     * @throws FHIRPersistenceException
     */
    public  void visitExtensions(T query, SearchQueryVisitor visitor) throws FHIRPersistenceException {
        for (SearchExtension ext: this.extensions) {
            ext.visit(query, visitor);
        }
    }

    /**
     * Process the logical query definition through the visitor
     * @param 
     * @param visitor
     * @return
     */
    public abstract  T getRoot(SearchQueryVisitor visitor);

    /**
     * Visit each of the search parameters
     * @param 
     * @param query
     * @param visitor
     * @throws FHIRPersistenceException
     */
    protected  void visitSearchParams(T query, SearchQueryVisitor visitor) throws FHIRPersistenceException {
        for (SearchParam sp: this.searchParams) {
            sp.visit(query, visitor);
        }
    }
}