You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2016/03/29 22:04:25 UTC
svn commit: r1737039 - in /poi/site/publish/apidocs: index-all.html
org/apache/poi/openxml4j/util/ZipSecureFile.html
org/apache/poi/xssf/streaming/SXSSFWorkbook.html
Author: nick
Date: Tue Mar 29 20:04:25 2016
New Revision: 1737039
URL: http://svn.apache.org/viewvc?rev=1737039&view=rev
Log:
Republish javadocs
Modified:
poi/site/publish/apidocs/index-all.html
poi/site/publish/apidocs/org/apache/poi/openxml4j/util/ZipSecureFile.html
poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html
Modified: poi/site/publish/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1737039&r1=1737038&r2=1737039&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Tue Mar 29 20:04:25 2016
@@ -34532,7 +34532,9 @@
<div class="block">Gets the value of the r property.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html#getRandomAccessWindowSize()">getRandomAccessWindowSize()</a></span> - Method in class org.apache.poi.xssf.streaming.<a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html" title="class in org.apache.poi.xssf.streaming">SXSSFWorkbook</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">See the constructors for a more detailed description of the sliding window of rows.</div>
+</dd>
<dt><span class="strong"><a href="./org/apache/poi/hssf/record/SharedValueRecordBase.html#getRange()">getRange()</a></span> - Method in class org.apache.poi.hssf.record.<a href="./org/apache/poi/hssf/record/SharedValueRecordBase.html" title="class in org.apache.poi.hssf.record">SharedValueRecordBase</a></dt>
<dd> </dd>
<dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFDocument.html#getRange()">getRange()</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFDocument.html" title="class in org.apache.poi.hwpf">HWPFDocument</a></dt>
@@ -80161,7 +80163,7 @@ Compound Document Format.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html#SXSSFWorkbook()">SXSSFWorkbook()</a></span> - Constructor for class org.apache.poi.xssf.streaming.<a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html" title="class in org.apache.poi.xssf.streaming">SXSSFWorkbook</a></dt>
<dd>
-<div class="block">Construct a new workbook</div>
+<div class="block">Construct a new workbook with default row window size</div>
</dd>
<dt><span class="strong"><a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html#SXSSFWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook)">SXSSFWorkbook(XSSFWorkbook)</a></span> - Constructor for class org.apache.poi.xssf.streaming.<a href="./org/apache/poi/xssf/streaming/SXSSFWorkbook.html" title="class in org.apache.poi.xssf.streaming">SXSSFWorkbook</a></dt>
<dd>
Modified: poi/site/publish/apidocs/org/apache/poi/openxml4j/util/ZipSecureFile.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/openxml4j/util/ZipSecureFile.html?rev=1737039&r1=1737038&r2=1737039&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/openxml4j/util/ZipSecureFile.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/openxml4j/util/ZipSecureFile.html Tue Mar 29 20:04:25 2016
@@ -861,10 +861,8 @@ extends java.util.zip.ZipFile</pre>
<li class="blockList">
<h4>ZipSecureFile</h4>
<pre>public ZipSecureFile(java.io.File file)
- throws java.util.zip.ZipException,
- java.io.IOException</pre>
+ throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
-<dd><code>java.util.zip.ZipException</code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html?rev=1737039&r1=1737038&r2=1737039&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html Tue Mar 29 20:04:25 2016
@@ -103,6 +103,19 @@ extends java.lang.Object
implements <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></pre>
<div class="block">Streaming version of XSSFWorkbook implementing the "BigGridDemo" strategy.
+ This allows to write very large files without running out of memory as only
+ a configurable portion of the rows are kept in memory at any one time.
+
+ You can provide a template workbook which is used as basis for the written
+ data.
+
+ See https://poi.apache.org/spreadsheet/how-to.html#sxssf for details.
+
+ Please note that there are still things that still may consume a large
+ amount of memory based on which features you are using, e.g. merged regions,
+ comments, ... are still only stored in memory and thus may require a lot of
+ memory if used extensively.
+
SXSSFWorkbook defaults to using inline strings instead of a shared strings
table. This is very efficient, since no document content needs to be kept in
memory, but is also known to produce documents that are incompatible with
@@ -159,7 +172,7 @@ implements <a href="../../../../../org/a
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/SXSSFWorkbook.html#SXSSFWorkbook()">SXSSFWorkbook</a></strong>()</code>
-<div class="block">Construct a new workbook</div>
+<div class="block">Construct a new workbook with default row window size</div>
</td>
</tr>
<tr class="rowColor">
@@ -395,7 +408,9 @@ implements <a href="../../../../../org/a
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/SXSSFWorkbook.html#getRandomAccessWindowSize()">getRandomAccessWindowSize</a></strong>()</code> </td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/streaming/SXSSFWorkbook.html#getRandomAccessWindowSize()">getRandomAccessWindowSize</a></strong>()</code>
+<div class="block">See the constructors for a more detailed description of the sliding window of rows.</div>
+</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/streaming/SXSSFSheet.html" title="class in org.apache.poi.xssf.streaming">SXSSFSheet</a></code></td>
@@ -650,7 +665,7 @@ implements <a href="../../../../../org/a
<li class="blockList">
<h4>SXSSFWorkbook</h4>
<pre>public SXSSFWorkbook()</pre>
-<div class="block">Construct a new workbook</div>
+<div class="block">Construct a new workbook with default row window size</div>
</li>
</ul>
<a name="SXSSFWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook)">
@@ -718,7 +733,7 @@ implements <a href="../../../../../org/a
A value of 0 is not allowed because it would flush any newly created row
without having a chance to specify any cells.
</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - </dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - the number of rows that are kept in memory until flushed out, see above.</dd></dl>
</li>
</ul>
<a name="SXSSFWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook, int, boolean)">
@@ -746,7 +761,7 @@ implements <a href="../../../../../org/a
A value of 0 is not allowed because it would flush any newly created row
without having a chance to specify any cells.
</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - </dd><dd><code>compressTmpFiles</code> - whether to use gzip compression for temporary files</dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - the number of rows that are kept in memory until flushed out, see above.</dd><dd><code>compressTmpFiles</code> - whether to use gzip compression for temporary files</dd></dl>
</li>
</ul>
<a name="SXSSFWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook, int, boolean, boolean)">
@@ -775,7 +790,7 @@ implements <a href="../../../../../org/a
A value of 0 is not allowed because it would flush any newly created row
without having a chance to specify any cells.
</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workbook</code> - the template workbook</dd><dd><code>rowAccessWindowSize</code> - </dd><dd><code>compressTmpFiles</code> - whether to use gzip compression for temporary files</dd><dd><code>useSharedStringsTable</code> - whether to use a shared strings table</dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workbook</code> - the template workbook</dd><dd><code>rowAccessWindowSize</code> - the number of rows that are kept in memory until flushed out, see above.</dd><dd><code>compressTmpFiles</code> - whether to use gzip compression for temporary files</dd><dd><code>useSharedStringsTable</code> - whether to use a shared strings table</dd></dl>
</li>
</ul>
<a name="SXSSFWorkbook(int)">
@@ -801,7 +816,7 @@ implements <a href="../../../../../org/a
A value of 0 is not allowed because it would flush any newly created row
without having a chance to specify any cells.
</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - </dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowAccessWindowSize</code> - the number of rows that are kept in memory until flushed out, see above.</dd></dl>
</li>
</ul>
</li>
@@ -819,6 +834,8 @@ implements <a href="../../../../../org/a
<li class="blockList">
<h4>getRandomAccessWindowSize</h4>
<pre>public int getRandomAccessWindowSize()</pre>
+<div class="block">See the constructors for a more detailed description of the sliding window of rows.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The number of rows that are kept in memory at once before flushing them out.</dd></dl>
</li>
</ul>
<a name="setCompressTempFiles(boolean)">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org