CSV data export: include multiple entities (#201)

* CSV data export: support multiple entity

* multiple entity column provider: changed column format

* code cleanup

---------

Co-authored-by: Stefano Ricci <SteRiccio@users.noreply.github.com>

Author: SteRiccio

collect-core/src/main/java/org/openforis/collect/io/data/csv/CSVDataExportParametersBase.java

@@ -19,6 +19,7 @@ public enum OutputFormat {
 	private boolean includeCodeItemPositionColumn = false;
 	private boolean includeKMLColumnForCoordinates = false;
 	private boolean includeEnumeratedEntities = false;
+	private boolean includeMultipleEntities = false;
 	private boolean includeCompositeAttributeMergedColumn = false;
 	private boolean includeCodeItemLabelColumn = false;
 	private boolean includeGroupingLabels = true;
@@ -89,6 +90,14 @@ public void setIncludeEnumeratedEntities(boolean includeEnumeratedEntities) {
 		this.includeEnumeratedEntities = includeEnumeratedEntities;
 	}
 
+	public boolean isIncludeMultipleEntities() {
+		return includeMultipleEntities;
+	}
+	
+	public void setIncludeMultipleEntities(boolean includeMultipleEntities) {
+		this.includeMultipleEntities = includeMultipleEntities;
+	}
+	
 	public boolean isIncludeAllAncestorAttributes() {
 		return includeAllAncestorAttributes;
 	}

collect-core/src/main/java/org/openforis/collect/io/data/csv/MultipleEntityColumnProvider.java

@@ -0,0 +1,72 @@
+package org.openforis.collect.io.data.csv;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.openforis.collect.io.data.csv.columnProviders.AutomaticColumnProvider;
+import org.openforis.collect.io.data.csv.columnProviders.ColumnProvider;
+import org.openforis.collect.io.data.csv.columnProviders.ColumnProviderChain;
+import org.openforis.collect.io.data.csv.columnProviders.ColumnProviders;
+import org.openforis.idm.metamodel.AttributeDefinition;
+import org.openforis.idm.metamodel.EntityDefinition;
+import org.openforis.idm.model.Entity;
+import org.openforis.idm.model.Node;
+
+/**
+ * @author S. Ricci
+ */
+public class MultipleEntityColumnProvider extends ColumnProviderChain {
+	
+	private static final int DEFAULT_MAX_ITEMS = 10;
+	
+
+	public MultipleEntityColumnProvider(CSVDataExportParameters config, EntityDefinition defn) {
+		super(config, defn, createProviders(config, defn));
+	}
+
+	private static List<ColumnProvider> createProviders(CSVDataExportParameters config, EntityDefinition defn) {
+		List<ColumnProvider> providers = new ArrayList<ColumnProvider>();
+		List<AttributeDefinition> keyDefs = defn.getKeyAttributeDefinitions();
+		int maxEntities = defn.getFixedMaxCount() == null ? DEFAULT_MAX_ITEMS: defn.getFixedMaxCount();
+		for (int entityIndex = 0; entityIndex < maxEntities; entityIndex ++) {
+			for (AttributeDefinition keyDef : keyDefs) {
+				String keyName = keyDef.getName();
+				MultipleEntityKeyColumnProvider p = new MultipleEntityKeyColumnProvider(config, defn, entityIndex, keyName);
+				providers.add(p);
+			}
+		}
+		return providers;
+	}
+	
+	@Override
+	protected String generateHeadingPrefix() {
+		if (entityDefinition == null) {
+			throw new IllegalStateException("Entity definition not specified for multiple entity column provider");
+		}
+		return ColumnProviders.generateHeadingPrefix(entityDefinition, config);
+	}
+
+	private static class MultipleEntityKeyColumnProvider extends AutomaticColumnProvider {
+
+		private String keyName;
+		private int entityIndex;
+
+		public MultipleEntityKeyColumnProvider(CSVDataExportParameters config, EntityDefinition defn, int entityIndex, String keyName) {
+			super(config, "[" + (entityIndex + 1) + "]_", defn);
+			this.entityIndex = entityIndex;
+			this.keyName = keyName;
+		}
+		
+		@Override
+		public List<Object> extractValues(Node<?> axis) {
+			Entity parentEntity = (Entity) axis;
+			List<Node<?>> children = parentEntity.getChildren(entityDefinition);
+			Node<?> childEntity = entityIndex < children.size() ? children.get(entityIndex) : null;
+			if (childEntity == null) {
+				// not found; return empty array
+				return super.emptyValues();
+			}
+			return super.extractValues(childEntity);
+		}
+	}
+}

collect-core/src/main/java/org/openforis/collect/io/data/csv/columnProviders/AutomaticColumnProvider.java

@@ -6,6 +6,7 @@
 
 import org.openforis.collect.io.data.csv.CSVDataExportParameters;
 import org.openforis.collect.io.data.csv.EnumerableEntityColumnProvider;
+import org.openforis.collect.io.data.csv.MultipleEntityColumnProvider;
 import org.openforis.collect.metamodel.CollectAnnotations;
 import org.openforis.collect.model.CollectSurvey;
 import org.openforis.idm.metamodel.AttributeDefinition;
@@ -62,6 +63,9 @@ private static void createEntityProviders(CSVDataExportParameters config, Entity
 			if ( defn.isEnumerable() && config.isIncludeEnumeratedEntities() ) {
 				EnumerableEntityColumnProvider p = new EnumerableEntityColumnProvider(config, defn);
 				cols.add(p);
+			} else if (config.isIncludeMultipleEntities()) {
+				MultipleEntityColumnProvider p = new MultipleEntityColumnProvider(config, defn);
+				cols.add(p);
 			}
 		} else {
 			ColumnProvider p = new AutomaticColumnProvider(config, defn);