
001package org.hl7.fhir.r4.terminologies; 002 003/* 004 Copyright (c) 2011+, HL7, Inc. 005 All rights reserved. 006 007 Redistribution and use in source and binary forms, with or without modification, 008 are permitted provided that the following conditions are met: 009 010 * Redistributions of source code must retain the above copyright notice, this 011 list of conditions and the following disclaimer. 012 * Redistributions in binary form must reproduce the above copyright notice, 013 this list of conditions and the following disclaimer in the documentation 014 and/or other materials provided with the distribution. 015 * Neither the name of HL7 nor the names of its contributors may be used to 016 endorse or promote products derived from this software without specific 017 prior written permission. 018 019 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 020 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 021 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 022 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 023 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 024 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 025 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 026 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 027 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 028 POSSIBILITY OF SUCH DAMAGE. 029 030 */ 031 032 033 034import java.io.FileNotFoundException; 035import java.io.IOException; 036 037import org.hl7.fhir.r4.model.Parameters; 038import org.hl7.fhir.r4.model.ValueSet; 039 040public interface ValueSetExpander { 041 public enum TerminologyServiceErrorClass { 042 UNKNOWN, NOSERVICE, SERVER_ERROR, VALUESET_UNSUPPORTED; 043 044 public boolean isInfrastructure() { 045 return this == NOSERVICE || this == SERVER_ERROR || this == VALUESET_UNSUPPORTED; 046 } 047 } 048 049 public class ETooCostly extends Exception { 050 051 public ETooCostly(String msg) { 052 super(msg); 053 } 054 055 } 056 057 /** 058 * Some value sets are just too big to expand. Instead of an expanded value set, 059 * you get back an interface that can test membership - usually on a server somewhere 060 * 061 * @author Grahame 062 */ 063 public class ValueSetExpansionOutcome { 064 private ValueSet valueset; 065 private String error; 066 private TerminologyServiceErrorClass errorClass; 067 private String txLink; 068 069 public ValueSetExpansionOutcome(ValueSet valueset) { 070 super(); 071 this.valueset = valueset; 072 this.error = null; 073 } 074 public ValueSetExpansionOutcome(ValueSet valueset, String error, TerminologyServiceErrorClass errorClass) { 075 super(); 076 this.valueset = valueset; 077 this.error = error; 078 this.errorClass = errorClass; 079 } 080 public ValueSetExpansionOutcome(ValueSetChecker service, String error, TerminologyServiceErrorClass errorClass) { 081 super(); 082 this.valueset = null; 083 this.error = error; 084 this.errorClass = errorClass; 085 } 086 public ValueSetExpansionOutcome(String error, TerminologyServiceErrorClass errorClass) { 087 this.valueset = null; 088 this.error = error; 089 this.errorClass = errorClass; 090 } 091 public ValueSet getValueset() { 092 return valueset; 093 } 094 public String getError() { 095 return error; 096 } 097 public TerminologyServiceErrorClass getErrorClass() { 098 return errorClass; 099 } 100 public String getTxLink() { 101 return txLink; 102 } 103 public ValueSetExpansionOutcome setTxLink(String txLink) { 104 this.txLink = txLink; 105 return this; 106 } 107 108 109 } 110/** 111 * 112 * @param source the value set definition to expand 113 * @param profile a profile affecting the outcome. If you don't supply a profile, the default internal expansion profile will be used. 114 * 115 * @return 116 * @throws ETooCostly 117 * @throws FileNotFoundException 118 * @throws IOException 119 */ 120 public ValueSetExpansionOutcome expand(ValueSet source, Parameters parameters) throws ETooCostly, FileNotFoundException, IOException; 121}