001package org.hl7.fhir.dstu2.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.dstu2.model.ValueSet;
036
037public interface ValueSetExpander {
038  public class ETooCostly extends Exception {
039
040    public ETooCostly(String msg) {
041      super(msg);
042    }
043
044  }
045
046  /**
047   * Some value sets are just too big to expand. Instead of an expanded value set,
048   * you get back an interface that can test membership - usually on a server
049   * somewhere
050   * 
051   * @author Grahame
052   */
053  public class ValueSetExpansionOutcome {
054    private ValueSet valueset;
055    private ValueSetChecker service;
056    private String error;
057
058    public ValueSetExpansionOutcome(ValueSet valueset) {
059      super();
060      this.valueset = valueset;
061      this.service = null;
062      this.error = null;
063    }
064
065    public ValueSetExpansionOutcome(ValueSet valueset, String error) {
066      super();
067      this.valueset = valueset;
068      this.service = null;
069      this.error = error;
070    }
071
072    public ValueSetExpansionOutcome(ValueSetChecker service, String error) {
073      super();
074      this.valueset = null;
075      this.service = service;
076      this.error = error;
077    }
078
079    public ValueSetExpansionOutcome(String error) {
080      this.valueset = null;
081      this.service = null;
082      this.error = error;
083    }
084
085    public ValueSet getValueset() {
086      return valueset;
087    }
088
089    public ValueSetChecker getService() {
090      return service;
091    }
092
093    public String getError() {
094      return error;
095    }
096
097  }
098
099  public ValueSetExpansionOutcome expand(ValueSet source) throws ETooCostly, FileNotFoundException, IOException;
100}