Skip to content

Commit 9f8b864

Browse files
pjfanningpjfanning
committed
rename classes as DeferredSXSSF instead of EmittingSXSSF
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1879484 13f79535-47bb-0310-9956-ffa450edef68
1 parent be09639 commit 9f8b864

File tree

4 files changed

+55
-54
lines changed

4 files changed

+55
-54
lines changed

src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFSheet.java renamed to src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFSheet.java

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,34 @@ Licensed to the Apache Software Foundation (ASF) under one or more
2525
import org.apache.poi.xssf.usermodel.XSSFSheet;
2626

2727
/**
28-
* A variant of SXSSFSheet that uses IRowGenerator to create rows.
28+
* A variant of SXSSFSheet that uses a <code>RowGeneratorFunction</code></code> to lazily create rows.
2929
*
3030
* This variant is experimental and APIs may change at short notice.
3131
*
32-
* @see EmittingSXSSFWorkbook
32+
* @see DeferredSXSSFWorkbook
33+
* @see RowGeneratorFunction
3334
* @since 5.0.0
3435
*/
3536
@Beta
36-
public class EmittingSXSSFSheet extends SXSSFSheet {
37-
private IRowGenerator rowGenerator;
37+
public class DeferredSXSSFSheet extends SXSSFSheet {
38+
private RowGeneratorFunction rowGenerator;
3839

39-
public EmittingSXSSFSheet(EmittingSXSSFWorkbook workbook, XSSFSheet xSheet) throws IOException {
40+
public DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook, XSSFSheet xSheet) throws IOException {
4041
super(workbook, xSheet, workbook.getRandomAccessWindowSize());
4142
}
4243

4344
@Override
4445
public InputStream getWorksheetXMLInputStream() throws IOException {
45-
throw new RuntimeException("Not supported by EmittingSXSSFSheet");
46+
throw new RuntimeException("Not supported by DeferredSXSSFSheet");
4647
}
4748

48-
public void setRowGenerator(IRowGenerator rowGenerator) {
49+
public void setRowGenerator(RowGeneratorFunction rowGenerator) {
4950
this.rowGenerator = rowGenerator;
5051
}
5152

5253
public void writeRows(OutputStream out) throws IOException {
5354
// delayed creation of SheetDataWriter
54-
_writer = ((EmittingSXSSFWorkbook) _workbook).createSheetDataWriter(out);
55+
_writer = ((DeferredSXSSFWorkbook) _workbook).createSheetDataWriter(out);
5556
try {
5657
if (this.rowGenerator != null) {
5758
this.rowGenerator.generateRows(this);

src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFWorkbook.java renamed to src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFWorkbook.java

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -39,27 +39,27 @@ Licensed to the Apache Software Foundation (ASF) under one or more
3939
* @since 5.0.0
4040
*/
4141
@Beta
42-
public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
43-
private static final POILogger logger = POILogFactory.getLogger(EmittingSXSSFWorkbook.class);
42+
public class DeferredSXSSFWorkbook extends SXSSFWorkbook {
43+
private static final POILogger logger = POILogFactory.getLogger(DeferredSXSSFWorkbook.class);
4444

45-
public EmittingSXSSFWorkbook() {
45+
public DeferredSXSSFWorkbook() {
4646
this(null);
4747
}
4848

49-
public EmittingSXSSFWorkbook(int rowAccessWindowSize) { this(null, rowAccessWindowSize); }
49+
public DeferredSXSSFWorkbook(int rowAccessWindowSize) { this(null, rowAccessWindowSize); }
5050

51-
public EmittingSXSSFWorkbook(XSSFWorkbook workbook) {
51+
public DeferredSXSSFWorkbook(XSSFWorkbook workbook) {
5252
this(workbook, SXSSFWorkbook.DEFAULT_WINDOW_SIZE);
5353
}
5454

55-
public EmittingSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize) {
55+
public DeferredSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize) {
5656
super(workbook, rowAccessWindowSize, false, false);
5757
}
5858

5959
@NotImplemented
6060
@Override
6161
protected SheetDataWriter createSheetDataWriter() throws IOException {
62-
throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
62+
throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
6363
}
6464

6565
protected StreamingSheetWriter createSheetDataWriter(OutputStream out) throws IOException {
@@ -68,30 +68,30 @@ protected StreamingSheetWriter createSheetDataWriter(OutputStream out) throws IO
6868

6969
@Override
7070
protected ISheetInjector createSheetInjector(SXSSFSheet sxSheet) throws IOException {
71-
EmittingSXSSFSheet ssxSheet = (EmittingSXSSFSheet) sxSheet;
71+
DeferredSXSSFSheet ssxSheet = (DeferredSXSSFSheet) sxSheet;
7272
return (output) -> {
7373
ssxSheet.writeRows(output);
7474
};
7575
}
7676

7777
@Override
7878
SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet) {
79-
final EmittingSXSSFSheet sxSheet;
79+
final DeferredSXSSFSheet sxSheet;
8080
try {
81-
sxSheet = new EmittingSXSSFSheet(this, xSheet);
81+
sxSheet = new DeferredSXSSFSheet(this, xSheet);
8282
} catch (IOException ioe) {
8383
throw new RuntimeException(ioe);
8484
}
8585
registerSheetMapping(sxSheet, xSheet);
8686
return sxSheet;
8787
}
8888

89-
public EmittingSXSSFSheet createSheet() {
90-
return (EmittingSXSSFSheet) super.createSheet();
89+
public DeferredSXSSFSheet createSheet() {
90+
return (DeferredSXSSFSheet) super.createSheet();
9191
}
9292

93-
public EmittingSXSSFSheet createSheet(String sheetname) {
94-
return (EmittingSXSSFSheet) super.createSheet(sheetname);
93+
public DeferredSXSSFSheet createSheet(String sheetname) {
94+
return (DeferredSXSSFSheet) super.createSheet(sheetname);
9595
}
9696

9797
/**
@@ -121,7 +121,7 @@ public boolean hasNext() {
121121
@SuppressWarnings("unchecked")
122122
public T next() throws NoSuchElementException {
123123
final XSSFSheet xssfSheet = it.next();
124-
EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) getSXSSFSheet(xssfSheet);
124+
DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) getSXSSFSheet(xssfSheet);
125125
return (T) (sxSheet == null ? xssfSheet : sxSheet);
126126
}
127127

@@ -146,7 +146,7 @@ public Iterator<Sheet> iterator() {
146146

147147
@Override
148148
public SXSSFSheet getSheetAt(int index) {
149-
throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
149+
throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
150150
}
151151

152152
public XSSFSheet getXSSFSheetAt(int index) {
@@ -159,19 +159,19 @@ public XSSFSheet getXSSFSheetAt(int index) {
159159
* @param index the index
160160
* @return the streaming sheet at
161161
*/
162-
public EmittingSXSSFSheet getStreamingSheetAt(int index) {
162+
public DeferredSXSSFSheet getStreamingSheetAt(int index) {
163163
XSSFSheet xSheet = _wb.getSheetAt(index);
164164
SXSSFSheet sxSheet = getSXSSFSheet(xSheet);
165165
if (sxSheet == null && xSheet != null) {
166-
return (EmittingSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
166+
return (DeferredSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
167167
} else {
168-
return (EmittingSXSSFSheet) sxSheet;
168+
return (DeferredSXSSFSheet) sxSheet;
169169
}
170170
}
171171

172172
@Override
173173
public SXSSFSheet getSheet(String name) {
174-
throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
174+
throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
175175
}
176176

177177
public XSSFSheet getXSSFSheet(String name) {
@@ -184,11 +184,11 @@ public XSSFSheet getXSSFSheet(String name) {
184184
* @param name the name
185185
* @return the streaming sheet
186186
*/
187-
public EmittingSXSSFSheet getStreamingSheet(String name) {
187+
public DeferredSXSSFSheet getStreamingSheet(String name) {
188188
XSSFSheet xSheet = _wb.getSheet(name);
189-
EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) getSXSSFSheet(xSheet);
189+
DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) getSXSSFSheet(xSheet);
190190
if (sxSheet == null && xSheet != null) {
191-
return (EmittingSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
191+
return (DeferredSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
192192
} else {
193193
return sxSheet;
194194
}

src/ooxml/java/org/apache/poi/xssf/streaming/IRowGenerator.java renamed to src/ooxml/java/org/apache/poi/xssf/streaming/RowGeneratorFunction.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Licensed to the Apache Software Foundation (ASF) under one or more
2020
import org.apache.poi.util.Beta;
2121

2222
/**
23-
* IRowGenerator for Emitting SXSSF sheets
23+
* RowGeneratorFunction for Deferred SXSSF sheets
2424
*
25-
* @see EmittingSXSSFWorkbook
25+
* @see DeferredSXSSFWorkbook
2626
*/
2727
@Beta
28-
public interface IRowGenerator {
28+
public interface RowGeneratorFunction {
2929

3030
/**
3131
* Generate and add rows to the sheet

src/ooxml/testcases/org/apache/poi/xssf/streaming/TestEmittingSXSSFWorkbook.java renamed to src/ooxml/testcases/org/apache/poi/xssf/streaming/TestDeferredSXSSFWorkbook.java

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737

3838
import static org.junit.Assert.*;
3939

40-
public final class TestEmittingSXSSFWorkbook extends BaseTestXWorkbook {
40+
public final class TestDeferredSXSSFWorkbook extends BaseTestXWorkbook {
4141

42-
public TestEmittingSXSSFWorkbook() {
42+
public TestDeferredSXSSFWorkbook() {
4343
super(SXSSFITestDataProvider.instance);
4444
}
4545

@@ -89,11 +89,11 @@ public void setSheetName() {
8989
public void existingWorkbook() throws IOException {
9090
XSSFWorkbook xssfWb1 = new XSSFWorkbook();
9191
xssfWb1.createSheet("S1");
92-
EmittingSXSSFWorkbook wb1 = new EmittingSXSSFWorkbook(xssfWb1);
92+
DeferredSXSSFWorkbook wb1 = new DeferredSXSSFWorkbook(xssfWb1);
9393
XSSFWorkbook xssfWb2 = SXSSFITestDataProvider.instance.writeOutAndReadBack(wb1);
9494
assertTrue(wb1.dispose());
9595

96-
EmittingSXSSFWorkbook wb2 = new EmittingSXSSFWorkbook(xssfWb2);
96+
DeferredSXSSFWorkbook wb2 = new DeferredSXSSFWorkbook(xssfWb2);
9797
assertEquals(1, wb2.getNumberOfSheets());
9898
Sheet sheet = wb2.getStreamingSheetAt(0);
9999
assertNotNull(sheet);
@@ -108,7 +108,7 @@ public void existingWorkbook() throws IOException {
108108

109109
@Test
110110
public void useSharedStringsTable() throws Exception {
111-
// not supported with EmittingSXSSF
111+
// not supported with DeferredSXSSF
112112
}
113113

114114
@Test
@@ -119,29 +119,29 @@ public void addToExistingWorkbook() throws IOException {
119119
Row row = sheet.createRow(1);
120120
Cell cell = row.createCell(1);
121121
cell.setCellValue("value 2_1_1");
122-
EmittingSXSSFWorkbook wb1 = new EmittingSXSSFWorkbook(xssfWb1);
122+
DeferredSXSSFWorkbook wb1 = new DeferredSXSSFWorkbook(xssfWb1);
123123
XSSFWorkbook xssfWb2 = SXSSFITestDataProvider.instance.writeOutAndReadBack(wb1);
124124
assertTrue(wb1.dispose());
125125
xssfWb1.close();
126126

127-
EmittingSXSSFWorkbook wb2 = new EmittingSXSSFWorkbook(xssfWb2);
127+
DeferredSXSSFWorkbook wb2 = new DeferredSXSSFWorkbook(xssfWb2);
128128
// Add a row to the existing empty sheet
129-
EmittingSXSSFSheet ssheet1 = wb2.getStreamingSheetAt(0);
129+
DeferredSXSSFSheet ssheet1 = wb2.getStreamingSheetAt(0);
130130
ssheet1.setRowGenerator((ssxSheet) -> {
131131
Row row1_1 = ssxSheet.createRow(1);
132132
Cell cell1_1_1 = row1_1.createCell(1);
133133
cell1_1_1.setCellValue("value 1_1_1");
134134
});
135135

136136
// Add a row to the existing non-empty sheet
137-
EmittingSXSSFSheet ssheet2 = wb2.getStreamingSheetAt(1);
137+
DeferredSXSSFSheet ssheet2 = wb2.getStreamingSheetAt(1);
138138
ssheet2.setRowGenerator((ssxSheet) -> {
139139
Row row2_2 = ssxSheet.createRow(2);
140140
Cell cell2_2_1 = row2_2.createCell(1);
141141
cell2_2_1.setCellValue("value 2_2_1");
142142
});
143143
// Add a sheet with one row
144-
EmittingSXSSFSheet ssheet3 = wb2.createSheet("S3");
144+
DeferredSXSSFSheet ssheet3 = wb2.createSheet("S3");
145145
ssheet3.setRowGenerator((ssxSheet) -> {
146146
Row row3_1 = ssxSheet.createRow(1);
147147
Cell cell3_1_1 = row3_1.createCell(1);
@@ -192,17 +192,17 @@ public void addToExistingWorkbook() throws IOException {
192192

193193
@Test
194194
public void sheetdataWriter() throws IOException {
195-
EmittingSXSSFWorkbook wb = new EmittingSXSSFWorkbook();
195+
DeferredSXSSFWorkbook wb = new DeferredSXSSFWorkbook();
196196
SXSSFSheet sh = wb.createSheet();
197-
assertSame(sh.getClass(), EmittingSXSSFSheet.class);
197+
assertSame(sh.getClass(), DeferredSXSSFSheet.class);
198198
SheetDataWriter wr = sh.getSheetDataWriter();
199199
assertNull(wr);
200200
wb.close();
201201
}
202202

203203
@Test
204204
public void gzipSheetdataWriter() throws IOException {
205-
EmittingSXSSFWorkbook wb = new EmittingSXSSFWorkbook();
205+
DeferredSXSSFWorkbook wb = new DeferredSXSSFWorkbook();
206206
wb.setCompressTempFiles(true);
207207

208208
final int rowNum = 1000;
@@ -232,25 +232,25 @@ public void gzipSheetdataWriter() throws IOException {
232232
wb.close();
233233
}
234234

235-
private static void assertWorkbookDispose(EmittingSXSSFWorkbook wb) {
235+
private static void assertWorkbookDispose(DeferredSXSSFWorkbook wb) {
236236
populateData(wb, 1000, 5);
237237

238238
for (Sheet sheet : wb) {
239-
EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) sheet;
239+
DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) sheet;
240240
assertNull(sxSheet.getSheetDataWriter());
241241
}
242242

243243
assertTrue(wb.dispose());
244244

245245
for (Sheet sheet : wb) {
246-
EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) sheet;
246+
DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) sheet;
247247
assertNull(sxSheet.getSheetDataWriter());
248248
}
249249
}
250250

251-
private static void populateData(EmittingSXSSFWorkbook wb, final int rowNum, final int sheetNum) {
251+
private static void populateData(DeferredSXSSFWorkbook wb, final int rowNum, final int sheetNum) {
252252
for (int i = 0; i < sheetNum; i++) {
253-
EmittingSXSSFSheet sheet = wb.createSheet("sheet" + i);
253+
DeferredSXSSFSheet sheet = wb.createSheet("sheet" + i);
254254
int index = i;
255255
sheet.setRowGenerator((sh) -> {
256256
for (int j = 0; j < rowNum; j++) {
@@ -270,12 +270,12 @@ private static void populateData(EmittingSXSSFWorkbook wb, final int rowNum, fin
270270

271271
@Test
272272
public void workbookDispose() throws IOException {
273-
EmittingSXSSFWorkbook wb1 = new EmittingSXSSFWorkbook();
273+
DeferredSXSSFWorkbook wb1 = new DeferredSXSSFWorkbook();
274274
// the underlying writer is SheetDataWriter
275275
assertWorkbookDispose(wb1);
276276
wb1.close();
277277

278-
EmittingSXSSFWorkbook wb2 = new EmittingSXSSFWorkbook();
278+
DeferredSXSSFWorkbook wb2 = new DeferredSXSSFWorkbook();
279279
wb2.setCompressTempFiles(true);
280280
// the underlying writer is GZIPSheetDataWriter
281281
assertWorkbookDispose(wb2);

0 commit comments

Comments
 (0)