Expose created entities after finalizing form

src/main/java/org/javarosa/core/model/FormDef.java

@@ -16,19 +16,6 @@
 
 package org.javarosa.core.model;
 
-import java.io.DataInputStream;
-import java.io.DataOutputStream;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.NoSuchElementException;
-import java.util.Set;
 import org.javarosa.core.log.WrappedException;
 import org.javarosa.core.model.TriggerableDag.EventNotifierAccessor;
 import org.javarosa.core.model.actions.ActionController;
@@ -55,12 +42,15 @@
 import org.javarosa.core.services.locale.Localizer;
 import org.javarosa.core.services.storage.IMetaData;
 import org.javarosa.core.services.storage.Persistable;
+import org.javarosa.core.util.Extras;
 import org.javarosa.core.util.externalizable.DeserializationException;
 import org.javarosa.core.util.externalizable.ExtUtil;
 import org.javarosa.core.util.externalizable.ExtWrapListPoly;
 import org.javarosa.core.util.externalizable.ExtWrapMap;
 import org.javarosa.core.util.externalizable.ExtWrapNullable;
 import org.javarosa.core.util.externalizable.ExtWrapTagged;
+import org.javarosa.core.util.externalizable.Externalizable;
+import org.javarosa.core.util.externalizable.ExternalizableExtras;
 import org.javarosa.core.util.externalizable.PrototypeFactory;
 import org.javarosa.debug.EvaluationResult;
 import org.javarosa.debug.Event;
@@ -75,6 +65,22 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Set;
+
+import static java.util.Collections.emptyList;
+
 /**
  * Definition of a form. This has some meta data about the form definition and a
  * collection of groups together with question branching or skipping rules.
@@ -89,6 +95,7 @@ public class FormDef implements IFormElement, Localizable, Persistable, IMetaDat
     public static final int TEMPLATING_RECURSION_LIMIT = 10;
 
     private static EventNotifier defaultEventNotifier = new EventNotifierSilent();
+    private ExternalizableExtras extras = new ExternalizableExtras();
 
     /**
      * Takes a (possibly relative) reference, and makes it absolute based on its parent.
@@ -1002,9 +1009,9 @@ public void preloadInstance(TreeElement node) {
         // }
     }
 
-    public boolean postProcessInstance() {
+    public void postProcessInstance() {
         actionController.triggerActionsFromEvent(Actions.EVENT_XFORMS_REVALIDATE, elementsWithActionTriggeredByToplevelEvent, this);
-        return postProcessInstance(mainInstance.getRoot());
+        postProcessInstance(mainInstance.getRoot());
     }
 
     /**
@@ -1112,6 +1119,8 @@ public void readExternal(DataInputStream dis, PrototypeFactory pf) throws IOExce
 
         List<TreeReference> treeReferencesWithActions = (List<TreeReference>) ExtUtil.read(dis, new ExtWrapListPoly(), pf);
         elementsWithActionTriggeredByToplevelEvent = getElementsFromReferences(treeReferencesWithActions);
+
+        extras = (ExternalizableExtras) ExtUtil.read(dis, ExternalizableExtras.class);
     }
 
     /**
@@ -1215,6 +1224,8 @@ public void writeExternal(DataOutputStream dos) throws IOException {
         ExtUtil.write(dos, new ExtWrapNullable(actionController));
         ExtUtil.write(dos, new ExtWrapListPoly(new ArrayList<>(actions)));
         ExtUtil.write(dos, new ExtWrapListPoly(getReferencesFromElements(elementsWithActionTriggeredByToplevelEvent)));
+
+        ExtUtil.write(dos, extras);
     }
 
     /**
@@ -1600,7 +1611,7 @@ public String getAdditionalAttribute(String namespace, String name) {
     @Override
     public List<TreeElement> getAdditionalAttributes() {
         // Not supported.
-        return Collections.emptyList();
+        return emptyList();
     }
 
     public <X extends XFormExtension> X getExtension(Class<X> extension) {
@@ -1690,4 +1701,8 @@ private String getFormXmlPath() {
     public HashMap<String, DataInstance> getFormInstances() {
         return formInstances;
     }
+
+    public Extras<Externalizable> getExtras() {
+        return extras;
+    }
 }

src/main/java/org/javarosa/core/model/instance/AbstractTreeElement.java

@@ -6,6 +6,7 @@
 import org.javarosa.core.model.data.IAnswerData;
 import org.javarosa.core.model.instance.utils.ITreeVisitor;
 import org.javarosa.xpath.expr.XPathExpression;
+import org.jetbrains.annotations.Nullable;
 
 public interface AbstractTreeElement<T extends AbstractTreeElement> {
 
@@ -15,6 +16,13 @@ public interface AbstractTreeElement<T extends AbstractTreeElement> {
 
     public abstract String getInstanceName();
 
+    @Nullable
+    public T getFirstChild(String name);
+
+    @Nullable
+    public T getFirstChild(String namespace, String name);
+
+    @Nullable
     public abstract T getChild(String name, int multiplicity);
 
     /**

src/main/java/org/javarosa/core/model/instance/FormInstance.java

@@ -16,12 +16,6 @@
 
 package org.javarosa.core.model.instance;
 
-import java.io.DataInputStream;
-import java.io.DataOutputStream;
-import java.io.IOException;
-import java.util.Date;
-import java.util.HashMap;
-
 import org.javarosa.core.model.FormDef;
 import org.javarosa.core.model.data.IAnswerData;
 import org.javarosa.core.model.instance.utils.ITreeVisitor;
@@ -34,6 +28,12 @@
 import org.javarosa.core.util.externalizable.ExtWrapNullable;
 import org.javarosa.core.util.externalizable.PrototypeFactory;
 
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.util.Date;
+import java.util.HashMap;
+
 
 /**
  * This class represents the xform model instance
@@ -312,10 +312,8 @@ public void readExternal(DataInputStream in, PrototypeFactory pf) throws IOExcep
         super.readExternal(in, pf);
         schema = (String) ExtUtil.read(in, new ExtWrapNullable(String.class), pf);
         dateSaved = (Date) ExtUtil.read(in, new ExtWrapNullable(Date.class), pf);
-
         namespaces = (HashMap<String,Object>)ExtUtil.read(in, new ExtWrapMap(String.class, String.class));
         setRoot((TreeElement) ExtUtil.read(in, TreeElement.class, pf));
-
     }
 
     public void writeExternal(DataOutputStream out) throws IOException {

src/main/java/org/javarosa/core/model/instance/TreeElement.java

@@ -50,6 +50,7 @@
 import org.javarosa.xpath.expr.XPathExpression;
 import org.javarosa.xpath.expr.XPathPathExpr;
 import org.javarosa.xpath.expr.XPathStringLiteral;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * <p>An element of a FormInstance.</p>
@@ -221,6 +222,25 @@ public void setValue(IAnswerData value) {
     }
 
     @Override
+    @Nullable
+    public TreeElement getFirstChild(String name) {
+        return getChild(name, 0);
+    }
+
+    @Nullable
+    @Override
+    public TreeElement getFirstChild(String namespace, String name) {
+        TreeElement firstChild = getFirstChild(name);
+
+        if (firstChild == null || firstChild.getNamespace().equals(namespace)) {
+            return firstChild;
+        } else {
+            return null;
+        }
+    }
+
+    @Override
+    @Nullable
     public TreeElement getChild(String name, int multiplicity) {
         return children.get(name, multiplicity);
     }

src/main/java/org/javarosa/core/model/instance/utils/TreeElementChildrenList.java

@@ -2,6 +2,7 @@
 
 import org.javarosa.core.model.instance.TreeElement;
 import org.javarosa.core.model.instance.TreeReference;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -72,6 +73,7 @@ public List<TreeElement> get(String name) {
     }
 
     /** Gets the child with the specified name and multiplicity */
+    @Nullable
     public TreeElement get(String name, int multiplicity) {
         TreeElementChildrenList.ElementAndLoc el = getChildAndLoc(name, multiplicity);
         if (el == null) {

src/main/java/org/javarosa/core/util/Extras.java

@@ -0,0 +1,21 @@
+package org.javarosa.core.util;
+
+import java.util.HashMap;
+
+/**
+ * Store for objects that allows them to be retrieved by type without any casting.
+ *
+ * @param <T> allows a super type to be enforced for all the stored objects
+ */
+public class Extras<T> {
+
+    protected final HashMap<String, T> map = new HashMap<>();
+
+    public void put(T extra) {
+        map.put(extra.getClass().getName(), extra);
+    }
+
+    public <U extends T> U get(Class<U> key) {
+        return (U) map.get(key.getName());
+    }
+}

src/main/java/org/javarosa/core/util/externalizable/ExtWrapExternalizable.java

@@ -0,0 +1,48 @@
+package org.javarosa.core.util.externalizable;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+
+public class ExtWrapExternalizable extends ExternalizableWrapper {
+
+    public ExtWrapExternalizable() {
+    }
+
+    public ExtWrapExternalizable(Externalizable externalizable) {
+        this.val = externalizable;
+    }
+
+    @Override
+    public ExternalizableWrapper clone(Object val) {
+        return null;
+    }
+
+    @Override
+    public void metaReadExternal(DataInputStream in, PrototypeFactory pf) throws IOException, DeserializationException {
+
+    }
+
+    @Override
+    public void metaWriteExternal(DataOutputStream out) throws IOException {
+
+    }
+
+    @Override
+    public void readExternal(DataInputStream in, PrototypeFactory pf) throws IOException, DeserializationException {
+        try {
+            String className = ExtUtil.readString(in);
+            Class<?> clazz = Class.forName(className);
+
+            this.val = ExtUtil.read(in, clazz);
+        } catch (ClassNotFoundException e) {
+            throw new DeserializationException("Couldn't find class from serialize class name!");
+        }
+    }
+
+    @Override
+    public void writeExternal(DataOutputStream out) throws IOException {
+        ExtUtil.write(out, val.getClass().getName());
+        ExtUtil.write(out, val);
+    }
+}

src/main/java/org/javarosa/core/util/externalizable/ExternalizableExtras.java

@@ -0,0 +1,27 @@
+package org.javarosa.core.util.externalizable;
+
+import org.javarosa.core.util.Extras;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.util.HashMap;
+
+public class ExternalizableExtras extends Extras<Externalizable> implements Externalizable {
+
+    @Override
+    public void readExternal(DataInputStream in, PrototypeFactory pf) throws IOException, DeserializationException {
+        HashMap<String, Externalizable> extras = (HashMap<String, Externalizable>) ExtUtil.read(in, new ExtWrapMap(String.class, new ExtWrapExternalizable()), pf);
+        extras.forEach((s, externalizable) -> put(externalizable));
+    }
+
+    @Override
+    public void writeExternal(DataOutputStream out) throws IOException {
+        HashMap<Object, Object> wrappedParseAttachments = new HashMap<>();
+        map.forEach((key, value) -> {
+            wrappedParseAttachments.put(key, new ExtWrapExternalizable(value));
+        });
+
+        ExtUtil.write(out, new ExtWrapMap(wrappedParseAttachments));
+    }
+}

src/main/java/org/javarosa/entities/Entity.java

@@ -0,0 +1,16 @@
+package org.javarosa.entities;
+
+import kotlin.Pair;
+
+import java.util.List;
+
+public class Entity {
+
+    public final String dataset;
+    public final List<Pair<String, String>> properties;
+
+    public Entity(String dataset, List<Pair<String, String>> properties) {
+        this.dataset = dataset;
+        this.properties = properties;
+    }
+}

src/main/java/org/javarosa/entities/EntityFinalizer.java

@@ -0,0 +1,43 @@
+package org.javarosa.entities;
+
+import kotlin.Pair;
+import org.javarosa.core.model.FormDef;
+import org.javarosa.core.model.IDataReference;
+import org.javarosa.core.model.instance.FormInstance;
+import org.javarosa.entities.internal.Entities;
+import org.javarosa.entities.internal.EntityDatasetParser;
+import org.javarosa.entities.internal.EntityFormExtra;
+import org.javarosa.form.api.FormEntryModel;
+import org.javarosa.form.api.FormEntryFinalizer;
+import org.javarosa.model.xform.XPathReference;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static java.util.Arrays.asList;
+import static java.util.Collections.emptyList;
+
+public class EntityFinalizer implements FormEntryFinalizer {
+
+    @Override
+    public void processForm(FormEntryModel formEntryModel) {
+        FormDef formDef = formEntryModel.getForm();
+        FormInstance mainInstance = formDef.getMainInstance();
+
+        EntityFormExtra entityFormExtra = formDef.getExtras().get(EntityFormExtra.class);
+        List<Pair<XPathReference, String>> saveTos = entityFormExtra.getSaveTos();
+
+        String dataset = EntityDatasetParser.parseFirstDatasetToCreate(mainInstance);
+        if (dataset != null) {
+            List<Pair<String, String>> fields = saveTos.stream().map(saveTo -> {
+                IDataReference reference = saveTo.getFirst();
+                String answer = mainInstance.resolveReference(reference).getValue().getDisplayText();
+                return new Pair<>(saveTo.getSecond(), answer);
+            }).collect(Collectors.toList());
+
+            formEntryModel.getExtras().put(new Entities(asList(new Entity(dataset, fields))));
+        } else {
+            formEntryModel.getExtras().put(new Entities(emptyList()));
+        }
+    }
+}