First version of a working open API model generator

aom/src/main/java/com/nedap/archie/aom/Archetype.java

@@ -14,6 +14,7 @@
 import com.nedap.archie.xml.adapters.ArchetypeTerminologyAdapter;
 import com.nedap.archie.xml.adapters.RMOverlayXmlAdapter;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAttribute;
@@ -55,6 +56,7 @@
 public class Archetype extends AuthoredResource {
 
     @XmlElement(name="parent_archetype_id")
+    @Nullable
     private String parentArchetypeId;
     @XmlAttribute(name="is_differential")
     private boolean differential = false;
@@ -64,9 +66,11 @@ public class Archetype extends AuthoredResource {
     private CComplexObject definition;
     @XmlJavaTypeAdapter(ArchetypeTerminologyAdapter.class)
     private ArchetypeTerminology terminology;
+    @Nullable
     private RulesSection rules = null;
 
     @XmlAttribute(name="adl_version")
+    @Nullable
     private String adlVersion;
     @XmlElement(name="build_uid")
     private String buildUid;

aom/src/main/java/com/nedap/archie/aom/ArchetypeConstraint.java

@@ -4,6 +4,7 @@
 import com.nedap.archie.paths.PathSegment;
 import com.nedap.archie.paths.PathUtil;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlTransient;
 
 import java.util.List;
@@ -14,7 +15,9 @@
 public abstract class ArchetypeConstraint extends ArchetypeModelObject {
 
     @JsonIgnore //ignore these field in popular object mappers
+    @Nullable
     private transient ArchetypeConstraint parent;
+    @Nullable
     @JsonIgnore //ignore these field in popular object mappers, otherwise we get infinite loops
     private transient CSecondOrder<?> socParent;
 

aom/src/main/java/com/nedap/archie/aom/ArchetypeHRID.java

@@ -7,6 +7,7 @@
 import com.nedap.archie.definitions.VersionStatus;
 import com.nedap.archie.rminfo.RMPropertyIgnore;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAttribute;
@@ -32,6 +33,7 @@
 })
 public class ArchetypeHRID extends ArchetypeModelObject {
 
+    @Nullable
     private String namespace;
     @XmlAttribute(name="rm_publisher")
     private String rmPublisher;

aom/src/main/java/com/nedap/archie/aom/ArchetypeSlot.java

@@ -2,6 +2,7 @@
 
 import com.nedap.archie.rules.Assertion;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlType;
 import java.util.ArrayList;
@@ -17,7 +18,9 @@
 })
 public class ArchetypeSlot extends CObject {
 
+    @Nullable
     private List<Assertion> includes = new ArrayList<>();
+    @Nullable
     private List<Assertion> excludes = new ArrayList<>();
     @XmlElement(name="is_closed")
     private boolean closed = false;

aom/src/main/java/com/nedap/archie/aom/CAttribute.java

@@ -9,6 +9,7 @@
 import com.nedap.archie.paths.PathSegment;
 import com.nedap.archie.query.APathQuery;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAttribute;
@@ -35,14 +36,18 @@ public class CAttribute extends ArchetypeConstraint {
 
     @XmlAttribute(name="rm_attribute_name")
     private String rmAttributeName;
+    @Nullable
     private MultiplicityInterval existence;
     @XmlElement(name="differential_path")
+    @Nullable
     private String differentialPath;
     @XmlElement(name="is_multiple")
     private boolean multiple;
 
+    @Nullable
     private Cardinality cardinality;
 
+    @Nullable
     private List<CObject> children = new ArrayList<>();
 
     public CAttribute() {

aom/src/main/java/com/nedap/archie/aom/CAttributeTuple.java

@@ -4,6 +4,7 @@
 import com.nedap.archie.rminfo.ModelInfoLookup;
 import com.nedap.archie.rminfo.RMAttributeInfo;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlType;
 import java.lang.reflect.InvocationTargetException;
 import java.util.ArrayList;
@@ -28,6 +29,7 @@ public class CAttributeTuple extends CSecondOrder<CAttribute> {
      * The members List of CSecondOrder contains the attribute names.
      */
 
+    @Nullable
     private List<CPrimitiveTuple> tuples = new ArrayList<>();
 
     public List<CPrimitiveTuple> getTuples() {

aom/src/main/java/com/nedap/archie/aom/CComplexObject.java

@@ -5,6 +5,7 @@
 import com.nedap.archie.base.OpenEHRBase;
 import com.nedap.archie.query.AOMPathQuery;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -24,9 +25,11 @@
 })
 public class CComplexObject extends CDefinedObject<OpenEHRBase> {
 
+    @Nullable
     private List<CAttribute> attributes = new ArrayList<>();
 
     @XmlElement(name="attributeTuples")
+    @Nullable
     private List<CAttributeTuple> attributeTuples = new ArrayList<>();
 
     @JsonIgnore

aom/src/main/java/com/nedap/archie/aom/CDefinedObject.java

@@ -1,5 +1,6 @@
 package com.nedap.archie.aom;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlType;
 
@@ -13,6 +14,7 @@
 public abstract class CDefinedObject<T> extends CObject {
 
     @XmlElement(name="default_value") //TODO: this will not deserialize, it needs possible classes
+    @Nullable
     private T defaultValue;
 
     public T getDefaultValue() {

aom/src/main/java/com/nedap/archie/aom/CObject.java

@@ -10,6 +10,7 @@
 import com.nedap.archie.paths.PathSegment;
 import org.openehr.utils.message.I18n;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAttribute;
@@ -40,13 +41,16 @@ public abstract class CObject extends ArchetypeConstraint {
     @XmlAttribute(name="rm_type_name")
     private String rmTypeName;
     @XmlElement(name="occurrences")
+    @Nullable
     private MultiplicityInterval occurrences;
     @XmlAttribute(name="node_id")
     private String nodeId;
     @XmlAttribute(name="is_deprecated")
+    @Nullable
     private Boolean deprecated;
 
     @XmlElement(name="sibling_order")
+    @Nullable
     private SiblingOrder siblingOrder;
 
 

aom/src/main/java/com/nedap/archie/aom/CPrimitiveObject.java

@@ -7,6 +7,7 @@
 import org.openehr.utils.message.I18n;
 
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlType;
@@ -26,8 +27,10 @@ public abstract class CPrimitiveObject<Constraint, ValueType> extends CDefinedOb
 
     public static final String PRIMITIVE_NODE_ID_VALUE = "id9999";
 
+    @Nullable
     private Boolean enumeratedTypeConstraint;
 
+    @Nullable
     public abstract ValueType getAssumedValue();
 
     public abstract void setAssumedValue(ValueType assumedValue);

aom/src/main/java/com/nedap/archie/aom/CSecondOrder.java

@@ -1,5 +1,6 @@
 package com.nedap.archie.aom;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlType;
 import java.util.ArrayList;
 import java.util.List;
@@ -9,6 +10,7 @@
  */
 @XmlType(name="C_SECOND_ORDER")
 public class CSecondOrder<T extends ArchetypeConstraint> extends ArchetypeModelObject {
+    @Nullable
     private List<T> members = new ArrayList<>();
 
     public T getMember(int i) {

aom/src/main/java/com/nedap/archie/aom/OperationalTemplate.java

@@ -1,7 +1,10 @@
 package com.nedap.archie.aom;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
+
+import com.esotericsoftware.kryo.kryo5.util.Null;
 import com.nedap.archie.aom.terminology.ArchetypeTerm;
 import com.nedap.archie.aom.terminology.ArchetypeTerminology;
 import com.nedap.archie.aom.utils.AOMUtils;
@@ -27,8 +30,10 @@ public class OperationalTemplate extends AuthoredArchetype {
      * terminology extracts from subarchetypes, for example snomed codes, multiple choice thingies, etc
      */
     @XmlElement(name="terminology_extracts") //TODO: requires an adapter for JAXB to work
+    @Nullable
     private Map<String, ArchetypeTerminology> terminologyExtracts = new ConcurrentHashMap<>();//TODO: is this correct?
     @XmlElement(name="component_terminologies") //TODO: requires an adapter for JAXB to work
+    @Nullable
     private Map<String, ArchetypeTerminology> componentTerminologies = new ConcurrentHashMap<>();
 
 

aom/src/main/java/com/nedap/archie/aom/ResourceDescription.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonAlias;
 import com.nedap.archie.base.terminology.TerminologyCode;
 
+import javax.annotation.Nullable;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -15,20 +16,33 @@
 public class ResourceDescription extends ArchetypeModelObject {
 
     private Map<String, String> originalAuthor = new ConcurrentHashMap<>();
+    @Nullable
     private String originalNamespace;
+    @Nullable
     private String originalPublisher;
+    @Nullable
     private List<String> otherContributors = new ArrayList<>();
     private TerminologyCode lifecycleState;
+    @Nullable
     private String custodianNamespace;
+    @Nullable
     private String custodianOrganisation;
+    @Nullable
     private String copyright;
+    @Nullable
     private String licence;
+    @Nullable
     private Map<String, String> ipAcknowledgements = new ConcurrentHashMap<>();
+    @Nullable
     private Map<String, String> references = new ConcurrentHashMap<>();
+    @Nullable
     private String resourcePackageUri;
+    @Nullable
     private Map<String, String> conversionDetails = new ConcurrentHashMap<>();
+    @Nullable
     private Map<String, String> otherDetails = new ConcurrentHashMap<>();
 
+    @Nullable
     private Map<String, ResourceDescriptionItem>  details = new ConcurrentHashMap<>();
 
     public Map<String, String> getOriginalAuthor() {

aom/src/main/java/com/nedap/archie/aom/ResourceDescriptionItem.java

@@ -2,6 +2,7 @@
 
 import com.nedap.archie.base.terminology.TerminologyCode;
 
+import javax.annotation.Nullable;
 import java.net.URI;
 import java.util.List;
 import java.util.Map;
@@ -12,10 +13,15 @@
 public class ResourceDescriptionItem extends ArchetypeModelObject {
     private TerminologyCode language;
     private String purpose;
+    @Nullable
     private List<String> keywords;
+    @Nullable
     private String use;
+    @Nullable
     private String misuse;
+    @Nullable
     private String copyright;
+    @Nullable
     private Map<String, URI> originalResourceUri;
     private Map<String, String> otherDetails;//TODO: string -> object?
 

aom/src/main/java/com/nedap/archie/aom/Template.java

@@ -1,5 +1,8 @@
 package com.nedap.archie.aom;
 
+import com.fasterxml.jackson.annotation.JsonAlias;
+
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
@@ -15,8 +18,10 @@
 @XmlRootElement(name="archetype")
 public class Template extends AuthoredArchetype {
 
+    @Nullable
     private List<TemplateOverlay> templateOverlays = new ArrayList<>();
 
+    @JsonAlias("overlays")
     public List<TemplateOverlay> getTemplateOverlays() {
         return templateOverlays;
     }

aom/src/main/java/com/nedap/archie/aom/primitives/CBoolean.java

@@ -22,6 +22,7 @@
 @XmlType(name="C_BOOLEAN")
 public class CBoolean extends CPrimitiveObject<Boolean, Boolean> {
     @XmlElement(name="assumed_value")
+    @Nullable
     private Boolean assumedValue;
     @Nullable
     private List<Boolean> constraint = new ArrayList<>();

aom/src/main/java/com/nedap/archie/aom/primitives/CDate.java

@@ -4,6 +4,7 @@
 import com.nedap.archie.xml.adapters.DateIntervalXmlAdapter;
 import com.nedap.archie.xml.adapters.DateXmlAdapter;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -22,8 +23,10 @@ public class CDate extends CTemporal<Temporal> {
 
     @XmlJavaTypeAdapter(DateXmlAdapter.class)
     @XmlElement(name="assumed_value")
+    @Nullable
     private Temporal assumedValue;
     @XmlJavaTypeAdapter(DateIntervalXmlAdapter.class)
+    @Nullable
     private List<Interval<Temporal>> constraint = new ArrayList<>();
 
     @Override

aom/src/main/java/com/nedap/archie/aom/primitives/CDateTime.java

@@ -4,6 +4,7 @@
 import com.nedap.archie.xml.adapters.DateTimeIntervalXmlAdapter;
 import com.nedap.archie.xml.adapters.DateTimeXmlAdapter;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -22,8 +23,10 @@ public class CDateTime extends CTemporal<TemporalAccessor> {
 
     @XmlJavaTypeAdapter(DateTimeXmlAdapter.class)
     @XmlElement(name="assumed_value")
+    @Nullable
     private TemporalAccessor assumedValue;
     @XmlJavaTypeAdapter(DateTimeIntervalXmlAdapter.class)
+    @Nullable
     private List<Interval<TemporalAccessor>> constraint = new ArrayList<>();
 
     @Override

aom/src/main/java/com/nedap/archie/aom/primitives/CDuration.java

@@ -4,6 +4,7 @@
 import com.nedap.archie.xml.adapters.DurationIntervalXmlAdapter;
 import com.nedap.archie.xml.adapters.DurationXmlAdapter;
 
+import javax.annotation.Nullable;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -22,8 +23,10 @@ public class CDuration extends CTemporal<TemporalAmount> {
 
     @XmlJavaTypeAdapter(DurationXmlAdapter.class)
     @XmlElement(name="assumed_value")
+    @Nullable
     private TemporalAmount assumedValue;
     @XmlJavaTypeAdapter(DurationIntervalXmlAdapter.class)
+    @Nullable
     private List<Interval<TemporalAmount>> constraint = new ArrayList<>();
 
     @Override