blob: 32fdb134a3a60d9c9fd32ea423377a7992314e71 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ss.util;
import java.util.Calendar;
import java.util.Date;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Cell;
/**
* Class {@code SheetBuilder} provides an easy way of building workbook sheets
* from 2D array of Objects. It can be used in test cases to improve code
* readability or in Swing applications with tables.
*
* @author Roman Kashitsyn
*/
public class SheetBuilder {
private final Workbook workbook;
private final Object[][] cells;
private boolean shouldCreateEmptyCells;
private String sheetName;
public SheetBuilder(Workbook workbook, Object[][] cells) {
this.workbook = workbook;
this.cells = cells.clone();
}
/**
* Returns {@code true} if null array elements should be treated as empty
* cells.
*
* @return {@code true} if null objects should be treated as empty cells
* and {@code false} otherwise
*/
public boolean getCreateEmptyCells() {
return shouldCreateEmptyCells;
}
/**
* Specifies if null array elements should be treated as empty cells.
*
* @param shouldCreateEmptyCells {@code true} if null array elements should be
* treated as empty cells
* @return {@code this}
*/
public SheetBuilder setCreateEmptyCells(boolean shouldCreateEmptyCells) {
this.shouldCreateEmptyCells = shouldCreateEmptyCells;
return this;
}
/**
* Specifies name of the sheet to build. If not specified, default name (provided by
* workbook) will be used instead.
* @param sheetName sheet name to use
* @return {@code this}
*/
public SheetBuilder setSheetName(String sheetName) {
this.sheetName = sheetName;
return this;
}
/**
* Builds sheet from parent workbook and 2D array with cell
* values. Creates rows anyway (even if row contains only null
* cells), creates cells if either corresponding array value is not
* null or createEmptyCells property is true.
* The conversion is performed in the following way:
* <p>
* <ul>
* <li>Numbers become numeric cells.</li>
* <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
* instances become date cells.</li>
* <li>String with leading '=' char become formulas (leading '='
* will be truncated).</li>
* <li>Other objects become strings via <code>Object.toString()</code>
* method call.</li>
* </ul>
*
* @return newly created sheet
*/
public Sheet build() {
Sheet sheet = (sheetName == null) ? workbook.createSheet() : workbook.createSheet(sheetName);
Row currentRow;
Cell currentCell;
for (int rowIndex = 0; rowIndex < cells.length; ++rowIndex) {
Object[] rowArray = cells[rowIndex];
currentRow = sheet.createRow(rowIndex);
for (int cellIndex = 0; cellIndex < rowArray.length; ++cellIndex) {
Object cellValue = rowArray[cellIndex];
if (cellValue != null || shouldCreateEmptyCells) {
currentCell = currentRow.createCell(cellIndex);
setCellValue(currentCell, cellValue);
}
}
}
return sheet;
}
/**
* Sets the cell value using object type information.
*
* @param cell cell to change
* @param value value to set
*/
private void setCellValue(Cell cell, Object value) {
if (value == null || cell == null) {
return;
}
if (value instanceof Number) {
double doubleValue = ((Number) value).doubleValue();
cell.setCellValue(doubleValue);
} else if (value instanceof Date) {
cell.setCellValue((Date) value);
} else if (value instanceof Calendar) {
cell.setCellValue((Calendar) value);
} else if (isFormulaDefinition(value)) {
cell.setCellFormula(getFormula(value));
} else {
cell.setCellValue(value.toString());
}
}
private boolean isFormulaDefinition(Object obj) {
if (obj instanceof String) {
String str = (String) obj;
return str.length() >= 2 && str.charAt(0) == '=';
} else {
return false;
}
}
private String getFormula(Object obj) {
return ((String) obj).substring(1);
}
}
|
