ca.uhn.fhir.jpa.searchparam.extractor.ISearchParamExtractor Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * HAPI FHIR JPA - Search Parameters
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * 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.
 * #L%
 */
package ca.uhn.fhir.jpa.searchparam.extractor;

import ca.uhn.fhir.context.RuntimeSearchParam;
import ca.uhn.fhir.jpa.model.entity.BaseResourceIndexedSearchParam;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedComboStringUnique;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedComboTokenNonUnique;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamDate;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamNumber;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamQuantity;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamQuantityNormalized;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamString;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamToken;
import ca.uhn.fhir.jpa.model.entity.ResourceIndexedSearchParamUri;
import org.hl7.fhir.instance.model.api.IBase;
import org.hl7.fhir.instance.model.api.IBaseResource;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.List;

public interface ISearchParamExtractor {

	/**
	 * Constant for the {@literal theSearchParamFilter} parameters on this interface
	 * indicating that all search parameters should be extracted.
	 */
	ISearchParamFilter ALL_PARAMS = t -> t;

	/**
	 * Constant for the {@literal theSearchParamFilter} parameters on this interface
	 * indicating that no search parameters should be extracted.
	 */
	ISearchParamFilter NO_PARAMS = t -> Collections.emptyList();

	default SearchParamSet extractSearchParamDates(IBaseResource theResource) {
		return extractSearchParamDates(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamDates(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamNumber(IBaseResource theResource) {
		return extractSearchParamNumber(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamNumber(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamQuantity(IBaseResource theResource) {
		return extractSearchParamQuantity(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamQuantity(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamQuantityNormalized(
			IBaseResource theResource) {
		return extractSearchParamQuantityNormalized(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamQuantityNormalized(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamStrings(IBaseResource theResource) {
		return extractSearchParamStrings(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamStrings(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamComposites(
			IBaseResource theResource) {
		return extractSearchParamComposites(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamComposites(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	default SearchParamSet extractSearchParamTokens(IBaseResource theResource) {
		return extractSearchParamTokens(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamTokens(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	SearchParamSet extractSearchParamTokens(
			IBaseResource theResource, RuntimeSearchParam theSearchParam);

	SearchParamSet extractSearchParamSpecial(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	SearchParamSet extractSearchParamComboUnique(
			String theResourceType, ResourceIndexedSearchParams theParams);

	SearchParamSet extractSearchParamComboNonUnique(
			String theResourceType, ResourceIndexedSearchParams theParams);

	default SearchParamSet extractSearchParamUri(IBaseResource theResource) {
		return extractSearchParamUri(theResource, ALL_PARAMS);
	}

	SearchParamSet extractSearchParamUri(
			IBaseResource theResource, ISearchParamFilter theSearchParamFilter);

	SearchParamSet extractResourceLinks(IBaseResource theResource, boolean theWantLocalReferences);

	String[] split(String theExpression);

	List extractParamValuesAsStrings(RuntimeSearchParam theActiveSearchParam, IBaseResource theResource);

	List extractValues(String thePaths, IBase theResource);

	String toRootTypeName(IBase nextObject);

	String toTypeName(IBase nextObject);

	PathAndRef extractReferenceLinkFromResource(IBase theValue, String thePath);

	Date extractDateFromResource(IBase theValue, String thePath);

	ResourceIndexedSearchParamToken createSearchParamForCoding(
			String theResourceType, RuntimeSearchParam theSearchParam, IBase theValue);

	String getDisplayTextForCoding(IBase theValue);

	BaseSearchParamExtractor.IValueExtractor getPathValueExtractor(IBase theResource, String theSinglePath);

	List getCodingsFromCodeableConcept(IBase theValue);

	String getDisplayTextFromCodeableConcept(IBase theValue);

	@FunctionalInterface
	interface ISearchParamFilter {

		/**
		 * Given the list of search parameters for extracting, an implementation of this
		 * interface may selectively remove any that it wants to remove (or can add if desired).
		 * 
		 * Implementations must not modify the list that is passed in. If changes are
		 * desired, a new list must be created and returned.
		 */
		Collection filterSearchParams(Collection theSearchParams);
	}

	class SearchParamSet extends HashSet {

		private List myWarnings;

		public void addWarning(String theWarning) {
			if (myWarnings == null) {
				myWarnings = new ArrayList<>();
			}
			myWarnings.add(theWarning);
		}

		List getWarnings() {
			if (myWarnings == null) {
				return Collections.emptyList();
			}
			return myWarnings;
		}
	}
}