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