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
032import java.io.FileNotFoundException;
033import java.io.IOException;
034
035import org.hl7.fhir.r4.model.Parameters;
036import org.hl7.fhir.r4.model.ValueSet;
037
038public interface ValueSetExpander {
039  public enum TerminologyServiceErrorClass {
040    UNKNOWN, NOSERVICE, SERVER_ERROR, VALUESET_UNSUPPORTED;
041
042    public boolean isInfrastructure() {
043      return this == NOSERVICE || this == SERVER_ERROR || this == VALUESET_UNSUPPORTED;
044    }
045  }
046
047  public class ETooCostly extends Exception {
048
049    public ETooCostly(String msg) {
050      super(msg);
051    }
052
053  }
054
055  /**
056   * Some value sets are just too big to expand. Instead of an expanded value set,
057   * you get back an interface that can test membership - usually on a server
058   * somewhere
059   * 
060   * @author Grahame
061   */
062  public class ValueSetExpansionOutcome {
063    private ValueSet valueset;
064    private String error;
065    private TerminologyServiceErrorClass errorClass;
066    private String txLink;
067
068    public ValueSetExpansionOutcome(ValueSet valueset) {
069      super();
070      this.valueset = valueset;
071      this.error = null;
072    }
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
081    public ValueSetExpansionOutcome(ValueSetChecker service, String error, TerminologyServiceErrorClass errorClass) {
082      super();
083      this.valueset = null;
084      this.error = error;
085      this.errorClass = errorClass;
086    }
087
088    public ValueSetExpansionOutcome(String error, TerminologyServiceErrorClass errorClass) {
089      this.valueset = null;
090      this.error = error;
091      this.errorClass = errorClass;
092    }
093
094    public ValueSet getValueset() {
095      return valueset;
096    }
097
098    public String getError() {
099      return error;
100    }
101
102    public TerminologyServiceErrorClass getErrorClass() {
103      return errorClass;
104    }
105
106    public String getTxLink() {
107      return txLink;
108    }
109
110    public ValueSetExpansionOutcome setTxLink(String txLink) {
111      this.txLink = txLink;
112      return this;
113    }
114
115    public boolean isOk() {
116      return error == null;
117    }
118
119  }
120
121  /**
122   * 
123   * @param source  the value set definition to expand
124   * @param profile a profile affecting the outcome. If you don't supply a
125   *                profile, the default internal expansion profile will be used.
126   * 
127   * @return
128   * @throws ETooCostly
129   * @throws FileNotFoundException
130   * @throws IOException
131   */
132  public ValueSetExpansionOutcome expand(ValueSet source, Parameters parameters)
133      throws ETooCostly, FileNotFoundException, IOException;
134}