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 java.util.List;
024
025import ca.uhn.fhir.jpa.model.entity.ResourceTable;
026import ca.uhn.fhir.jpa.model.search.ExtendedLuceneIndexData;
027import ca.uhn.fhir.jpa.searchparam.extractor.ResourceIndexedSearchParams;
028import ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId;
029import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
030import ca.uhn.fhir.rest.api.server.RequestDetails;
031import org.hl7.fhir.instance.model.api.IBaseResource;
032
033public interface IFulltextSearchSvc {
034
035
036        /**
037         * Search the Lucene/Elastic index for pids using params supported in theParams,
038         * consuming entries from theParams when used to query.
039         *
040         * @param theResourceName the resource name to restrict the query.
041         * @param theParams the full query - modified to return only params unused by the index.
042         * @return the pid list for the matchign resources.
043         */
044        List<ResourcePersistentId> search(String theResourceName, SearchParameterMap theParams);
045
046        List<ResourcePersistentId> everything(String theResourceName, SearchParameterMap theParams, RequestDetails theRequest);
047
048        boolean isDisabled();
049
050        ExtendedLuceneIndexData extractLuceneIndexData(IBaseResource theResource, ResourceIndexedSearchParams theNewParams);
051
052    boolean supportsSomeOf(SearchParameterMap myParams);
053
054        /**
055         * Re-publish the resource to the full-text index.
056         *
057         * During update, hibernate search only republishes the entity if it has changed.
058         * During $reindex, we want to force the re-index.
059         *
060         * @param theEntity the fully populated ResourceTable entity
061         */
062         void reindex(ResourceTable theEntity);
063}