Finish registration template

user-interface/src/main/java/life/qbic/datamanager/templates/SampleBatchTemplate.java

@@ -61,49 +61,128 @@ public static XSSFWorkbook createRegistrationTemplate(List<String> conditions,
     workbook.setSheetName(1, "ListSheet");
     workbook.setActiveSheet(0);
 
+    // Analysis to perform
     setListDataTemplate(workbook.getSheetAt(1), 0, analysisToPerform);
-    var rangedName = createNameForListReference(workbook, 1, analysisToPerform.size(), "ListSheet", "analysis", "A");
-    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 0, "Analysis to be performed*", rangedName);
-    setSimpleColumn(workbook.getSheetAt(0), 1, "Sample Name*");
-    setSimpleColumn(workbook.getSheetAt(0), 2, "Biological Replicate");
+    var rangedName = createNameForListReference(workbook, 1, analysisToPerform.size(), "ListSheet",
+        "analysis", "A");
+    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 0, rangedName);
+    setColumnHeader(workbook.getSheetAt(0), 0, "Analysis to be performed*");
+
+    setColumnHeader(workbook.getSheetAt(0), 1, "Sample Name*");
+
+    setColumnHeader(workbook.getSheetAt(0), 2, "Biological Replicate");
+
+    setListDataTemplate(workbook.getSheetAt(1), 1, conditions);
+    var rangedNameCondition = createNameForListReference(workbook, 1, conditions.size(),
+        "ListSheet",
+        "conditions", "B");
+    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 3, rangedNameCondition);
+    setColumnHeader(workbook.getSheetAt(0), 3, "Condition*");
+
+    setListDataTemplate(workbook.getSheetAt(1), 2, species);
+    var rangedNameSpecies = createNameForListReference(workbook, 1, species.size(), "ListSheet",
+        "species", "C");
+    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 4, rangedNameSpecies);
+    setColumnHeader(workbook.getSheetAt(0), 4, "Species*");
+
+    setListDataTemplate(workbook.getSheetAt(1), 3, specimen);
+    var rangedNameSpecimen = createNameForListReference(workbook, 1, specimen.size(), "ListSheet",
+        "specimen", "D");
+    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 5, rangedNameSpecimen);
+    setColumnHeader(workbook.getSheetAt(0), 5, "Specimen*");
+
+    setListDataTemplate(workbook.getSheetAt(1), 4, analytes);
+    var rangedNameAnalyte = createNameForListReference(workbook, 1, analytes.size(), "ListSheet",
+        "analyte", "E");
+    setListDataValidation(workbook.getSheetAt(0), 1, 2000, 6, rangedNameAnalyte);
+    setColumnHeader(workbook.getSheetAt(0), 6, "Analyte*");
+
+    setColumnHeader(workbook.getSheetAt(0), 7, "Comment");
+
+    setColumnAutoWidth(workbook.getSheetAt(0), 0, 20);
+    setColumnAutoWidth(workbook.getSheetAt(1), 0, 20);
+
     return workbook;
   }
 
-  private static void setListDataTemplate(XSSFSheet sheet, int columnIndex,
-      List<String> values) {
-    int row = 0;
-    for (String value : values) {
-      sheet.createRow(row).createCell(columnIndex).setCellValue(value);
-      row++;
+  /**
+   * Sets a range of columns via {@link XSSFSheet#autoSizeColumn(int)} to set the width
+   * automatically to the maximum cell value length observed in a column.
+   *
+   * @param sheet            the sheet for which the columns shall be adjusted
+   * @param columnIndexStart the first column index to start the formatting
+   * @param columnIndexEnd   the last column (inclusive) to have to formatting included
+   * @since 1.5.0
+   */
+  private static void setColumnAutoWidth(XSSFSheet sheet, int columnIndexStart,
+      int columnIndexEnd) {
+    for (int currentColumn = columnIndexStart; currentColumn < columnIndexEnd;
+        currentColumn++) {
+      sheet.autoSizeColumn(currentColumn);
     }
   }
 
-  private static void setSimpleColumn(XSSFSheet sheet, int columnIndex, String columnHeader) {
+  private static void setColumnHeader(XSSFSheet sheet, int columnIndex, String header) {
+    // Prevents override of a potential existing first row
     XSSFRow row = sheet.getRow(0) == null ? sheet.createRow(0) : sheet.getRow(0);
-    row.createCell(columnIndex).setCellValue(columnHeader);
+    row.createCell(columnIndex).setCellValue(header);
   }
 
-  private static void setListDataValidation(XSSFSheet metadataSheet, int rowIndexFrom,
+  /**
+   * Configures the template sheet with a column containing values that shall be part of a cell
+   * validation via valid list values.
+   *
+   * @param sheet       the sheet that forms the template value sheet
+   * @param columnIndex the index of the column to write the values to
+   * @param values      the actual values for the list validation
+   * @since 1.5.0
+   */
+  private static void setListDataTemplate(XSSFSheet sheet, int columnIndex,
+      List<String> values) {
+    int rowIndex = 0;
+    for (String value : values) {
+      XSSFRow row =
+          sheet.getRow(rowIndex) == null ? sheet.createRow(rowIndex) : sheet.getRow(rowIndex);
+      row.createCell(columnIndex).setCellValue(value);
+      rowIndex++;
+    }
+  }
+
+  /**
+   * Sets a list range data validation for cells in a given sheet. The actual values have to be
+   * provided in the referenced sheet from the list formula, the use of
+   * {@link SampleBatchTemplate#setListDataTemplate(XSSFSheet, int, List)} is strongly recommended.
+   *
+   * @param sheet                 the sheet where the validation of cells shall happen
+   * @param rowIndexFrom          the index of the row where to start
+   * @param rowIndexTo            the index of the row where to stop validation (row with this index
+   *                              will be still included)
+   * @param columnIndexValidation the index of the column where to apply the validation (aka formula
+   *                              list constraint)
+   * @param listFormula           the actual list range formula, e.g. 'MySheet!$A$1:$A$30'
+   * @since 1.5.0
+   */
+  private static void setListDataValidation(XSSFSheet sheet,
+      int rowIndexFrom,
       int rowIndexTo,
-      int columnIndexValidation, String columnHeader,
+      int columnIndexValidation,
       String listFormula) {
-    XSSFRow row = metadataSheet.getRow(0) == null ? metadataSheet.createRow(0) : metadataSheet.getRow(0);
-    row.createCell(columnIndexValidation).setCellValue(columnHeader);
-    DataValidationHelper dataValidationHelper = metadataSheet.getDataValidationHelper();
+    DataValidationHelper dataValidationHelper = sheet.getDataValidationHelper();
     DataValidationConstraint dataValidationConstraint = dataValidationHelper.createFormulaListConstraint(
         listFormula);
     CellRangeAddressList cellRangeAddressList = new CellRangeAddressList(rowIndexFrom, rowIndexTo,
         columnIndexValidation, columnIndexValidation);
     DataValidation dataValidation = dataValidationHelper.createValidation(dataValidationConstraint,
         cellRangeAddressList);
-    metadataSheet.addValidationData(dataValidation);
+    sheet.addValidationData(dataValidation);
   }
 
   public static XSSFWorkbook createUpdateTemplate(List<Sample> samples) {
     return new XSSFWorkbook();
   }
 
-  private static String createNameForListReference(XSSFWorkbook workbook, int rangeStart, int rangeEnd,
+  private static String createNameForListReference(XSSFWorkbook workbook, int rangeStart,
+      int rangeEnd,
       String sheetName, String nameName, String columnChar) {
     var name = workbook.createName();
     name.setNameName(nameName);