ca.uhn.hapi.fhir.docs.PagingPatientProvider Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR - Docs
 * %%
 * 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.hapi.fhir.docs;

import ca.uhn.fhir.rest.annotation.RequiredParam;
import ca.uhn.fhir.rest.annotation.Search;
import ca.uhn.fhir.rest.api.server.IBundleProvider;
import ca.uhn.fhir.rest.param.StringParam;
import ca.uhn.fhir.rest.server.IResourceProvider;
import ca.uhn.fhir.rest.server.method.ResponsePage;
import jakarta.annotation.Nonnull;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.r4.model.InstantType;
import org.hl7.fhir.r4.model.Patient;

import java.util.List;

@SuppressWarnings("null")
// START SNIPPET: provider
public class PagingPatientProvider implements IResourceProvider {

	/**
	 * Search for Patient resources matching a given family name
	 */
	@Search
	public IBundleProvider search(@RequiredParam(name = Patient.SP_FAMILY) StringParam theFamily) {
		final InstantType searchTime = InstantType.withCurrentTime();

		/**
		 * First, we'll search the database for a set of database row IDs that
		 * match the given search criteria. That way we can keep just the row IDs
		 * around, and load the actual resources on demand later as the client
		 * pages through them.
		 */
		final List matchingResourceIds = null; // <-- implement this

		/**
		 * Return a bundle provider which can page through the IDs and return the
		 * resources that go with them.
		 */
		return new IBundleProvider() {

			@Override
			public Integer size() {
				return matchingResourceIds.size();
			}

			@Nonnull
			@Override
			public List getResources(
					int theFromIndex,
					int theToIndex,
					@Nonnull ResponsePage.ResponsePageBuilder theResponsePageBuilder) {
				int end = Math.max(theToIndex, matchingResourceIds.size() - 1);
				List idsToReturn = matchingResourceIds.subList(theFromIndex, end);
				return loadResourcesByIds(idsToReturn);
			}

			@Override
			public InstantType getPublished() {
				return searchTime;
			}

			@Override
			public Integer preferredPageSize() {
				// Typically this method just returns null
				return null;
			}

			@Override
			public String getUuid() {
				return null;
			}
		};
	}

	/**
	 * Load a list of patient resources given their IDs
	 */
	private List loadResourcesByIds(List theIdsToReturn) {
		// .. implement this search against the database ..
		return null;
	}

	@Override
	public Class getResourceType() {
		return Patient.class;
	}
}
// END SNIPPET: provider