001package ca.uhn.fhir.jpa.dao;
002
003/*
004 * #%L
005 * HAPI FHIR JPA Server
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import ca.uhn.fhir.jpa.model.entity.ResourceTable;
024import ca.uhn.fhir.jpa.model.search.ExtendedLuceneIndexData;
025import ca.uhn.fhir.jpa.search.autocomplete.ValueSetAutocompleteOptions;
026import ca.uhn.fhir.jpa.search.builder.ISearchQueryExecutor;
027import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
028import ca.uhn.fhir.jpa.searchparam.extractor.ResourceIndexedSearchParams;
029import ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId;
030import org.hl7.fhir.instance.model.api.IBaseResource;
031
032import java.util.Collection;
033import java.util.List;
034
035public interface IFulltextSearchSvc {
036
037
038        /**
039         * Search the Lucene/Elastic index for pids using params supported in theParams,
040         * consuming entries from theParams when used to query.
041         *
042         * @param theResourceName the resource name to restrict the query.
043         * @param theParams       the full query - modified to return only params unused by the index.
044         * @return the pid list for the matchign resources.
045         */
046        List<ResourcePersistentId> search(String theResourceName, SearchParameterMap theParams);
047
048
049        /**
050         * Query the index for a scrollable iterator of results.
051         * No max size to the result iterator.
052         *
053         * @param theResourceName e.g. Patient
054         * @param theParams The search query
055         * @return Iterator of result PIDs
056         */
057        ISearchQueryExecutor searchAsync(String theResourceName, SearchParameterMap theParams);
058
059        /**
060         * Autocomplete search for NIH $expand contextDirection=existing
061         * @param theOptions operation options
062         * @return a ValueSet with the search hits as the expansion.
063         */
064        IBaseResource tokenAutocompleteValueSetSearch(ValueSetAutocompleteOptions theOptions);
065
066        List<ResourcePersistentId> everything(String theResourceName, SearchParameterMap theParams, ResourcePersistentId theReferencingPid);
067
068        boolean isDisabled();
069
070        ExtendedLuceneIndexData extractLuceneIndexData(IBaseResource theResource, ResourceIndexedSearchParams theNewParams);
071
072        boolean supportsSomeOf(SearchParameterMap myParams);
073
074        /**
075         * Re-publish the resource to the full-text index.
076         *
077         * During update, hibernate search only republishes the entity if it has changed.
078         * During $reindex, we want to force the re-index.
079         *
080         * @param theEntity the fully populated ResourceTable entity
081         */
082         void reindex(ResourceTable theEntity);
083
084        List<ResourcePersistentId> lastN(SearchParameterMap theParams, Integer theMaximumResults);
085
086        /**
087         * Returns inlined resource stored along with index mappings for matched identifiers
088         *
089         * @param thePids raw pids - we dont support versioned references
090         * @return Resources list or empty if nothing found
091         */
092        List<IBaseResource> getResources(Collection<Long> thePids);
093
094        /**
095         * Returns accurate hit count
096         */
097        long count(String theResourceName, SearchParameterMap theParams);
098}