Close #44

Author: Open Lowcode SAS

src/org/openlowcode/server/data/ChoiceDataObjectFieldFlatFileLoaderColumn.java

@@ -143,34 +143,19 @@ protected boolean putContentInCell(E currentobject, Cell cell, String context) {
 					+ " would be of type ChoiceDataObjectField but in reality, it is " + field.getClass().toString());
 		ChoiceDataObjectField<F, E> choicefield = (ChoiceDataObjectField<F, E>) field;
 		cell.setCellValue((choicefield.getValue() == null ? "" : choicefield.getValue().getDisplayValue()));
-		// ChoiceDataObjectFieldFlatFileLoaderColumn.setRestrictionsOnCell(cell,fieldchoicedefinition);
 		return false;
 	}
 
-	/**
-	 * sets restriction on cell so that only display values in the list of value, or
-	 * empty string, can be entered. Warning: in current version, does not work in
-	 * excel (works with Libre Office though)
-	 * 
-	 * @param cell             cell
-	 * @param choicedefinition choice definition
-	 */
-	public static <E extends FieldChoiceDefinition<E>> void setRestrictionsOnCell(Cell cell, E choicedefinition) {
-		ArrayList<String> restrictions = new ArrayList<String>();
-		restrictions.add("");
-		ChoiceValue<E>[] choices = choicedefinition.getChoiceValue();
-		for (int i = 0; i < choices.length; i++)
-			restrictions.add(choices[i].getDisplayValue());
-		XSSFSheet sheet = (XSSFSheet) cell.getSheet();
-		DataValidationHelper validationHelper = new XSSFDataValidationHelper(sheet);
-		DataValidationConstraint constraint = validationHelper
-				.createExplicitListConstraint(restrictions.toArray(new String[0]));
-		CellRangeAddressList addressList = new CellRangeAddressList(cell.getRowIndex(), cell.getRowIndex(),
-				cell.getColumnIndex(), cell.getColumnIndex());
-		DataValidation dataValidation = validationHelper.createValidation(constraint, addressList);
-		dataValidation.setErrorStyle(DataValidation.ErrorStyle.STOP);
-		dataValidation.setSuppressDropDownArrow(true);
-		sheet.addValidationData(dataValidation);
-	}
+	 @Override
+	 public String[] getValueRestriction() {
+		 ArrayList<String> allowedvalues = new ArrayList<String>();
+		 allowedvalues.add("");
+		 ChoiceValue<?>[] choices = fieldchoicedefinition.getChoiceValue();
+			for (int i = 0; i < choices.length; i++)
+				allowedvalues.add(choices[i].getDisplayValue());
+			return allowedvalues.toArray(new String[0]);
+	 }
+	
+	
 
 }

src/org/openlowcode/server/data/loader/FlatFileExtractor.java

@@ -24,15 +24,25 @@
 import org.apache.poi.ss.usermodel.CellStyle;
 import org.apache.poi.ss.usermodel.CellType;
 import org.apache.poi.ss.usermodel.CreationHelper;
+import org.apache.poi.ss.usermodel.DataValidation;
+import org.apache.poi.ss.usermodel.DataValidationConstraint;
+import org.apache.poi.ss.usermodel.DataValidationHelper;
 import org.apache.poi.ss.usermodel.Font;
 import org.apache.poi.ss.usermodel.HorizontalAlignment;
 import org.apache.poi.ss.usermodel.IndexedColors;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.ss.util.CellAddress;
+import org.apache.poi.ss.util.CellRangeAddressList;
+import org.apache.poi.ss.util.CellReference;
+import org.apache.poi.xssf.usermodel.XSSFDataValidationHelper;
+import org.apache.poi.xssf.usermodel.XSSFSheet;
 import org.apache.poi.xssf.usermodel.XSSFWorkbook;
+import org.openlowcode.server.data.ChoiceValue;
 import org.openlowcode.server.data.DataObject;
 import org.openlowcode.server.data.DataObjectDefinition;
+import org.openlowcode.server.data.FieldChoiceDefinition;
 import org.openlowcode.server.data.NodeTree;
 import org.openlowcode.tools.file.StringParser;
 import org.openlowcode.tools.messages.SFile;
@@ -75,7 +85,9 @@ public SFile extractToExcel(E[] objectarray, String[] specificaliaslist) {
 		try {
 			Workbook workbook = new XSSFWorkbook();
 			Sheet sheet = workbook.createSheet("Export Data");
-			loadWorkbook(sheet, objectarray, specificaliaslist);
+			Sheet referencessheet = workbook.createSheet("Reference Values");
+			loadWorkbook(sheet,referencessheet, objectarray, specificaliaslist);
+			workbook.setActiveSheet(0); // setting active sheet to export data
 			ByteArrayOutputStream documentinmemory = new ByteArrayOutputStream();
 			workbook.write(documentinmemory);
 			workbook.close();
@@ -266,11 +278,12 @@ public SFile extractToExcel(E[] objectarray) {
 	 * loads into specified sheet the array of objects
 	 * 
 	 * @param sheet             active sheet
+	 * @param referencessheet   sheet to store reference values
 	 * @param objectarray       array of objects
 	 * @param specificaliaslist the alias to put as column headers (also gives the
 	 *                          order of fields)
 	 */
-	private void loadWorkbook(Sheet sheet, E[] objectarray, String[] specificaliaslist) {
+	private void loadWorkbook(Sheet sheet,Sheet referencessheet, E[] objectarray, String[] specificaliaslist) {
 		String[] aliaslisttoconsider = specificaliaslist;
 		// if zero element, put it to null
 		if (aliaslisttoconsider != null)
@@ -306,6 +319,8 @@ private void loadWorkbook(Sheet sheet, E[] objectarray, String[] specificaliasli
 			int[] columnmaxchar = new int[aliaslisttoconsider.length];
 			for (int i = 0; i < columnmaxchar.length; i++)
 				columnmaxchar[i] = 0;
+			ArrayList<String[]> restrictionsperalias = new ArrayList<String[]>();
+			int maxrestrictionvalues=0;
 			for (int i = 0; i < aliaslisttoconsider.length; i++) {
 				Cell cell = headerrow.createCell(i);
 				cell.setCellStyle(headerstyle);
@@ -316,6 +331,15 @@ private void loadWorkbook(Sheet sheet, E[] objectarray, String[] specificaliasli
 				String[] headlinesplit = StringParser.splitwithdoubleescape(loaderdef, '&');
 				FlatFileLoaderColumn<E> column = definition.getFlatFileLoaderColumn(transientproperties, headlinesplit,
 						null);
+				restrictionsperalias.add(null);
+				if (column!=null) {
+					String[] valuesrestriction = column.getValueRestriction();
+					if (valuesrestriction!=null) {
+					restrictionsperalias.set(i,valuesrestriction);
+					int valuesnr = valuesrestriction.length;
+					if (valuesnr>maxrestrictionvalues) maxrestrictionvalues=valuesnr;
+				}
+				}
 				columns.add(column);
 				if (column != null)
 					if (column.isComplexExtractor()) {
@@ -326,12 +350,26 @@ private void loadWorkbook(Sheet sheet, E[] objectarray, String[] specificaliasli
 						logger.info("Complex extractor defined as column " + column);
 					}
 			}
+			
+			
+			// write restrictions in referencesheet
+			for (int i=0;i<maxrestrictionvalues;i++) {
+				Row currentrow = referencessheet.createRow(i);
+				for (int j=0;j<restrictionsperalias.size();j++) {
+					String[] restrictionsvaluesperalias = restrictionsperalias.get(j);
+					if (restrictionsvaluesperalias!=null) if (i<restrictionsvaluesperalias.length) {
+						Cell cell = currentrow.createCell(j);
+						cell.setCellValue(restrictionsvaluesperalias[i]);
+					}
+			}
+			}
 			// by default, set height for two lines
 			headerrow.setHeightInPoints(headerrow.getHeightInPoints() * 2);
 			// parse objects
 			int rowindex = 1;
 			CellStyle normalstyle = createBorderedStyle(sheet.getWorkbook());
 			logger.info("parsing objects in array, nr = " + objectarray.length);
+			
 			for (int i = 0; i < objectarray.length; i++) {
 				E currentobject = objectarray[i];
 				String[] context = new String[] { null };
@@ -360,6 +398,15 @@ private void loadWorkbook(Sheet sheet, E[] objectarray, String[] specificaliasli
 				}
 
 			}
+			
+			// Put restrictions on cells if exists
+			for (int i=0;i<aliaslisttoconsider.length;i++) {
+				String[] restrictions = restrictionsperalias.get(i);
+				if (restrictions!=null) {
+					setRestrictionsOnCell(sheet,referencessheet,i,restrictions.length,rowindex-2);
+				}
+			}
+			
 			// at the end, size columns
 			for (int i = 0; i < columnmaxchar.length; i++) {
 				int width = (int) (columnmaxchar[i] * 1.14388 * 256);
@@ -443,5 +490,26 @@ public static CellStyle createDateStyle(Workbook wb, String simpledateformat) {
 		style.setDataFormat(createHelper.createDataFormat().getFormat(simpledateformat));
 		return style;
 	}
-
+	
+	/**
+	 * create restrictions on the data cells
+	 * 
+	 * @param mainsheet sheet with data
+	 * @param restrictionsheet sheet with restriction values
+	 * @param column index of column (starting with zero)
+	 * @param nbofchoices number of choices (starting with zero)
+	 * @param nbofrows number of rows (starting with zero)
+	 */
+	public static  void setRestrictionsOnCell(Sheet mainsheet,Sheet restrictionsheet,int column,int nbofchoices,int nbofrows) {
+		DataValidationHelper validationHelper = new XSSFDataValidationHelper((XSSFSheet)mainsheet);
+		String columnletter =  CellReference.convertNumToColString(column);
+		String formula = "'"+restrictionsheet.getSheetName()+ "'!$"+columnletter+"$"+1+":$"+columnletter+"$"+nbofchoices;
+		DataValidationConstraint constraint = validationHelper.createFormulaListConstraint(formula);
+		CellRangeAddressList addressList = new CellRangeAddressList(1,nbofrows+1,column,column);
+		
+		DataValidation dataValidation = validationHelper.createValidation(constraint, addressList);
+		dataValidation.setErrorStyle(DataValidation.ErrorStyle.STOP);
+		dataValidation.setSuppressDropDownArrow(true);
+		mainsheet.addValidationData(dataValidation);
+	}
 }

src/org/openlowcode/server/data/loader/FlatFileLoaderColumn.java

@@ -73,7 +73,8 @@ public boolean secondpass() {
 	 * @param linepreparatorextracriterias extra criterias for the line prepataion
 	 * @return
 	 */
-	public LinePreparation<E> LinePreparation(Object maincolumnvalue,
+	public LinePreparation<E> LinePreparation(
+			Object maincolumnvalue,
 			ArrayList<LinePreparationExtra<E>> linepreparatorextracriterias) {
 		throw new RuntimeException("no line  preparator with two attribute");
 	}
@@ -152,7 +153,9 @@ public LinePreparationExtra<E> generateLinePreparatorExtra(Object data) {
 	 */
 	public static interface LinePreparationExtra<E extends DataObject<E>> {
 		/**
-		 * generates a query condition to query relevant data to the object being processed
+		 * generates a query condition to query relevant data to the object being
+		 * processed
+		 * 
 		 * @param definition object definition
 		 * @param alias      alias of the query
 		 * @return
@@ -162,6 +165,7 @@ public static interface LinePreparationExtra<E extends DataObject<E>> {
 
 	/**
 	 * performs the load
+	 * 
 	 * @param object                    the object on which to load data
 	 * @param value                     an object, either Date, String or Double
 	 * @param postupdateprocessingstore a store to perform post processing after the
@@ -227,4 +231,16 @@ public String[] initComplexExtractorForObject(E currentobject) {
 		throw new RuntimeException("Not implemented for non-complex extractor");
 	}
 
+	/**
+	 * allows to define a restriction (list of potential values) for a cell when
+	 * exporting data in a spreadsheet. The column should return null if no
+	 * restriction applies to cell.<br>
+	 * Should be overridden only by loaders that need to restrict values
+	 * 
+	 * @return the list of potential values, or null if no restriction.
+	 */
+	public String[] getValueRestriction() {
+		return null;
+	}
+
 }