001package org.hl7.fhir.r5.model;
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.util.ArrayList;
035import java.util.List;
036
037import org.hl7.fhir.utilities.MergedList.IMatcher;
038
039/**
040 * A child element or property defined by the FHIR specification
041 * This class is defined as a helper class when iterating the 
042 * children of an element in a generic fashion
043 * 
044 * At present, iteration is only based on the specification, but 
045 * this may be changed to allow profile based expression at a
046 * later date
047 * 
048 * note: there's no point in creating one of these classes outside this package
049 */
050public class Property {
051
052        public static class PropertyMatcher implements IMatcher<Property> {
053
054    @Override
055    public boolean match(Property l, Property r) {
056      return l.getName().equals(r.getName());
057    }
058
059  }
060
061
062  /**
063         * The name of the property as found in the FHIR specification
064         */
065        private String name;
066        
067        /**
068         * The type of the property as specified in the FHIR specification (e.g. type|type|Reference(Name|Name)
069         */
070        private String typeCode;
071        
072        /**
073         * The formal definition of the element given in the FHIR specification
074         */
075        private String definition;
076        
077        /**
078         * The minimum allowed cardinality - 0 or 1 when based on the specification
079         */
080        private int minCardinality;
081        
082        /** 
083         * The maximum allowed cardinality - 1 or MAX_INT when based on the specification
084         */
085        private int maxCardinality;
086        
087        /**
088         * The actual elements that exist on this instance
089         */
090        private List<Base> values = new ArrayList<Base>();
091
092        /**
093         * For run time, if/once a property is hooked up to it's definition
094         */
095        private StructureDefinition structure; 
096
097        /**
098         * Internal constructor
099         */
100        public Property(String name, String typeCode, String definition, int minCardinality, int maxCardinality, Base value) {
101          super();
102          this.name = name;
103          this.typeCode = typeCode;
104          this.definition = definition;
105          this.minCardinality = minCardinality;
106          this.maxCardinality = maxCardinality;
107          if (value != null)
108            this.values.add(value);
109  }
110
111        /**
112         * Internal constructor
113         */
114        public Property(String name, String typeCode, String definition, int minCardinality, int maxCardinality, List<? extends Base> values) {
115          super();
116          this.name = name;
117          this.typeCode = typeCode;
118          this.definition = definition;
119          this.minCardinality = minCardinality;
120          this.maxCardinality = maxCardinality;
121          if (values != null)
122            this.values.addAll(values);
123  }
124
125        /**
126         * @return The name of this property in the FHIR Specification
127         */
128        public String getName() {
129                return name;
130        }
131
132        /**
133         * @return The stated type in the FHIR specification
134         */
135        public String getTypeCode() {
136                return typeCode;
137        }
138
139        /** 
140         * @return The definition of this element in the FHIR spec
141         */
142        public String getDefinition() {
143                return definition;
144        }
145
146        /**
147         * @return the minimum cardinality for this element 
148         */
149        public int getMinCardinality() {
150                return minCardinality;
151        }
152
153        /**
154         * @return the maximum cardinality for this element 
155         */
156        public int getMaxCardinality() {
157                return maxCardinality;
158        }
159
160        /**
161         * @return the actual values - will only be 1 unless maximum cardinality == MAX_INT
162         */
163        public List<Base> getValues() {
164                return values;
165        }
166
167  public boolean hasValues() {
168    for (Base e : getValues())
169      if (e != null)
170        return true;
171    return false;
172  }
173
174  public StructureDefinition getStructure() {
175    return structure;
176  }
177
178  public void setStructure(StructureDefinition structure) {
179    this.structure = structure;
180  }
181
182  public boolean isList() {
183    return maxCardinality > 1;
184  }
185
186
187  public String toString() {
188    return name; 
189  }
190        
191}