feat: export multiple feature type to Excel

io/plugins/eu.esdihumboldt.hale.io.csv.ui/src/eu/esdihumboldt/hale/io/csv/ui/CommonInstanceExportConfigurationPage.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2014 Data Harmonisation Panel
+ * 
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * Contributors:
+ *     Data Harmonisation Panel <http://www.dhpanel.eu>
+ */
+
+package eu.esdihumboldt.hale.io.csv.ui;
+
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.widgets.Button;
+import org.eclipse.swt.widgets.Composite;
+
+import eu.esdihumboldt.hale.common.core.io.Value;
+import eu.esdihumboldt.hale.common.instance.io.InstanceWriter;
+import eu.esdihumboldt.hale.io.csv.InstanceTableIOConstants;
+import eu.esdihumboldt.hale.ui.io.IOWizard;
+import eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage;
+
+/**
+ * Configuration page for exporting of instances
+ * 
+ * @author Emanuela Epure
+ */
+public class CommonInstanceExportConfigurationPage
+		extends AbstractConfigurationPage<InstanceWriter, IOWizard<InstanceWriter>> {
+
+	protected Button solveNestedProperties;
+	protected Button useSchema;
+	protected Composite page;
+
+	/**
+	 * @param title
+	 * 
+	 */
+	public CommonInstanceExportConfigurationPage(String title) {
+		super(title);
+		setTitle("Additonal Export Options");
+		setDescription("Select if nested properties should be solved and a type");
+	}
+
+	/**
+	 * @see eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage#enable()
+	 */
+	@Override
+	public void enable() {
+		// not required
+	}
+
+	/**
+	 * @see eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage#disable()
+	 */
+	@Override
+	public void disable() {
+		// not required
+	}
+
+	/**
+	 * @see eu.esdihumboldt.hale.ui.io.IOWizardPage#updateConfiguration(eu.esdihumboldt.hale.common.core.io.IOProvider)
+	 */
+	@Override
+	public boolean updateConfiguration(InstanceWriter provider) {
+		provider.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES,
+				Value.of(solveNestedProperties.getSelection()));
+		provider.setParameter(InstanceTableIOConstants.USE_SCHEMA,
+				Value.of(useSchema.getSelection()));
+		return true;
+	}
+
+	/**
+	 * @see eu.esdihumboldt.hale.ui.HaleWizardPage#createContent(org.eclipse.swt.widgets.Composite)
+	 */
+	@Override
+	protected void createContent(Composite page) {
+		this.page = page;
+
+		page.setLayout(new GridLayout(1, false));
+
+		solveNestedProperties = new Button(page, SWT.CHECK);
+		solveNestedProperties.setText("Solve nested properties");
+		solveNestedProperties.setSelection(true);
+
+		useSchema = new Button(page, SWT.CHECK);
+		useSchema.setText("Use the source schema for the order of the exported columns");
+		useSchema.setSelection(true);
+	}
+
+}

io/plugins/eu.esdihumboldt.hale.io.csv.ui/src/eu/esdihumboldt/hale/io/csv/ui/InstanceExportConfigurationPage.java

@@ -21,8 +21,6 @@
 import org.eclipse.jface.viewers.Viewer;
 import org.eclipse.jface.viewers.ViewerFilter;
 import org.eclipse.swt.SWT;
-import org.eclipse.swt.layout.GridLayout;
-import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.ui.PlatformUI;
@@ -34,22 +32,16 @@
 import eu.esdihumboldt.hale.common.schema.model.TypeDefinition;
 import eu.esdihumboldt.hale.io.csv.InstanceTableIOConstants;
 import eu.esdihumboldt.hale.ui.common.definition.selector.TypeDefinitionSelector;
-import eu.esdihumboldt.hale.ui.io.IOWizard;
-import eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage;
 import eu.esdihumboldt.hale.ui.service.instance.InstanceService;
 
 /**
  * Configuration page for exporting of instances
  * 
  * @author Patrick Lieb
  */
-public class InstanceExportConfigurationPage
-		extends AbstractConfigurationPage<InstanceWriter, IOWizard<InstanceWriter>> {
+public class InstanceExportConfigurationPage extends CommonInstanceExportConfigurationPage {
 
-	private Button solveNestedProperties;
-	private Button useSchema;
 	private TypeDefinitionSelector typeSelector;
-	private Composite page;
 
 	private final ViewerFilter validTypesToSelect = new ViewerFilter() {
 
@@ -102,10 +94,7 @@ public void disable() {
 	 */
 	@Override
 	public boolean updateConfiguration(InstanceWriter provider) {
-		provider.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES,
-				Value.of(solveNestedProperties.getSelection()));
-		provider.setParameter(InstanceTableIOConstants.USE_SCHEMA,
-				Value.of(useSchema.getSelection()));
+		super.updateConfiguration(provider);
 		provider.setParameter(InstanceTableIOConstants.EXPORT_TYPE,
 				Value.of(typeSelector.getSelectedObject().getName().toString()));
 		return true;
@@ -116,17 +105,7 @@ public boolean updateConfiguration(InstanceWriter provider) {
 	 */
 	@Override
 	protected void createContent(Composite page) {
-		this.page = page;
-
-		page.setLayout(new GridLayout(1, false));
-
-		solveNestedProperties = new Button(page, SWT.CHECK);
-		solveNestedProperties.setText("Solve nested properties");
-		solveNestedProperties.setSelection(true);
-
-		useSchema = new Button(page, SWT.CHECK);
-		useSchema.setText("Use the source schema for the order of the exported columns");
-		useSchema.setSelection(true);
+		super.createContent(page);
 
 		final Label label = new Label(page, SWT.NONE);
 		label.setText("Choose your Type you want to export:");

io/plugins/eu.esdihumboldt.hale.io.csv/src/eu/esdihumboldt/hale/io/csv/InstanceTableIOConstants.java

@@ -45,4 +45,9 @@ public class InstanceTableIOConstants {
 	 */
 	public static final String EXPORT_TYPE = "selectedExportType";
 
+	/**
+	 * Parameter for exporting empty feature types to XLS Export
+	 */
+	public static final String EXPORT_IGNORE_EMPTY_FEATURETYPES = "ignoreEmptyFeaturetypes";
+
 }

io/plugins/eu.esdihumboldt.hale.io.xls.test/src/eu/esdihumboldt/hale/io/xls/test/XLSInstanceIOTest.java

@@ -18,11 +18,13 @@
 import eu.esdihumboldt.hale.common.instance.model.InstanceCollection;
 import eu.esdihumboldt.hale.common.instance.model.InstanceUtil;
 import eu.esdihumboldt.hale.common.schema.model.Schema;
+import eu.esdihumboldt.hale.common.schema.model.impl.DefaultSchemaSpace;
 import eu.esdihumboldt.hale.common.test.TestUtil;
 import eu.esdihumboldt.hale.io.csv.InstanceTableIOConstants;
 import eu.esdihumboldt.hale.io.csv.reader.CommonSchemaConstants;
 import eu.esdihumboldt.hale.io.xls.reader.XLSInstanceReader;
 import eu.esdihumboldt.hale.io.xls.reader.XLSSchemaReader;
+import eu.esdihumboldt.hale.io.xls.test.writer.XLSInstanceWriterTestUtil;
 import eu.esdihumboldt.hale.io.xls.writer.XLSInstanceWriter;
 import junit.framework.TestCase;
 
@@ -57,10 +59,20 @@ public void test() {
 		IContentType contentType = HalePlatform.getContentTypeManager()
 				.getContentType("eu.esdihumboldt.hale.io.xls.xls");
 		writer.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES, Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.USE_SCHEMA, Value.of(true));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_IGNORE_EMPTY_FEATURETYPES,
+				Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_TYPE, Value.of("ItemType"));
+
 		File tempDir = Files.createTempDir();
 		File tempFile = new File(tempDir, "data.xls");
 		writer.setInstances(instances);
 		try {
+			Schema schema = XLSInstanceWriterTestUtil.createExampleSchema();
+			DefaultSchemaSpace ss = new DefaultSchemaSpace();
+			ss.addSchema(schema);
+			writer.setTargetSchema(ss);
+
 			// write instances to a temporary XLS file
 			writer.setTarget(new FileIOSupplier(tempFile));
 			writer.setContentType(contentType);

io/plugins/eu.esdihumboldt.hale.io.xls.test/src/eu/esdihumboldt/hale/io/xls/test/writer/XLSInstanceWriterTest.java

@@ -19,6 +19,7 @@
 import static org.junit.Assert.assertTrue;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
@@ -41,7 +42,9 @@
 import eu.esdihumboldt.hale.common.core.io.report.IOReport;
 import eu.esdihumboldt.hale.common.core.io.supplier.FileIOSupplier;
 import eu.esdihumboldt.hale.common.instance.model.InstanceCollection;
+import eu.esdihumboldt.hale.common.instance.model.impl.MultiInstanceCollection;
 import eu.esdihumboldt.hale.common.schema.model.Schema;
+import eu.esdihumboldt.hale.common.schema.model.impl.DefaultSchemaSpace;
 import eu.esdihumboldt.hale.common.test.TestUtil;
 import eu.esdihumboldt.hale.io.csv.InstanceTableIOConstants;
 import eu.esdihumboldt.hale.io.xls.writer.XLSInstanceWriter;
@@ -93,10 +96,16 @@ public void testWriteSimpleSchemaColOrder() throws Exception {
 				.getContentType("eu.esdihumboldt.hale.io.xls.xls");
 		writer.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES, Value.of(true));
 		writer.setParameter(InstanceTableIOConstants.USE_SCHEMA, Value.of(true));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_IGNORE_EMPTY_FEATURETYPES,
+				Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_TYPE, Value.of("city"));
 
 		File tmpFile = tmpFolder.newFile("excelTestWriteSimpleSchema.xls");
 
 		writer.setInstances(instance);
+		DefaultSchemaSpace ss = new DefaultSchemaSpace();
+		ss.addSchema(schema);
+		writer.setTargetSchema(ss);
 		// write instances to a temporary XLS file
 		writer.setTarget(new FileIOSupplier(tmpFile));
 		writer.setContentType(contentType);
@@ -114,6 +123,7 @@ public void testWriteSimpleSchemaColOrder() throws Exception {
 		checkSheetName(sheet, "city");
 		checkFirstDataRow(sheet, firstDataRow);
 		checkHeaderOrder(sheet, header);
+		tmpFolder.delete();
 	}
 
 	/**
@@ -123,7 +133,6 @@ public void testWriteSimpleSchemaColOrder() throws Exception {
 	 */
 	@Test
 	public void testWriteComplexSchema() throws Exception {
-
 		TransformationExample example = TransformationExamples
 				.getExample(TransformationExamples.SIMPLE_COMPLEX);
 		// alternative the data could be generated by iterating through the
@@ -139,10 +148,17 @@ public void testWriteComplexSchema() throws Exception {
 				.getContentType("eu.esdihumboldt.hale.io.xls.xls");
 		writer.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES, Value.of(true));
 		writer.setParameter(InstanceTableIOConstants.USE_SCHEMA, Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_IGNORE_EMPTY_FEATURETYPES,
+				Value.of(true));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_TYPE, Value.of("person"));
 
 		File tmpFile = tmpFolder.newFile("excelTestWriteComplexSchema.xls");
 
 		writer.setInstances(example.getSourceInstances());
+		Schema schema = XLSInstanceWriterTestUtil.createExampleSchema();
+		DefaultSchemaSpace ss = new DefaultSchemaSpace();
+		ss.addSchema(schema);
+		writer.setTargetSchema(ss);
 		// write instances to a temporary XLS file
 		writer.setTarget(new FileIOSupplier(tmpFile));
 		writer.setContentType(contentType);
@@ -157,10 +173,9 @@ public void testWriteComplexSchema() throws Exception {
 		Sheet sheet = wb.getSheetAt(0);
 
 		checkHeader(sheet, header);
-
 		checkSheetName(sheet, "person");
-
 		checkFirstDataRow(sheet, firstDataRow);
+		tmpFolder.delete();
 	}
 
 	/**
@@ -172,7 +187,6 @@ public void testWriteComplexSchema() throws Exception {
 	 */
 	@Test
 	public void testWriteNotNestedProperties() throws Exception {
-
 		TransformationExample example = TransformationExamples
 				.getExample(TransformationExamples.SIMPLE_COMPLEX);
 		// alternative the data could be generated by iterating through the
@@ -186,10 +200,17 @@ public void testWriteNotNestedProperties() throws Exception {
 				.getContentType("eu.esdihumboldt.hale.io.xls.xls");
 		writer.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES, Value.of(false));
 		writer.setParameter(InstanceTableIOConstants.USE_SCHEMA, Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_IGNORE_EMPTY_FEATURETYPES,
+				Value.of(true));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_TYPE, Value.of("person"));
 
 		File tmpFile = tmpFolder.newFile("excelNotNestedProperties.xls");
 
 		writer.setInstances(example.getSourceInstances());
+		Schema schema = XLSInstanceWriterTestUtil.createExampleSchema();
+		DefaultSchemaSpace ss = new DefaultSchemaSpace();
+		ss.addSchema(schema);
+		writer.setTargetSchema(ss);
 		// write instances to a temporary XLS file
 		writer.setTarget(new FileIOSupplier(tmpFile));
 		writer.setContentType(contentType);
@@ -205,8 +226,61 @@ public void testWriteNotNestedProperties() throws Exception {
 
 		checkHeader(sheet, header);
 		checkSheetName(sheet, "person");
-
 		checkFirstDataRow(sheet, firstDataRow);
+		tmpFolder.delete();
+	}
+
+	/**
+	 * Test - write data for 2 example and create a common excel with multiple
+	 * sheets
+	 * 
+	 * @throws Exception , if an error occurs
+	 */
+	@Test
+	public void testExportMultiFeatureToExcel() throws Exception {
+		ArrayList<InstanceCollection> examples = new ArrayList<>();
+		TransformationExample example = TransformationExamples
+				.getExample(TransformationExamples.SIMPLE_COMPLEX);
+		TransformationExample example2 = TransformationExamples
+				.getExample(TransformationExamples.CARDINALITY_MERGE_1);
+		examples.add(example.getTargetInstances());
+		examples.add(example2.getTargetInstances());
+
+		// set instances to xls instance writer
+		XLSInstanceWriter writer = new XLSInstanceWriter();
+		IContentType contentType = HalePlatform.getContentTypeManager()
+				.getContentType("eu.esdihumboldt.hale.io.xls.xls");
+		writer.setParameter(InstanceTableIOConstants.SOLVE_NESTED_PROPERTIES, Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.USE_SCHEMA, Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_IGNORE_EMPTY_FEATURETYPES,
+				Value.of(false));
+		writer.setParameter(InstanceTableIOConstants.EXPORT_TYPE, Value.of("person" + "," + "t1"));
+
+		File tmpFile = tmpFolder.newFile("excelWith2Sheets.xls");
+		// write instances to a temporary XLS file
+		writer.setTarget(new FileIOSupplier(tmpFile));
+		writer.setContentType(contentType);
+
+		Schema schema = XLSInstanceWriterTestUtil.createExampleSchema();
+		DefaultSchemaSpace ss = new DefaultSchemaSpace();
+		ss.addSchema(schema);
+		writer.setTargetSchema(ss);
+
+		InstanceCollection multiInstanceCollection = new MultiInstanceCollection(examples);
+		writer.setInstances(multiInstanceCollection);
+
+		IOReport report = writer.execute(null);
+		assertTrue(report.isSuccess());
+
+		Workbook wb;
+//		https: // poi.apache.org/components/spreadsheet/quick-guide.html#FileInputStream
+		try (POIFSFileSystem fs = new POIFSFileSystem(tmpFile)) {
+			wb = new HSSFWorkbook(fs.getRoot(), true);
+		}
+		int sheetNumber = wb.getNumberOfSheets();
+		Sheet sheet = wb.getSheetAt(0);
+		assertEquals(1, sheetNumber);
+		tmpFolder.delete();
 	}
 
 	/**

io/plugins/eu.esdihumboldt.hale.io.xls.ui/META-INF/MANIFEST.MF

@@ -5,15 +5,19 @@ Bundle-SymbolicName: eu.esdihumboldt.hale.io.xls.ui;singleton:=true
 Bundle-Version: 5.1.0.qualifier
 Require-Bundle: org.eclipse.ui,
  org.eclipse.core.runtime,
- eu.esdihumboldt.hale.ui
+ eu.esdihumboldt.hale.ui,
+ eu.esdihumboldt.hale.common.instance
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Import-Package: de.fhg.igd.eclipse.util.extension,
  de.fhg.igd.slf4jplus,
  eu.esdihumboldt.hale.common.core.io,
  eu.esdihumboldt.hale.common.core.io.project.model,
  eu.esdihumboldt.hale.common.core.io.supplier,
  eu.esdihumboldt.hale.common.instance.io,
+ eu.esdihumboldt.hale.common.schema,
  eu.esdihumboldt.hale.common.schema.io,
+ eu.esdihumboldt.hale.common.schema.model,
+ eu.esdihumboldt.hale.common.schema.model.constraint.type,
  eu.esdihumboldt.hale.io.csv,
  eu.esdihumboldt.hale.io.csv.ui,
  eu.esdihumboldt.hale.io.xls,