ca.uhn.fhir.context.ParserOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-android Show documentation
There is a newer version: 7.6.1
package ca.uhn.fhir.context;

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2016 University Health Network
 * %%
 * 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%
 */

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import ca.uhn.fhir.parser.IParser;

/**
 * This object supplies default configuration to all {@link IParser parser} instances
 * created by a given {@link FhirContext}. It is accessed using {@link FhirContext#getParserOptions()}
 * and {@link FhirContext#setParserOptions(ParserOptions)}.
 * 
 * It is fine to share a ParserOptions instances across multiple context instances.
 * 
 */
public class ParserOptions {

	private boolean myStripVersionsFromReferences = true;
	private Set myDontStripVersionsFromReferencesAtPaths = Collections.emptySet();
	
	/**
	 * If supplied value(s), any resource references at the specified paths will have their
	 * resource versions encoded instead of being automatically stripped during the encoding
	 * process. This setting has no effect on the parsing process.
	 * 
	 * This method provides a finer-grained level of control than {@link #setStripVersionsFromReferences(boolean)}
	 * and any paths specified by this method will be encoded even if {@link #setStripVersionsFromReferences(boolean)}
	 * has been set to true (which is the default)
	 * 
	 *
	 * @param thePaths
	 *           A collection of paths for which the resource versions will not be removed automatically
	 *           when serializing, e.g. "Patient.managingOrganization" or "AuditEvent.object.reference". Note that
	 *           only resource name and field names with dots separating is allowed here (no repetition
	 *           indicators, FluentPath expressions, etc.)
	 * @see #setStripVersionsFromReferences(boolean)
	 * @return Returns a reference to this parser so that method calls can be chained together
	 */
	public ParserOptions setDontStripVersionsFromReferencesAtPaths(String... thePaths) {
		if (thePaths == null) {
			setDontStripVersionsFromReferencesAtPaths((List) null);
		} else {
			setDontStripVersionsFromReferencesAtPaths(Arrays.asList(thePaths));
		}
		return this;
	}
	
	/**
	 * If set to true (which is the default), resource references containing a version
	 * will have the version removed when the resource is encoded. This is generally good behaviour because
	 * in most situations, references from one resource to another should be to the resource by ID, not
	 * by ID and version. In some cases though, it may be desirable to preserve the version in resource
	 * links. In that case, this value should be set to false.
	 * 
	 * @return Returns the parser instance's configuration setting for stripping versions from resource references when
	 *         encoding. Default is true.
	 */
	public boolean isStripVersionsFromReferences() {
		return myStripVersionsFromReferences ;
	}

	/**
	 * If set to true (which is the default), resource references containing a version
	 * will have the version removed when the resource is encoded. This is generally good behaviour because
	 * in most situations, references from one resource to another should be to the resource by ID, not
	 * by ID and version. In some cases though, it may be desirable to preserve the version in resource
	 * links. In that case, this value should be set to false.
	 * 
	 * This method provides the ability to globally disable reference encoding. If finer-grained
	 * control is needed, use {@link #setDontStripVersionsFromReferencesAtPaths(String...)}
	 * 
	 * @param theStripVersionsFromReferences
	 *           Set this to false to prevent the parser from removing
	 *           resource versions from references.
	 * @return Returns a reference to this parser so that method calls can be chained together
	 * @see #setDontStripVersionsFromReferencesAtPaths(String...)
	 */
	public ParserOptions setStripVersionsFromReferences(boolean theStripVersionsFromReferences) {
		myStripVersionsFromReferences = theStripVersionsFromReferences;
		return this;
	}

	/**
	 * If supplied value(s), any resource references at the specified paths will have their
	 * resource versions encoded instead of being automatically stripped during the encoding
	 * process. This setting has no effect on the parsing process.
	 * 
	 * This method provides a finer-grained level of control than {@link #setStripVersionsFromReferences(boolean)}
	 * and any paths specified by this method will be encoded even if {@link #setStripVersionsFromReferences(boolean)}
	 * has been set to true (which is the default)
	 * 
	 *
	 * @param thePaths
	 *           A collection of paths for which the resource versions will not be removed automatically
	 *           when serializing, e.g. "Patient.managingOrganization" or "AuditEvent.object.reference". Note that
	 *           only resource name and field names with dots separating is allowed here (no repetition
	 *           indicators, FluentPath expressions, etc.)
	 * @see #setStripVersionsFromReferences(boolean)
	 * @return Returns a reference to this parser so that method calls can be chained together
	 */
	@SuppressWarnings("unchecked")
	public ParserOptions setDontStripVersionsFromReferencesAtPaths(Collection thePaths) {
		if (thePaths == null) {
			myDontStripVersionsFromReferencesAtPaths = Collections.emptySet();
		} else if (thePaths instanceof HashSet) {
			myDontStripVersionsFromReferencesAtPaths = (Set) ((HashSet)thePaths).clone();
		} else {
			myDontStripVersionsFromReferencesAtPaths = new HashSet(thePaths);
		}
		return this;
	}

	/**
	 * Returns the value supplied to {@link IParser#setDontStripVersionsFromReferencesAtPaths(String...)}
	 * 
	 * @see #setDontStripVersionsFromReferencesAtPaths(String...)
	 * @see #setStripVersionsFromReferences(boolean)
	 */
	public Set getDontStripVersionsFromReferencesAtPaths() {
		return myDontStripVersionsFromReferencesAtPaths;
	}

}