org.hl7.fhir.r4.elementmodel.Element Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.hl7.fhir.r4 Show documentation
Builds the hapi fhir r4. Requires hapi-fhir-base and hapi-fhir-utilities be built first and be excluded from any other poms requiring it.
The newest version!
package org.hl7.fhir.r4.elementmodel;

/*
  Copyright (c) 2011+, HL7, Inc.
  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without modification, 
  are permitted provided that the following conditions are met:
    
   * Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.
   * Neither the name of HL7 nor the names of its contributors may be used to 
     endorse or promote products derived from this software without specific 
     prior written permission.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
  POSSIBILITY OF SUCH DAMAGE.
  
 */

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.commons.lang3.Validate;
import org.hl7.fhir.exceptions.FHIRException;
import org.hl7.fhir.r4.conformance.ProfileUtilities;
import org.hl7.fhir.r4.model.Base;
import org.hl7.fhir.r4.model.ElementDefinition;
import org.hl7.fhir.r4.model.ElementDefinition.TypeRefComponent;
import org.hl7.fhir.r4.model.Enumerations.BindingStrength;
import org.hl7.fhir.r4.model.ICoding;
import org.hl7.fhir.r4.model.StringType;
import org.hl7.fhir.r4.model.StructureDefinition;
import org.hl7.fhir.r4.model.Type;
import org.hl7.fhir.r4.model.ValueSet.ValueSetExpansionContainsComponent;
import org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome;
import org.hl7.fhir.utilities.ElementDecoration;
import org.hl7.fhir.utilities.ElementDecoration.DecorationType;
import org.hl7.fhir.utilities.Utilities;
import org.hl7.fhir.utilities.xhtml.XhtmlNode;

/**
 * This class represents the underlying reference model of FHIR
 * 
 * A resource is nothing but a set of elements, where every element has a name,
 * maybe a stated type, maybe an id, and either a value or child elements (one
 * or the other, but not both or neither)
 * 
 * @author Grahame Grieve
 *
 */
public class Element extends Base {

  public enum SpecialElement {
    CONTAINED, BUNDLE_ENTRY, BUNDLE_OUTCOME, PARAMETER;

    public static SpecialElement fromProperty(Property property) {
      if (property.getStructure().getIdElement().getIdPart().equals("Parameters"))
        return PARAMETER;
      if (property.getStructure().getIdElement().getIdPart().equals("Bundle") && property.getName().equals("resource"))
        return BUNDLE_ENTRY;
      if (property.getStructure().getIdElement().getIdPart().equals("Bundle") && property.getName().equals("outcome"))
        return BUNDLE_OUTCOME;
      if (property.getName().equals("contained"))
        return CONTAINED;
      throw new Error("Unknown resource containing a native resource: " + property.getDefinition().getId());
    }
  }

  private List comments;// not relevant for production, but useful in documentation
  private String name;
  private String type;
  private String value;
  private int index = -1;
  private List children;
  private Property property;
  private Property elementProperty; // this is used when special is set to true - it tracks the underlying element
                                    // property which is used in a few places
  private int line;
  private int col;
  private SpecialElement special;
  private XhtmlNode xhtml; // if this is populated, then value will also hold the string representation
  private String explicitType; // for xsi:type attribute

  public Element(String name) {
    super();
    this.name = name;
  }

  public Element(Element other) {
    super();
    name = other.name;
    type = other.type;
    property = other.property;
    elementProperty = other.elementProperty;
    special = other.special;
  }

  public Element(String name, Property property) {
    super();
    this.name = name;
    this.property = property;
  }

  public Element(String name, Property property, String type, String value) {
    super();
    this.name = name;
    this.property = property;
    this.type = type;
    this.value = value;
  }

  public void updateProperty(Property property, SpecialElement special, Property elementProperty) {
    this.property = property;
    this.elementProperty = elementProperty;
    this.special = special;
  }

  public SpecialElement getSpecial() {
    return special;
  }

  public String getName() {
    return name;
  }

  public String getType() {
    if (type == null)
      return property.getType(name);
    else
      return type;
  }

  public String getValue() {
    return value;
  }

  public boolean hasChildren() {
    return !(children == null || children.isEmpty());
  }

  public List getChildren() {
    if (children == null)
      children = new ArrayList();
    return children;
  }

  public boolean hasComments() {
    return !(comments == null || comments.isEmpty());
  }

  public List getComments() {
    if (comments == null)
      comments = new ArrayList();
    return comments;
  }

  public Property getProperty() {
    return property;
  }

  public void setValue(String value) {
    this.value = value;
  }

  public void setType(String type) {
    this.type = type;

  }

  public boolean hasValue() {
    return value != null;
  }

  public List getChildrenByName(String name) {
    List res = new ArrayList();
    if (hasChildren()) {
      for (Element child : children)
        if (name.equals(child.getName()))
          res.add(child);
    }
    return res;
  }

  public void numberChildren() {
    if (children == null)
      return;

    String last = "";
    int index = 0;
    for (Element child : children) {
      if (child.getProperty().isList()) {
        if (last.equals(child.getName())) {
          index++;
        } else {
          last = child.getName();
          index = 0;
        }
        child.index = index;
      } else {
        child.index = -1;
      }
      child.numberChildren();
    }
  }

  public int getIndex() {
    return index;
  }

  public boolean hasIndex() {
    return index > -1;
  }

  public void setIndex(int index) {
    this.index = index;
  }

  public String getChildValue(String name) {
    if (children == null)
      return null;
    for (Element child : children) {
      if (name.equals(child.getName()))
        return child.getValue();
    }
    return null;
  }

  public void setChildValue(String name, String value) {
    if (children == null)
      children = new ArrayList();
    for (Element child : children) {
      if (name.equals(child.getName())) {
        if (!child.isPrimitive())
          throw new Error("Cannot set a value of a non-primitive type (" + name + " on " + this.getName() + ")");
        child.setValue(value);
      }
    }
    try {
      setProperty(name.hashCode(), name, new StringType(value));
    } catch (FHIRException e) {
      throw new Error(e);
    }
  }

  public List getChildren(String name) {
    List res = new ArrayList();
    if (children != null)
      for (Element child : children) {
        if (name.equals(child.getName()))
          res.add(child);
      }
    return res;
  }

  public boolean hasType() {
    if (type == null)
      return property.hasType(name);
    else
      return true;
  }

  @Override
  public String fhirType() {
    return getType();
  }

  @Override
  public Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException {
    if (isPrimitive() && (hash == "value".hashCode()) && !Utilities.noString(value)) {
//  		String tn = getType();
//  		throw new Error(tn+" not done yet");
      Base[] b = new Base[1];
      b[0] = new StringType(value);
      return b;
    }

    List result = new ArrayList();
    if (children != null) {
      for (Element child : children) {
        if (child.getName().equals(name))
          result.add(child);
        if (child.getName().startsWith(name) && child.getProperty().isChoice()
            && child.getProperty().getName().equals(name + "[x]"))
          result.add(child);
      }
    }
    if (result.isEmpty() && checkValid) {
//  		throw new FHIRException("not determined yet");
    }
    return result.toArray(new Base[result.size()]);
  }

  @Override
  protected void listChildren(List childProps) {
    if (children != null) {
      Map map = new HashMap();
      for (Element c : children) {
        org.hl7.fhir.r4.model.Property p = map.get(c.getName());
        if (p == null) {
          p = new org.hl7.fhir.r4.model.Property(c.getName(), c.fhirType(),
              c.getProperty().getDefinition().getDefinition(), c.getProperty().getDefinition().getMin(),
              maxToInt(c.getProperty().getDefinition().getMax()), c);
          childProps.add(p);
          map.put(c.getName(), p);

        } else
          p.getValues().add(c);
      }
    }
  }

  @Override
  public Base copy() {
    Element element = new Element(this);
    this.copyValues(element);
    return element;
  }

  @Override
  public void copyValues(Base dst) {
    super.copyValues(dst);

    Element dest = (Element) dst;
    if (comments != null) {
      dest.comments = new ArrayList<>();
      dest.comments.addAll(comments);
    } else {
      dest.comments = null;
    }
    dest.value = value;
    if (children != null) {
      dest.children = new ArrayList<>();
      for (Element child : children) {
        dest.children.add((Element) child.copy());
      }
    } else {
      dest.children = null;
    }
    dest.line = line;
    dest.col = col;
    dest.xhtml = xhtml;
    dest.explicitType = explicitType;
  }

  @Override
  public Base setProperty(int hash, String name, Base value) throws FHIRException {
    if ("xhtml".equals(getType()) && (hash == "value".hashCode())) {
      this.xhtml = castToXhtml(value);
      this.value = castToXhtmlString(value);
      return this;
    }
    if (isPrimitive() && (hash == "value".hashCode())) {
      this.value = castToString(value).asStringValue();
      return this;
    }

    if (!value.isPrimitive() && !(value instanceof Element)) {
      if (isDataType(value))
        value = convertToElement(property.getChild(name), value);
      else
        throw new FHIRException("Cannot set property " + name + " on " + this.name
            + " - value is not a primitive type (" + value.fhirType() + ") or an ElementModel type");
    }

    if (children == null)
      children = new ArrayList();
    Element childForValue = null;

    // look through existing children
    for (Element child : children) {
      if (child.getName().equals(name)) {
        if (!child.isList()) {
          childForValue = child;
          break;
        } else {
          Element ne = new Element(child);
          children.add(ne);
          numberChildren();
          childForValue = ne;
          break;
        }
      }
    }

    int i = 0;
    if (childForValue == null)
      for (Property p : property.getChildProperties(this.name, type)) {
        int t = -1;
        for (int c = 0; c < children.size(); c++) {
          Element e = children.get(c);
          if (p.getName().equals(e.getName()))
            t = c;
        }
        if (t > i)
          i = t;
        if (p.getName().equals(name) || p.getName().equals(name + "[x]")) {
          Element ne = new Element(name, p);
          children.add(i, ne);
          childForValue = ne;
          break;
        }
      }

    if (childForValue == null)
      throw new Error("Cannot set property " + name + " on " + this.name);
    else if (value.isPrimitive()) {
      if (childForValue.property.getName().endsWith("[x]"))
        childForValue.name = name + Utilities.capitalize(value.fhirType());
      childForValue.setValue(value.primitiveValue());
    } else {
      Element ve = (Element) value;
      childForValue.type = ve.getType();
      if (childForValue.property.getName().endsWith("[x]"))
        childForValue.name = name + Utilities.capitalize(childForValue.type);
      else if (value.isResource()) {
        if (childForValue.elementProperty == null)
          childForValue.elementProperty = childForValue.property;
        childForValue.property = ve.property;
        childForValue.special = SpecialElement.BUNDLE_ENTRY;
      }
      if (ve.children != null) {
        if (childForValue.children == null)
          childForValue.children = new ArrayList();
        else
          childForValue.children.clear();
        childForValue.children.addAll(ve.children);
      }
    }
    return childForValue;
  }

  private Base convertToElement(Property prop, Base v) throws FHIRException {
    return new ObjectConverter(property.getContext()).convert(prop, (Type) v);
  }

  private boolean isDataType(Base v) {
    return v instanceof Type && property.getContext().getTypeNames().contains(v.fhirType());
  }

  @Override
  public Base makeProperty(int hash, String name) throws FHIRException {
    if (isPrimitive() && (hash == "value".hashCode())) {
      return new StringType(value);
    }

    if (children == null)
      children = new ArrayList();

    // look through existing children
    for (Element child : children) {
      if (child.getName().equals(name)) {
        if (!child.isList()) {
          return child;
        } else {
          Element ne = new Element(child);
          children.add(ne);
          numberChildren();
          return ne;
        }
      }
    }

    for (Property p : property.getChildProperties(this.name, type)) {
      if (p.getName().equals(name)) {
        Element ne = new Element(name, p);
        children.add(ne);
        return ne;
      }
    }

    throw new Error("Unrecognised name " + name + " on " + this.name);
  }

  private int maxToInt(String max) {
    if (max.equals("*"))
      return Integer.MAX_VALUE;
    else
      return Integer.parseInt(max);
  }

  @Override
  public boolean isPrimitive() {
    return type != null ? property.isPrimitive(type) : property.isPrimitive(property.getType(name));
  }

  @Override
  public boolean isBooleanPrimitive() {
    return isPrimitive() && ("boolean".equals(type) || "boolean".equals(property.getType(name)));
  }

  @Override
  public boolean isResource() {
    return property.isResource();
  }

  @Override
  public boolean hasPrimitiveValue() {
    return property.isPrimitiveName(name) || property.IsLogicalAndHasPrimitiveValue(name);
  }

  @Override
  public String primitiveValue() {
    if (isPrimitive())
      return value;
    else {
      if (hasPrimitiveValue() && children != null) {
        for (Element c : children) {
          if (c.getName().equals("value"))
            return c.primitiveValue();
        }
      }
      return null;
    }
  }

  // for the validator
  public int line() {
    return line;
  }

  public int col() {
    return col;
  }

  public Element markLocation(int line, int col) {
    this.line = line;
    this.col = col;
    return this;
  }

  public void clearDecorations() {
    clearUserData("fhir.decorations");
    for (Element e : children)
      e.clearDecorations();
  }

  public void markValidation(StructureDefinition profile, ElementDefinition definition) {
    @SuppressWarnings("unchecked")
    List decorations = (List) getUserData("fhir.decorations");
    if (decorations == null) {
      decorations = new ArrayList<>();
      setUserData("fhir.decorations", decorations);
    }
    decorations.add(new ElementDecoration(DecorationType.TYPE, profile.getUserString("path"), definition.getPath()));
    if (definition.getId() != null && tail(definition.getId()).contains(":")) {
      String[] details = tail(definition.getId()).split(":");
      decorations.add(new ElementDecoration(DecorationType.SLICE, null, details[1]));
    }
  }

  private String tail(String id) {
    return id.contains(".") ? id.substring(id.lastIndexOf(".") + 1) : id;
  }

  public Element getNamedChild(String name) {
    if (children == null)
      return null;
    Element result = null;
    for (Element child : children) {
      if (child.getName().equals(name)) {
        if (result == null)
          result = child;
        else
          throw new Error("Attempt to read a single element when there is more than one present (" + name + ")");
      }
    }
    return result;
  }

  public void getNamedChildren(String name, List list) {
    if (children != null)
      for (Element child : children)
        if (child.getName().equals(name))
          list.add(child);
  }

  public String getNamedChildValue(String name) {
    Element child = getNamedChild(name);
    return child == null ? null : child.value;
  }

  public void getNamedChildrenWithWildcard(String string, List values) {
    Validate.isTrue(string.endsWith("[x]"));

    String start = string.substring(0, string.length() - 3);
    if (children != null) {
      for (Element child : children) {
        if (child.getName().startsWith(start)) {
          values.add(child);
        }
      }
    }
  }

  public XhtmlNode getXhtml() {
    return xhtml;
  }

  public Element setXhtml(XhtmlNode xhtml) {
    this.xhtml = xhtml;
    return this;
  }

  @Override
  public boolean isEmpty() {
    // GG: this used to also test !"".equals(value).
    // the condition where "" is empty and there are no children is an error, and so
    // this really only manifested as an issue in corner cases technical testing of
    // the validator / FHIRPath.
    // it should not cause any problems in real life.
    if (value != null) {
      return false;
    }
    for (Element next : getChildren()) {
      if (!next.isEmpty()) {
        return false;
      }
    }
    return true;
  }

  public Property getElementProperty() {
    return elementProperty;
  }

  public boolean hasElementProperty() {
    return elementProperty != null;
  }

  public boolean hasChild(String name) {
    return getNamedChild(name) != null;
  }

  public boolean hasChildren(String name) {
    if (children != null)
      for (Element child : children)
        if (child.getName().equals(name))
          return true;
    return false;
  }

  @Override
  public String toString() {
    return name + "=" + fhirType() + "["
        + (children == null || hasValue() ? value : Integer.toString(children.size()) + " children") + "]";
  }

  @Override
  public String getIdBase() {
    return getChildValue("id");
  }

  @Override
  public void setIdBase(String value) {
    setChildValue("id", value);
  }

  @Override
  public boolean equalsDeep(Base other) {
    if (!super.equalsDeep(other))
      return false;
    if (isPrimitive() && other.isPrimitive())
      return primitiveValue().equals(other.primitiveValue());
    if (isPrimitive() || other.isPrimitive())
      return false;
    Set processed = new HashSet();
    for (org.hl7.fhir.r4.model.Property p : children()) {
      String name = p.getName();
      processed.add(name);
      org.hl7.fhir.r4.model.Property o = other.getChildByName(name);
      if (!equalsDeep(p, o))
        return false;
    }
    for (org.hl7.fhir.r4.model.Property p : children()) {
      String name = p.getName();
      if (!processed.contains(name)) {
        org.hl7.fhir.r4.model.Property o = other.getChildByName(name);
        if (!equalsDeep(p, o))
          return false;
      }
    }
    return true;
  }

  private boolean equalsDeep(org.hl7.fhir.r4.model.Property p, org.hl7.fhir.r4.model.Property o) {
    if (o == null || p == null)
      return false;
    if (p.getValues().size() != o.getValues().size())
      return false;
    for (int i = 0; i < p.getValues().size(); i++)
      if (!Base.compareDeep(p.getValues().get(i), o.getValues().get(i), true))
        return false;
    return true;
  }

  @Override
  public boolean equalsShallow(Base other) {
    if (!super.equalsShallow(other))
      return false;
    if (isPrimitive() && other.isPrimitive())
      return primitiveValue().equals(other.primitiveValue());
    if (isPrimitive() || other.isPrimitive())
      return false;
    return true; // ?
  }

  public Type asType() throws FHIRException {
    return new ObjectConverter(property.getContext()).convertToType(this);
  }

  @Override
  public boolean isMetadataBased() {
    return true;
  }

  public boolean isList() {
    if (elementProperty != null)
      return elementProperty.isList();
    else
      return property.isList();
  }

  @Override
  public String[] getTypesForProperty(int hash, String name) throws FHIRException {
    Property p = property.getChildSimpleName(this.name, name);
    if (p != null) {
      Set types = new HashSet();
      for (TypeRefComponent tr : p.getDefinition().getType()) {
        types.add(tr.getCode());
      }
      return types.toArray(new String[] {});
    }
    return super.getTypesForProperty(hash, name);

  }

  public void sort() {
    if (children != null) {
      List remove = new ArrayList();
      for (Element child : children) {
        child.sort();
        if (child.isEmpty())
          remove.add(child);
      }
      children.removeAll(remove);
      Collections.sort(children, new ElementSortComparator(this, this.property));
    }
  }

  public class ElementSortComparator implements Comparator {
    private List children;

    public ElementSortComparator(Element e, Property property) {
      String tn = e.getType();
      StructureDefinition sd = property.getContext().fetchResource(StructureDefinition.class,
          ProfileUtilities.sdNs(tn, property.getContext().getOverrideVersionNs()));
      if (sd != null && !sd.getAbstract())
        children = sd.getSnapshot().getElement();
      else
        children = property.getStructure().getSnapshot().getElement();
    }

    @Override
    public int compare(Element e0, Element e1) {
      int i0 = find(e0);
      int i1 = find(e1);
      return Integer.compare(i0, i1);
    }

    private int find(Element e0) {
      int i = e0.elementProperty != null ? children.indexOf(e0.elementProperty.getDefinition())
          : children.indexOf(e0.property.getDefinition());
      return i;
    }

  }

  public class ICodingImpl implements ICoding {
    private String system;
    private String version;
    private String code;
    private String display;
    private boolean doesSystem;
    private boolean doesVersion;
    private boolean doesCode;
    private boolean doesDisplay;

    public ICodingImpl(boolean doesCode, boolean doesSystem, boolean doesVersion, boolean doesDisplay) {
      super();
      this.doesCode = doesCode;
      this.doesSystem = doesSystem;
      this.doesVersion = doesVersion;
      this.doesDisplay = doesDisplay;
    }

    public String getSystem() {
      return system;
    }

    public String getVersion() {
      return version;
    }

    public String getCode() {
      return code;
    }

    public String getDisplay() {
      return display;
    }

    public boolean hasSystem() {
      return !Utilities.noString(system);
    }

    public boolean hasVersion() {
      return !Utilities.noString(version);
    }

    public boolean hasCode() {
      return !Utilities.noString(code);
    }

    public boolean hasDisplay() {
      return !Utilities.noString(display);
    }

    public boolean supportsSystem() {
      return doesSystem;
    }

    public boolean supportsVersion() {
      return doesVersion;
    }

    public boolean supportsCode() {
      return doesCode;
    }

    public boolean supportsDisplay() {
      return doesDisplay;
    }
  }

  public ICoding getAsICoding() throws FHIRException {
    if ("code".equals(fhirType())) {
      if (property.getDefinition().getBinding().getStrength() != BindingStrength.REQUIRED)
        return null;
      ICodingImpl c = new ICodingImpl(true, true, false, false);
      c.code = primitiveValue();
      ValueSetExpansionOutcome vse = property.getContext().expandVS(property.getDefinition().getBinding(), true, false);
      if (vse.getValueset() == null)
        return null;
      for (ValueSetExpansionContainsComponent cc : vse.getValueset().getExpansion().getContains()) {
        if (cc.getCode().equals(c.code)) {
          c.system = cc.getSystem();
          if (cc.hasVersion()) {
            c.doesVersion = true;
            c.version = cc.getVersion();
          }
          if (cc.hasDisplay()) {
            c.doesDisplay = true;
            c.display = cc.getDisplay();
          }
        }
      }
      if (c.system == null)
        return null;
      return c;
    } else if ("Coding".equals(fhirType())) {
      ICodingImpl c = new ICodingImpl(true, true, true, true);
      c.system = getNamedChildValue("system");
      c.code = getNamedChildValue("code");
      c.display = getNamedChildValue("display");
      c.version = getNamedChildValue("version");
      return c;
    } else if ("Quantity".equals(fhirType())) {
      ICodingImpl c = new ICodingImpl(true, true, false, false);
      c.system = getNamedChildValue("system");
      c.code = getNamedChildValue("code");
      return c;
    } else
      return null;
  }

  public String getExplicitType() {
    return explicitType;
  }

  public void setExplicitType(String explicitType) {
    this.explicitType = explicitType;
  }

}