You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2021/04/10 11:47:17 UTC
svn commit: r1888581 [2/2] - in /poi/site/publish: ./ apidocs/ components/
components/diagram/ components/document/ components/hmef/ components/hpbf/
components/hsmf/ components/poifs/ components/slideshow/
components/spreadsheet/ help/
Modified: poi/site/publish/components/spreadsheet/excelant.html
URL: http://svn.apache.org/viewvc/poi/site/publish/components/spreadsheet/excelant.html?rev=1888581&r1=1888580&r2=1888581&view=diff
==============================================================================
--- poi/site/publish/components/spreadsheet/excelant.html (original)
+++ poi/site/publish/components/spreadsheet/excelant.html Sat Apr 10 11:47:17 2021
@@ -326,25 +326,25 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">property name="lib.dir" value="lib" /></span>
+<span class="lineno"></span><span class="codebody"><property name="lib.dir" value="lib" /></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">path id="excelant.path"></span>
+<span class="lineno"></span><span class="codebody"><path id="excelant.path"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-excelant-3.8-beta1-20101230.jar" /></span>
+<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-excelant-3.8-beta1-20101230.jar" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-3.8-beta1-20101230.jar" /></span>
+<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-3.8-beta1-20101230.jar" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-ooxml-3.8-beta1-20101230.jar" /></span>
+<span class="lineno"></span><span class="codebody"> <pathelement location="${lib.dir}/poi-ooxml-3.8-beta1-20101230.jar" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/path></span>
+<span class="lineno"></span><span class="codebody"></path></span>
</div>
</div>
<p>Next, you'll need to define the Ant tasks. There are several ways to use ExcelAnt:</p>
@@ -356,7 +356,7 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">typedef resource="org/apache/poi/ss/excelant/antlib.xml" classpathref="excelant.path" /></span>
+<span class="lineno"></span><span class="codebody"><typedef resource="org/apache/poi/ss/excelant/antlib.xml" classpathref="excelant.path" /></span>
</div>
</div>
<p>
@@ -371,40 +371,40 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">project name="excelant-demo" xmlns:poi="antlib:org.apache.poi.ss.excelant"></span>
+<span class="lineno"></span><span class="codebody"><project name="excelant-demo" xmlns:poi="antlib:org.apache.poi.ss.excelant"></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <typedef resource="org/apache/poi/ss/excelant/antlib.xml"</span>
+<span class="lineno"></span><span class="codebody"> <typedef resource="org/apache/poi/ss/excelant/antlib.xml"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> classpathref="excelant.classpath"</span>
+<span class="lineno"></span><span class="codebody"> classpathref="excelant.classpath"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> uri="antlib:org.apache.poi.ss.excelant"/></span>
+<span class="lineno"></span><span class="codebody"> uri="antlib:org.apache.poi.ss.excelant"/></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <target name="test-nofile"></span>
+<span class="lineno"></span><span class="codebody"> <target name="test-nofile"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <poi:excelant></span>
+<span class="lineno"></span><span class="codebody"> <poi:excelant></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </poi:excelant></span>
+<span class="lineno"></span><span class="codebody"> </poi:excelant></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </target></span>
+<span class="lineno"></span><span class="codebody"> </target></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/project></span>
+<span class="lineno"></span><span class="codebody"></project></span>
</div>
</div>
<a name="A+Simple+Example"></a>
@@ -414,9 +414,10 @@ workbooks then you need to have the foll
where POI is unable to evaluate cells for a variety of reasons. If you need to write code
to integrate a worksheet into an app, you may want to know that it's going to work before
you actually try to write that code. ExcelAnt helps with that.</p>
-<p>Consider the mortgage-calculation.xls file found in the Examples
- (/examples/src/org/apache/poi/examples/ss/excelant/simple-mortgage-calculation.xls). This sheet
- is shown below:</p>
+<p>Consider the <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/excelant/simple-mortgage-calculation.xls">mortgage-calculation.xls</a>
+ file found in the Examples (link broken / file is missing). This sheet is shown below:</p>
+<div style="text-align: center;">
+<img class="figure" alt="mortgage calculation spreadsheet" src="images/simple-xls-with-function.jpg"></div>
<p>This sheet calculates the principal and interest payment for a mortgage based
on the amount of the loan, term and rate. To write a simple ExcelAnt test you
need to tell ExcelAnt about the file like this:</p>
@@ -425,31 +426,31 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">property name="xls.file" value="" /></span>
+<span class="lineno"></span><span class="codebody"><property name="xls.file" value="" /></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">target name="simpleTest"></span>
+<span class="lineno"></span><span class="codebody"><target name="simpleTest"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
+<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
+<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="790.7936" precision="1.0e-4" /></span>
+<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="790.7936" precision="1.0e-4" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </test></span>
+<span class="lineno"></span><span class="codebody"> </test></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </excelant></span>
+<span class="lineno"></span><span class="codebody"> </excelant></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/target></span>
+<span class="lineno"></span><span class="codebody"></target></span>
</div>
</div>
<p>This code sets up ExcelAnt to access the file defined in the ant property
@@ -512,16 +513,16 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
+<span class="lineno"></span><span class="codebody"><setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
+<span class="lineno"></span><span class="codebody"><setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
+<span class="lineno"></span><span class="codebody"><setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
+<span class="lineno"></span><span class="codebody"><evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
</div>
</div>
<p>Don't forget that we're verifying the behavior so you need to put all this
@@ -599,34 +600,34 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">property name="xls.file" value="" /></span>
+<span class="lineno"></span><span class="codebody"><property name="xls.file" value="" /></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">target name="simpleTest"></span>
+<span class="lineno"></span><span class="codebody"><target name="simpleTest"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
+<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
+<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
+<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="790.7936" /></span>
+<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="790.7936" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </test></span>
+<span class="lineno"></span><span class="codebody"> </test></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </excelant></span>
+<span class="lineno"></span><span class="codebody"> </excelant></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/target></span>
+<span class="lineno"></span><span class="codebody"></target></span>
</div>
</div>
<p>In this example we have set the global precision to 1.0e-3. This means that
@@ -673,31 +674,31 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">excelant fileName="${xls.file}"></span>
+<span class="lineno"></span><span class="codebody"><excelant fileName="${xls.file}"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
+<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
+<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
+<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </test></span>
+<span class="lineno"></span><span class="codebody"> </test></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/excelant></span>
+<span class="lineno"></span><span class="codebody"></excelant></span>
</div>
</div>
<p>Now when you re-run this test with the verbose flag you will see that
@@ -759,40 +760,40 @@ workbooks then you need to have the foll
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">target name="functionTest"></span>
+<span class="lineno"></span><span class="codebody"><target name="functionTest"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
+<span class="lineno"></span><span class="codebody"> <excelant fileName="${xls.file}"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <udf functionAlias="calculatePayment" class="org.apache.poi.ss.examples.formula.CalculateMortgage"/></span>
+<span class="lineno"></span><span class="codebody"> <udf functionAlias="calculatePayment" class="org.apache.poi.ss.examples.formula.CalculateMortgage"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
+<span class="lineno"></span><span class="codebody"> <precision value="1.0e-3"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
+<span class="lineno"></span><span class="codebody"> <test name="checkValue" showFailureDetail="true"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$1" value="240000"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
+<span class="lineno"></span><span class="codebody"> <setDouble cell="'MortgageCalculator'!$B$3" value ="30"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculatorFunction'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
+<span class="lineno"></span><span class="codebody"> <evaluate showDelta="true" cell="'MortgageCalculatorFunction'!$B$4" expectedValue="2285.576149" precision="1.0e-4" /></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </test></span>
+<span class="lineno"></span><span class="codebody"> </test></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </excelant></span>
+<span class="lineno"></span><span class="codebody"> </excelant></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </target></span>
+<span class="lineno"></span><span class="codebody"> </target></span>
</div>
</div>
<p>So if you look at this carefully it looks the same as the previous examples. We
Modified: poi/site/publish/components/spreadsheet/how-to.html
URL: http://svn.apache.org/viewvc/poi/site/publish/components/spreadsheet/how-to.html?rev=1888581&r1=1888580&r2=1888581&view=diff
==============================================================================
--- poi/site/publish/components/spreadsheet/how-to.html (original)
+++ poi/site/publish/components/spreadsheet/how-to.html Sat Apr 10 11:47:17 2021
@@ -292,7 +292,7 @@ document.write("Last Published: " + docu
<div class="section">
<a name="Capabilities"></a>
<h3 class="boxed">Capabilities</h3>
-<p>This release of the how-to outlines functionality for the
+<p>This release of the how-to outlines functionality for the
current svn trunk.
Those looking for information on previous releases should
look in the documentation distributed with that release.</p>
@@ -300,12 +300,12 @@ document.write("Last Published: " + docu
HSSF allows numeric, string, date or formula cell values to be written to
or read from an XLS file. Also
in this release is row and column sizing, cell styling (bold,
- italics, borders,etc), and support for both built-in and user
+ italics, borders,etc), and support for both built-in and user
defined data formats. Also available is
an event-based API for reading XLS files.
It differs greatly from the read/write API
and is intended for intermediate developers who need a smaller
- memory footprint.
+ memory footprint.
</p>
<a name="Different+APIs"></a>
<h3 class="boxed">Different APIs</h3>
@@ -353,7 +353,7 @@ document.write("Last Published: " + docu
</p>
<p>Workbooks are created by creating an instance of
org.apache.poi.ss.usermodel.Workbook. Either create
- a concrete class directly
+ a concrete class directly
(org.apache.poi.hssf.usermodel.HSSFWorkbook or
org.apache.poi.xssf.usermodel.XSSFWorkbook), or use
the handy factory class
@@ -365,9 +365,9 @@ document.write("Last Published: " + docu
name (the tab at the bottom); you set
the name associated with a sheet by calling
Workbook.setSheetName(sheetindex,"SheetName",encoding).
- For HSSF, the name may be in 8bit format
+ For HSSF, the name may be in 8bit format
(HSSFWorkbook.ENCODING_COMPRESSED_UNICODE)
- or Unicode (HSSFWorkbook.ENCODING_UTF_16). Default
+ or Unicode (HSSFWorkbook.ENCODING_UTF_16). Default
encoding for HSSF is 8bit per char. For XSSF, the name
is automatically handled as unicode.
</p>
@@ -528,7 +528,7 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody">cs.setFont(f);</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">//set the cell format </span>
+<span class="lineno"></span><span class="codebody">//set the cell format</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">cs.setDataFormat(df.getFormat("#,##0.0"));</span>
@@ -570,7 +570,7 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody">// set the sheet name in Unicode</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">wb.setSheetName(0, "\u0422\u0435\u0441\u0442\u043E\u0432\u0430\u044F " + </span>
+<span class="lineno"></span><span class="codebody">wb.setSheetName(0, "\u0422\u0435\u0441\u0442\u043E\u0432\u0430\u044F " +</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"> "\u0421\u0442\u0440\u0430\u043D\u0438\u0447\u043A\u0430" );</span>
@@ -666,7 +666,7 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody"> c = r.createCell((short) (cellnum + 1));</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </span>
+<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"> // on every other row</span>
@@ -853,7 +853,7 @@ method (sheet.removeRow(hssfrow)) and cr
would if creating a new xls. When you are done modifying cells just
call workbook.write(outputstream) just as you did above.</p>
<p>An example of this can be seen in
-<a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">org.apache.poi.hssf.usermodel.examples.HSSFReadWrite</a>.</p>
+<a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">org.apache.poi.hssf.usermodel.examples.HSSFReadWrite</a>.</p>
<a name="event_api" id="event_api"></a><a name="Event+API+%28HSSF+Only%29"></a>
<h3 class="boxed">Event API (HSSF Only)</h3>
<p>The event API is newer than the User API. It is intended for intermediate
@@ -1172,7 +1172,7 @@ call workbook.write(outputstream) just a
<a name="record_aware_event_api" id="record_aware_event_api"></a><a name="Record+Aware+Event+API+%28HSSF+Only%29"></a>
<h3 class="boxed">Record Aware Event API (HSSF Only)</h3>
<p>
-This is an extension to the normal
+This is an extension to the normal
<a href="#event_api">Event API</a>. With this, your listener
will be called with extra, dummy records. These dummy records should
alert you to records which aren't present in the file (eg cells that have
@@ -1211,15 +1211,15 @@ to the event model, and start that as no
<p>
One example use for this API is to write a CSV outputter, which always
outputs a minimum number of columns, even where the file doesn't contain
-some of the rows or cells. It can be found at
+some of the rows or cells. It can be found at
<span class="codefrag">/src/examples/src/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java</span>,
and may be called on the command line, or from within your own code.
The latest version is always available from
-<a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/eventusermodel/">subversion</a>.
+<a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/">subversion</a>.
</p>
<p>
-<em>In POI versions before 3.0.3, this code lived in the scratchpad section.
+<em>In POI versions before 3.0.3, this code lived in the scratchpad section.
If you're using one of these older versions of POI, you will either
need to include the scratchpad jar on your classpath, or build from a</em>
<a href="../../devel/subversion.html">subversion checkout</a>.
@@ -1227,11 +1227,11 @@ The latest version is always available f
<a name="xssf_sax_api" id="xssf_sax_api"></a><a name="XSSF+and+SAX+%28Event+API%29"></a>
<h3 class="boxed">XSSF and SAX (Event API)</h3>
<p>If memory footprint is an issue, then for XSSF, you can get at
- the underlying XML data, and process it yourself. This is intended
- for intermediate developers who are willing to learn a little bit of
+ the underlying XML data, and process it yourself. This is intended
+ for intermediate developers who are willing to learn a little bit of
low level structure of .xlsx files, and who are happy processing
XML in java. Its relatively simple to use, but requires a basic
- understanding of the file structure. The advantage provided is that
+ understanding of the file structure. The advantage provided is that
you can read a XLSX file with a relatively small memory footprint.
</p>
<p>One important thing to note with the basic Event API is that it
@@ -1246,9 +1246,9 @@ The latest version is always available f
It provides methods to get the raw xml data from the rest of the
file, which you will then pass to SAX.</p>
<p>This example shows how to get at a single known sheet, or at
- all sheets in the file. It is based on the example in
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java">svn
- src/examples/src/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java</a>
+ all sheets in the file. It is based on the example in
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java">svn
+ poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java</a>
</p>
<div class="code">
<div class="codeline">
@@ -1607,10 +1607,10 @@ The latest version is always available f
For a fuller example, including support for fetching number formatting
information and applying it to numeric cells (eg to format dates or
percentages), please see
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">the XLSX2CSV example in svn</a>
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">the XLSX2CSV example in svn</a>
</p>
-<p>An example is also <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/streaming/HybridStreaming.java">provided</a>
+<p>An example is also <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/streaming/HybridStreaming.java">provided</a>
showing how to combine the user API and the SAX API by doing a streaming parse
of larger worksheets and a traditional user-model parse of the rest of a workbook.</p>
<a name="sxssf" id="sxssf"></a><a name="SXSSF+%28Streaming+Usermodel+API%29"></a>
@@ -1635,14 +1635,14 @@ The latest version is always available f
via getRow() anymore.
</p>
<p>
- The default window size is <em>100</em> and defined by SXSSFWorkbook.DEFAULT_WINDOW_SIZE.
+ The default window size is <em>100</em> and defined by SXSSFWorkbook.DEFAULT_WINDOW_SIZE.
</p>
<p>
A windowSize of -1 indicates unlimited access. In this case all
records that have not been flushed by a call to flushRows() are available
- for random access.
+ for random access.
</p>
-<p>
+<p>
Note that SXSSF allocates temporary files that you <strong>must</strong> always clean up explicitly, by calling the dispose method.
</p>
<p>
@@ -1663,7 +1663,7 @@ The latest version is always available f
Carefully review your memory budget and compatibility needs before deciding
whether to enable shared strings or not.
</p>
-<p> The example below writes a sheet with a window of 100 rows. When the row count reaches 101,
+<p> The example below writes a sheet with a window of 100 rows. When the row count reaches 101,
the row with rownum=0 is flushed to disk and removed from memory, when rownum reaches 102 then the row with rownum=1 is flushed, etc.
</p>
<div class="code">
@@ -1764,7 +1764,7 @@ The latest version is always available f
<span class="lineno"></span><span class="codebody"> }</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </span>
+<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"> FileOutputStream out = new FileOutputStream("/temp/sxssf.xlsx");</span>
@@ -1857,7 +1857,7 @@ The latest version is always available f
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> // manually control how rows are flushed to disk </span>
+<span class="lineno"></span><span class="codebody"> // manually control how rows are flushed to disk</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody"> if(rownum % 100 == 0) {</span>
@@ -1914,7 +1914,7 @@ The latest version is always available f
<span class="lineno"></span><span class="codebody"></span>
</div>
</div>
-<p>SXSSF flushes sheet data in temporary files (a temp file per sheet) and the size of these temporary files
+<p>SXSSF flushes sheet data in temporary files (a temp file per sheet) and the size of these temporary files
can grow to a very large value. For example, for a 20 MB csv data the size of the temp xml becomes more than a gigabyte.
If the size of the temp files is an issue, you can tell SXSSF to use gzip compression:
</p>
@@ -1923,7 +1923,7 @@ If the size of the temp files is an issu
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">SXSSFWorkbook wb = new SXSSFWorkbook(); </span>
+<span class="lineno"></span><span class="codebody">SXSSFWorkbook wb = new SXSSFWorkbook();</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">wb.setCompressTempFiles(true); // temp files will be gzipped</span>
@@ -1949,7 +1949,7 @@ documentation for the POIFS libraries as
<a name="Generating+XLS+from+XML"></a>
<h3 class="boxed">Generating XLS from XML</h3>
<p>If you wish to generate an XLS file from some XML, it is possible to
-write your own XML processing code, then use the User API to write out
+write your own XML processing code, then use the User API to write out
the document.</p>
<p>The other option is to use <a href="http://cocoon.apache.org/">Cocoon</a>.
In Cocoon, there is the <a href="http://cocoon.apache.org/2.1/userdocs/xls-serializer.html">HSSF Serializer</a>,
Modified: poi/site/publish/components/spreadsheet/record-generator.html
URL: http://svn.apache.org/viewvc/poi/site/publish/components/spreadsheet/record-generator.html?rev=1888581&r1=1888580&r2=1888581&view=diff
==============================================================================
--- poi/site/publish/components/spreadsheet/record-generator.html (original)
+++ poi/site/publish/components/spreadsheet/record-generator.html Sat Apr 10 11:47:17 2021
@@ -333,61 +333,61 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">record id="0x1032" name="Frame" package="org.apache.poi.hssf.record"</span>
+<span class="lineno"></span><span class="codebody"><record id="0x1032" name="Frame" package="org.apache.poi.hssf.record"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> excel-record-id="FRAME"></span>
+<span class="lineno"></span><span class="codebody"> excel-record-id="FRAME"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <description>The frame record indicates whether there is a border</span>
+<span class="lineno"></span><span class="codebody"> <description>The frame record indicates whether there is a border</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> around the displayed text of a chart.</description></span>
+<span class="lineno"></span><span class="codebody"> around the displayed text of a chart.</description></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <author>Glen Stampoultzis (glens at apache.org)</author></span>
+<span class="lineno"></span><span class="codebody"> <author>Glen Stampoultzis (glens at apache.org)</author></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <fields></span>
+<span class="lineno"></span><span class="codebody"> <fields></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <field type="int" size="2" name="border type"></span>
+<span class="lineno"></span><span class="codebody"> <field type="int" size="2" name="border type"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <const name="regular" value="0" description="regular rectangle or no border"/></span>
+<span class="lineno"></span><span class="codebody"> <const name="regular" value="0" description="regular rectangle or no border"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <const name="shadow" value="1" description="rectangle with shadow"/></span>
+<span class="lineno"></span><span class="codebody"> <const name="shadow" value="1" description="rectangle with shadow"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </field></span>
+<span class="lineno"></span><span class="codebody"> </field></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <field type="int" size="2" name="options"></span>
+<span class="lineno"></span><span class="codebody"> <field type="int" size="2" name="options"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <bit number="0" name="auto size"</span>
+<span class="lineno"></span><span class="codebody"> <bit number="0" name="auto size"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> description="excel calculates the size automatically if true"/></span>
+<span class="lineno"></span><span class="codebody"> description="excel calculates the size automatically if true"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> <bit number="1" name="auto position"</span>
+<span class="lineno"></span><span class="codebody"> <bit number="1" name="auto position"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> description="excel calculates the position automatically"/></span>
+<span class="lineno"></span><span class="codebody"> description="excel calculates the position automatically"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </field></span>
+<span class="lineno"></span><span class="codebody"> </field></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </fields></span>
+<span class="lineno"></span><span class="codebody"> </fields></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">/record></span>
+<span class="lineno"></span><span class="codebody"></record></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </span>
+<span class="lineno"></span><span class="codebody"> </span>
</div>
</div>
<p>
@@ -509,13 +509,13 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">field type="custom:org.apache.poi.hssf.record.LinkedDataFormulaField"</span>
+<span class="lineno"></span><span class="codebody"><field type="custom:org.apache.poi.hssf.record.LinkedDataFormulaField"</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> size="var" name="formula of link" description="formula"/></span>
+<span class="lineno"></span><span class="codebody"> size="var" name="formula of link" description="formula"/></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody"> </span>
+<span class="lineno"></span><span class="codebody"> </span>
</div>
</div>
<p>
Modified: poi/site/publish/encryption.html
URL: http://svn.apache.org/viewvc/poi/site/publish/encryption.html?rev=1888581&r1=1888580&r2=1888581&view=diff
==============================================================================
--- poi/site/publish/encryption.html (original)
+++ poi/site/publish/encryption.html Sat Apr 10 11:47:17 2021
@@ -554,7 +554,7 @@ document.write("Last Published: " + docu
to protect it from unauthorized modifications, i.e. modifications without having the original certificate.
The current implementation is based on the <!--<a href="http://eid-applet.googlecode.com">eID Applet</a>-->
<a href="https://github.com/e-Contract/eid-applet">eID Applet</a> which
- is dual-licensed to <!--<a href="https://code.google.com/p/eid-applet/source/browse/trunk/README.txt">ASF/POI</a>-->
+ is dual-licensed to
<a href="https://github.com/e-Contract/eid-applet/blob/master/README.md#7-license">Apache License 2.0 and LGPL v3.0</a>.
Instead of using the internal <a href="http://www.jsourcecode.com/class.php?proj=jdk%5Copenjdk&jar=openjdk-6-b14&class=org.jcp.xml.dsig.internal.dom.DOMXMLSignatureFactory">JDK API</a>
this version is based on <a href="https://santuario.apache.org">Apache Santuario</a>.</p>
@@ -575,7 +575,7 @@ document.write("Last Published: " + docu
depend on supporting services and although the code is adopted, the integration is not well tested ... please support us on
integration (testing) with timestamp and revocation (OCSP) services.
</p>
-<p>Further test examples can be found in the corresponding <a href="https://svn.apache.org/viewvc/poi/trunk/src/ooxml/testcases/org/apache/poi/poifs/crypt/TestSignatureInfo.java?view=markup">test class</a>.</p>
+<p>Further test examples can be found in the corresponding <a href="https://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/test/java/org/apache/poi/poifs/crypt/dsig/TestSignatureInfo.java?view=markup">test class</a>.</p>
<p>If you want to use a hash algorithm with 64 bytes (currently only applies to SHA512),
<a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=42061">a base64 "feature"</a> in xmlsec
leads to line breaks in the digest values, which won't be accepted by Office. To workaround this, you
@@ -817,7 +817,7 @@ document.write("Last Published: " + docu
<p>The code example, written by PJ Fanning, modifies the behavior of SXSSFWorkbook
to extract an OOXML spreadsheet zipped container and write the contents to disk using AES
encryption.</p>
-<p>See <a href="https://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/temp/SXSSFWorkbookWithCustomZipEntrySource.java?view=markup">SXSSFWorkbookWithCustomZipEntrySource.java</a>
+<p>See <a href="https://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/temp/SXSSFWorkbookWithCustomZipEntrySource.java?view=markup">SXSSFWorkbookWithCustomZipEntrySource.java</a>
and other <a href="https://svn.apache.org/viewvc?view=revision&revision=1768744">files</a>
that are needed for this example.</p>
</div>
Modified: poi/site/publish/help/faq.html
URL: http://svn.apache.org/viewvc/poi/site/publish/help/faq.html?rev=1888581&r1=1888580&r2=1888581&view=diff
==============================================================================
--- poi/site/publish/help/faq.html (original)
+++ poi/site/publish/help/faq.html Sat Apr 10 11:47:17 2021
@@ -505,8 +505,8 @@ case HSSFCell.CELL_TYPE_NUMERIC:
<p>Apache POI ships with a few programs and a few example programs,
which can be used to do some basic performance checks. For testing
file generation, the class to use is in the examples package,
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/ss/SSPerformanceTest.java">viewvc</a>).
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/SSPerformanceTest.java">viewvc</a>).
Run SSPerformanceTest with arguments of the writing type (HSSF, XSSF
or SXSSF), the number rows, the number of columns, and if the file
should be saved. If you can't run that with 50,000 rows and 50 columns
@@ -514,11 +514,11 @@ case HSSFCell.CELL_TYPE_NUMERIC:
(and ideally all 3 in less than that!), then the problem is with
your environment.</p>
<p>Next, use the example program
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ToCSV.java">viewvc</a>)
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java">viewvc</a>)
to try reading the file in with HSSF or XSSF. Related is
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">XLSX2CSV</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">viewvc</a>),
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">XLSX2CSV</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">viewvc</a>),
which uses SAX parsing for .xlsx. Run this against both your problem file,
and a simple one generated by SSPerformanceTest of the same size. If this is
slow, then there could be an Apache POI problem with how the file is being
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org