change the option signature and name

Signed-off-by: Hakan Ozler <ozler.hakan@gmail.com>
ozlerhakan · May 30, 2021 · 45f9364 · 45f9364
1 parent b837d68
commit 45f9364
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 38 deletions.
diff --git a/README.adoc b/README.adoc
@@ -59,31 +59,33 @@ com.poiji.bind.Poiji#fromExcelProperties(java.io.InputStream, com.poiji.exceptio
 
 .`PoijiOptions.PoijiOptionsBuilder` Structure
 ----
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#settings()
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#build()
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#dateLenient(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#dateRegex(String)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#datePattern(String)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#dateTimeFormatter(java.time.format.DateTimeFormatter)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#ignoreHiddenSheets(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#password(String)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#preferNullOverDefault(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#settings(int)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#sheetIndex(int)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#skip(int)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#limit(int)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#trimCellValue(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#headerStart(int)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#withCasting(Casting)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#withFormatting(Formatting)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#caseInsensitive(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#ignoreWhitespaces(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#namedHeaderMandatory(boolean)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#poijiNumberFormat(PoijiNumberFormat)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#poijiLogCellFormat(PoijiLogCellFormat)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#disableXLSXNumberCellFormat()
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#addListDelimiter(String)
-com.poiji.option.PoijiOptions.PoijiOptionsBuilder#setLocale(java.util.Locale)
+com.poiji.option.PoijiOptions.PoijiOptionsBuilder
+#settings()
+#build()
+#dateLenient(boolean)
+#dateRegex(String)
+#datePattern(String)
+#dateTimeFormatter(java.time.format.DateTimeFormatter)
+#ignoreHiddenSheets(boolean)
+#password(String)
+#preferNullOverDefault(boolean)
+#settings(int)
+#sheetIndex(int)
+#skip(int)
+#limit(int)
+#trimCellValue(boolean)
+#headerStart(int)
+#withCasting(Casting)
+#withFormatting(Formatting)
+#caseInsensitive(boolean)
+#ignoreWhitespaces(boolean)
+#namedHeaderMandatory(boolean)
+#poijiNumberFormat(PoijiNumberFormat)
+#poijiLogCellFormat(PoijiLogCellFormat)
+#disableXLSXNumberCellFormat()
+#addListDelimiter(String)
+#setLocale(java.util.Locale)
+#rawData(boolean)
 ----
 
 === Feature 1

diff --git a/src/main/java/com/poiji/bind/mapping/HSSFUnmarshaller.java b/src/main/java/com/poiji/bind/mapping/HSSFUnmarshaller.java
@@ -241,7 +241,7 @@ private <T> void constructTypeValue(Row currentRow, T instance, Field field, Fie
                 cell.setCellStyle(null);
             }
             String value;
-            if (options.isReturnRawValues() && cell.getCellType() == CellType.NUMERIC) {
+            if (options.isRawData() && cell.getCellType() == CellType.NUMERIC) {
                 value = NumberToTextConverter.toText(cell.getNumericCellValue());
             } else {
                 value = dataFormatter.formatCellValue(cell, baseFormulaEvaluator);

diff --git a/src/main/java/com/poiji/bind/mapping/PoijiDataFormatter.java b/src/main/java/com/poiji/bind/mapping/PoijiDataFormatter.java
@@ -19,7 +19,7 @@ public PoijiDataFormatter(PoijiOptions options) {
 
     @Override
     public String formatRawCellContents(double value, int formatIndex, String formatString, boolean use1904Windowing) {
-        if (!DateUtil.isADateFormat(formatIndex, formatString) && options.isReturnRawValues()) {
+        if (!DateUtil.isADateFormat(formatIndex, formatString) && options.isRawData()) {
             return NumberToTextConverter.toText(value);
         } else {
             return super.formatRawCellContents(value, formatIndex, formatString, use1904Windowing);

diff --git a/src/main/java/com/poiji/option/PoijiOptions.java b/src/main/java/com/poiji/option/PoijiOptions.java
@@ -49,7 +49,7 @@ public final class PoijiOptions {
     private String listDelimiter;
     private Formatting formatting;
     private Locale locale;
-    private boolean returnRawValues;
+    private boolean rawData;
 
     public PoijiNumberFormat getPoijiNumberFormat() {
         return numberFormat;
@@ -295,12 +295,12 @@ private PoijiOptions setLocale(Locale locale) {
         return this;
     }
 
-    public boolean isReturnRawValues() {
-        return returnRawValues;
+    public boolean isRawData() {
+        return rawData;
     }
 
-    private PoijiOptions setReturnRawValues(boolean returnRawValues) {
-        this.returnRawValues = returnRawValues;
+    private PoijiOptions setRawData(boolean rawData) {
+        this.rawData = rawData;
         return this;
     }
 
@@ -332,7 +332,7 @@ public static class PoijiOptionsBuilder {
         private boolean disabledXLSXNumberCellFormat;
         private String listDelimiter = ",";
         private Locale locale = Locale.US;
-        private boolean returnRawValues;
+        private boolean rawData;
 
         private PoijiOptionsBuilder() {
         }
@@ -446,7 +446,7 @@ public PoijiOptions build() {
                     .setListDelimiter(listDelimiter)
                     .setFormatting(formatting)
                     .setLocale(locale)
-                    .setReturnRawValues(returnRawValues);
+                    .setRawData(rawData);
 
         }
 
@@ -710,12 +710,13 @@ public PoijiOptionsBuilder withFormatting(Formatting formatting) {
         }
 
         /**
-         * Use this option to get the underlying/original/non-visible cell value. The cell must be a numeric type.
+         * Use this option to get the underlying/original/non-visible/raw cell value. The cell must be a numeric type.
          *
+         * @param status set true to retrieve the underlying data in the excel file.
          * @return this
          */
-        public PoijiOptionsBuilder returnNumericRawValues() {
-            this.returnRawValues = true;
+        public PoijiOptionsBuilder rawData(boolean status) {
+            this.rawData = status;
             return this;
         }
     }

diff --git a/src/test/java/com/poiji/deserialize/RawValueTest.java b/src/test/java/com/poiji/deserialize/RawValueTest.java
@@ -37,7 +37,7 @@ public static Iterable<Object[]> queries() {
     @Test
     public void shouldMapCalculations() {
 
-        PoijiOptions options = PoijiOptions.PoijiOptionsBuilder.settings().headerCount(0).returnNumericRawValues().build();
+        PoijiOptions options = PoijiOptions.PoijiOptionsBuilder.settings().headerCount(0).rawData(true).build();
         List<RowModel> models = Poiji.fromExcel(new File(path), RowModel.class, options);
 
         for (RowModel model : models) {