001/*-
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.util;
021
022import ca.uhn.fhir.context.BaseRuntimeChildDefinition;
023import ca.uhn.fhir.context.BaseRuntimeElementCompositeDefinition;
024import ca.uhn.fhir.context.FhirContext;
025import ca.uhn.fhir.rest.api.EncodingEnum;
026import jakarta.annotation.Nonnull;
027import org.hl7.fhir.instance.model.api.IBaseBundle;
028import org.hl7.fhir.instance.model.api.IBaseResource;
029
030import java.io.IOException;
031
032public class ResourceUtil {
033
034        private static final String ENCODING = "ENCODING_TYPE";
035        private static final String RAW_ = "RAW_";
036
037        private ResourceUtil() {}
038
039        /**
040         * This method removes the narrative from the resource, or if the resource is a bundle, removes the narrative from
041         * all of the resources in the bundle
042         *
043         * @param theContext The fhir context
044         * @param theInput   The resource to remove the narrative from
045         */
046        public static void removeNarrative(FhirContext theContext, IBaseResource theInput) {
047                if (theInput instanceof IBaseBundle) {
048                        for (IBaseResource next : BundleUtil.toListOfResources(theContext, (IBaseBundle) theInput)) {
049                                removeNarrative(theContext, next);
050                        }
051                }
052
053                BaseRuntimeElementCompositeDefinition<?> element = theContext.getResourceDefinition(theInput.getClass());
054                BaseRuntimeChildDefinition textElement = element.getChildByName("text");
055                if (textElement != null) {
056                        textElement.getMutator().setValue(theInput, null);
057                }
058        }
059
060        public static void addRawDataToResource(
061                        @Nonnull IBaseResource theResource, @Nonnull EncodingEnum theEncodingType, String theSerializedData)
062                        throws IOException {
063                theResource.setUserData(getRawUserDataKey(theEncodingType), theSerializedData);
064                theResource.setUserData(ENCODING, theEncodingType);
065        }
066
067        public static EncodingEnum getEncodingTypeFromUserData(@Nonnull IBaseResource theResource) {
068                return (EncodingEnum) theResource.getUserData(ENCODING);
069        }
070
071        public static String getRawStringFromResourceOrNull(@Nonnull IBaseResource theResource) {
072                EncodingEnum type = (EncodingEnum) theResource.getUserData(ENCODING);
073                if (type != null) {
074                        return (String) theResource.getUserData(getRawUserDataKey(type));
075                }
076                return null;
077        }
078
079        private static String getRawUserDataKey(EncodingEnum theEncodingEnum) {
080                return RAW_ + theEncodingEnum.name();
081        }
082}