ca.uhn.fhir.context.FhirVersionEnum Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation
Show all versions of hapi-fhir-base Show documentation
Builds the hapi fhir base. Requires Common lang, commons-text, and guava be built first.
/*
* #%L
* HAPI FHIR - Core Library
* %%
* 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.fhir.context;
import ca.uhn.fhir.i18n.Msg;
import ca.uhn.fhir.model.api.IFhirVersion;
import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
public enum FhirVersionEnum {
/*
* ***********************
* Don't auto-sort this type!!!
*
* Or more accurately, entries should be sorted from OLDEST FHIR release
* to NEWEST FHIR release instead of alphabetically
* ***********************
*/
DSTU2("ca.uhn.fhir.model.dstu2.FhirDstu2", null, false, new Version("1.0.2")),
DSTU2_HL7ORG("org.hl7.fhir.dstu2.hapi.ctx.FhirDstu2Hl7Org", DSTU2, true, new Version("1.0.2")),
DSTU2_1("org.hl7.fhir.dstu2016may.hapi.ctx.FhirDstu2_1", null, true, new Version("1.4.0")),
DSTU3("org.hl7.fhir.dstu3.hapi.ctx.FhirDstu3", null, true, new Dstu3Version()),
R4("org.hl7.fhir.r4.hapi.ctx.FhirR4", null, true, new R4Version()),
R4B("org.hl7.fhir.r4b.hapi.ctx.FhirR4B", null, true, new R4BVersion()),
R5("org.hl7.fhir.r5.hapi.ctx.FhirR5", null, true, new R5Version());
// If you add new constants, add to the various methods below too!
private final FhirVersionEnum myEquivalent;
private final boolean myIsRi;
private final String myVersionClass;
private volatile Boolean myPresentOnClasspath;
private volatile IFhirVersion myVersionImplementation;
private String myFhirVersionString;
FhirVersionEnum(
String theVersionClass,
FhirVersionEnum theEquivalent,
boolean theIsRi,
IVersionProvider theVersionExtractor) {
myVersionClass = theVersionClass;
myEquivalent = theEquivalent;
myFhirVersionString = theVersionExtractor.provideVersion();
myIsRi = theIsRi;
}
public String getFhirVersionString() {
return myFhirVersionString;
}
public IFhirVersion getVersionImplementation() {
if (!isPresentOnClasspath()) {
throw new IllegalStateException(Msg.code(1709) + "Version " + name() + " is not present on classpath");
}
if (myVersionImplementation == null) {
try {
myVersionImplementation =
(IFhirVersion) Class.forName(myVersionClass).newInstance();
} catch (Exception e) {
throw new InternalErrorException(Msg.code(1710) + "Failed to instantiate FHIR version " + name(), e);
}
}
return myVersionImplementation;
}
public boolean isEqualOrNewerThan(FhirVersionEnum theVersion) {
return ordinal() >= theVersion.ordinal();
}
public boolean isEquivalentTo(FhirVersionEnum theVersion) {
if (this.equals(theVersion)) {
return true;
}
if (myEquivalent != null) {
return myEquivalent.equals(theVersion);
}
return false;
}
public boolean isNewerThan(FhirVersionEnum theVersion) {
return !isEquivalentTo(theVersion) && ordinal() > theVersion.ordinal();
}
public boolean isOlderThan(FhirVersionEnum theVersion) {
return !isEquivalentTo(theVersion) && ordinal() < theVersion.ordinal();
}
/**
* Returns true if the given version is present on the classpath
*/
public boolean isPresentOnClasspath() {
Boolean retVal = myPresentOnClasspath;
if (retVal == null) {
try {
Class.forName(myVersionClass);
retVal = true;
} catch (Exception e) {
retVal = false;
}
myPresentOnClasspath = retVal;
}
return retVal;
}
/**
* Is this version using the HL7.org RI structures?
*/
public boolean isRi() {
return myIsRi;
}
/**
* Creates a new FhirContext for this FHIR version
*/
public FhirContext newContext() {
return new FhirContext(this);
}
/**
* Creates a new FhirContext for this FHIR version, or returns a previously created one if one exists. This
* method uses {@link FhirContext#forCached(FhirVersionEnum)} to return a cached instance.
*/
public FhirContext newContextCached() {
return FhirContext.forCached(this);
}
private interface IVersionProvider {
String provideVersion();
}
/**
* Given a FHIR model object type, determine which version of FHIR it is for
*/
public static FhirVersionEnum determineVersionForType(Class theFhirType) {
switch (theFhirType.getName()) {
case "ca.uhn.fhir.model.api.BaseElement":
return DSTU2;
case "org.hl7.fhir.dstu2.model.Base":
return DSTU2_HL7ORG;
case "org.hl7.fhir.dstu3.model.Base":
return DSTU3;
case "org.hl7.fhir.r4.model.Base":
return R4;
case "org.hl7.fhir.r5.model.Base":
return R5;
case "java.lang.Object":
return null;
default:
return determineVersionForType(theFhirType.getSuperclass());
}
}
private static class Version implements IVersionProvider {
private String myVersion;
public Version(String theVersion) {
super();
myVersion = theVersion;
}
@Override
public String provideVersion() {
return myVersion;
}
}
/**
* This class attempts to read the FHIR version from the actual model
* classes in order to supply an accurate version string even over time
*/
private static class Dstu3Version implements IVersionProvider {
private String myVersion;
Dstu3Version() {
try {
Class c = Class.forName("org.hl7.fhir.dstu3.model.Constants");
myVersion = (String) c.getDeclaredField("VERSION").get(null);
} catch (Exception e) {
myVersion = "3.0.2";
}
}
@Override
public String provideVersion() {
return myVersion;
}
}
private static class R4Version implements IVersionProvider {
private String myVersion;
R4Version() {
try {
Class c = Class.forName("org.hl7.fhir.r4.model.Constants");
myVersion = (String) c.getDeclaredField("VERSION").get(null);
} catch (Exception e) {
myVersion = "4.0.2";
}
}
@Override
public String provideVersion() {
return myVersion;
}
}
private static class R4BVersion implements IVersionProvider {
private String myVersion;
R4BVersion() {
try {
Class c = Class.forName("org.hl7.fhir.r4b.model.Constants");
myVersion = (String) c.getDeclaredField("VERSION").get(null);
} catch (Exception e) {
myVersion = "4.3.0";
}
}
@Override
public String provideVersion() {
return myVersion;
}
}
private static class R5Version implements IVersionProvider {
private String myVersion;
R5Version() {
try {
Class c = Class.forName("org.hl7.fhir.r5.model.Constants");
myVersion = (String) c.getDeclaredField("VERSION").get(null);
} catch (Exception e) {
myVersion = "5.0.0";
}
}
@Override
public String provideVersion() {
return myVersion;
}
}
/**
* Returns the {@link FhirVersionEnum} which corresponds to a specific version of
* FHIR. Partial version strings (e.g. "3.0") are acceptable. This method will
* also accept version names such as "DSTU2", "STU3", "R5", etc.
*
* @return Returns null if no version exists matching the given string
*/
public static FhirVersionEnum forVersionString(String theVersionString) {
// Trim the point release
String versionString = theVersionString;
int firstDot = versionString.indexOf('.');
if (firstDot > 0) {
int secondDot = versionString.indexOf('.', firstDot + 1);
if (secondDot > 0) {
versionString = versionString.substring(0, secondDot);
}
}
for (FhirVersionEnum next : values()) {
if (next.getFhirVersionString().startsWith(versionString)) {
return next;
}
}
switch (theVersionString) {
case "DSTU2":
return FhirVersionEnum.DSTU2;
case "DSTU3":
case "STU3":
return FhirVersionEnum.DSTU3;
case "R4":
return FhirVersionEnum.R4;
case "R4B":
return FhirVersionEnum.R4B;
case "R5":
return FhirVersionEnum.R5;
}
return null;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy