Author: centic
Date: Sun Apr 10 16:50:15 2022
New Revision: 1899710
URL: http://svn.apache.org/viewvc?rev=1899710&view=rev
Log:
Describing some more configuration options, also describe a few system
properties
Modified:
poi/site/publish/components/configuration.html
poi/site/src/documentation/content/xdocs/components/configuration.xml
Modified: poi/site/publish/components/configuration.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/components/configuration.html?rev=1899710&r1=1899709&r2=1899710&view=diff
==============================================================================
--- poi/site/publish/components/configuration.html (original)
+++ poi/site/publish/components/configuration.html Sun Apr 10 16:50:15 2022
@@ -300,6 +300,14 @@ document.write("Last Published: " + docu
settings that can be enabled that may prove useful to users who have
to handle very large documents or very
large throughput.
</p>
+</div>
+
+<a name="Configuration+via+Java-code+when+calling+Apache+POI"></a>
+<h2 class="boxed">Configuration via Java-code when calling Apache POI</h2>
+<div class="section">
+<p>These API methods allow to configure behavior of Apache POI for special
needs, e.g. when processing excessively
+ large files.
+ </p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
@@ -425,6 +433,120 @@ document.write("Last Published: " + docu
</tr>
+
+<tr>
+
+<td colspan="1"
rowspan="1">org.apache.poi.extractor.ExtractorFactory.setThreadPrefersEventExtractors(boolean
preferEventExtractors) and
+
org.apache.poi.extractor.ExtractorFactory.setAllThreadsPreferEventExtractors(Boolean
preferEventExtractors)
+ </td>
+ <td colspan="1" rowspan="1">
+ When creating text-extractors for documents, allows to choose a
different type of extractor which parses documents
+ via an event-based parser.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">Various classes: setMaxRecordLength(int length)
+ </td>
+ <td colspan="1" rowspan="1">
+ Allows to override the default max record length for various
classes which
+ parse input data. E.g. XMLSlideShow, XSSFBParser, HSLFSlideShow,
HWPFDocument,
+ HSSFWorkbook, EmbeddedExtractor, StringUtil, ...
+ <br>
+ This may be useful if you try to process very large files which
otherwise trigger
+ the excessive-memory-allocation prevention in Apache POI.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1"
rowspan="1">org.apache.poi.xslf.usermodel.XSLFPictureData.setMaxImageSize(int
length)
+ </td>
+ <td colspan="1" rowspan="1">
+ Allows to override the default max image size allowed for XSLF
pictures.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1"
rowspan="1">org.apache.poi.xssf.usermodel.XSSFPictureData#setMaxImageSize(int
length)
+ </td>
+ <td colspan="1" rowspan="1">
+ Allows to override the default max image size allowed for XSSF
pictures.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1"
rowspan="1">org.apache.poi.xwpf.usermodel.XWPFPictureData#setMaxImageSize(int
length)
+ </td>
+ <td colspan="1" rowspan="1">
+ Allows to override the default max image size allowed for XWPF
pictures.
+ </td>
+
+</tr>
+
+
+</table>
+</div>
+
+<a name="Observed+Java+System+Properties"></a>
+<h2 class="boxed">Observed Java System Properties</h2>
+<div class="section">
+<p>Apache POI supports some Java System Properties.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">System property</th>
+ <th colspan="1" rowspan="1">Description</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">java.io.tmpdir</td>
+ <td colspan="1" rowspan="1">
+ Apache POI uses the default mechanism of the JDK for specifying
the location of
+ temporary files.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">org.apache.poi.hwpf.preserveBinTables and
org.apache.poi.hwpf.preserveTextTable</td>
+ <td colspan="1" rowspan="1">
+ Allows to adjust how parsing Word documents via HWPF is handling
tables.
+ </td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">org.apache.poi.ss.ignoreMissingFontSystem</td>
+ <td colspan="1" rowspan="1"><strong>Added in POI 5.2.3.</strong>
+ Instructs Apache POI to ignore some errors due to missing fonts
and thus allows
+ to perform more functionality even when no fonts are installed.
+ <br>
+ Note: Some functionality will still not be possible as it cannot
use default-values, e.g. rendering
+ slides, drawing, ...
+ </td>
+
+</tr>
</table>
</div>
Modified: poi/site/src/documentation/content/xdocs/components/configuration.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/configuration.xml?rev=1899710&r1=1899709&r2=1899710&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/configuration.xml
(original)
+++ poi/site/src/documentation/content/xdocs/components/configuration.xml Sun
Apr 10 16:50:15 2022
@@ -26,7 +26,7 @@
<person id="POI" name="POI Developers" email="[email protected]"/>
</authors>
</header>
-
+
<body>
<section><title>Overview</title>
<p>The best way to learn about using Apache POI is to read through the
<a href="index.html">feature documentation</a>
@@ -36,6 +36,11 @@
settings that can be enabled that may prove useful to users who have
to handle very large documents or very
large throughput.
</p>
+ </section>
+ <section><title>Configuration via Java-code when calling Apache POI</title>
+ <p>These API methods allow to configure behavior of Apache POI for
special needs, e.g. when processing excessively
+ large files.
+ </p>
<table>
<tr>
<th>Configuration Setting</th>
@@ -129,6 +134,89 @@
</td>
</tr>
+ <tr>
+
<td>org.apache.poi.extractor.ExtractorFactory.setThreadPrefersEventExtractors(boolean
preferEventExtractors) and
+
org.apache.poi.extractor.ExtractorFactory.setAllThreadsPreferEventExtractors(Boolean
preferEventExtractors)
+ </td>
+ <td>
+ When creating text-extractors for documents, allows to choose a
different type of extractor which parses documents
+ via an event-based parser.
+ </td>
+ </tr>
+
+ <tr>
+ <td>Various classes: setMaxRecordLength(int length)
+ </td>
+ <td>
+ Allows to override the default max record length for various
classes which
+ parse input data. E.g. XMLSlideShow, XSSFBParser, HSLFSlideShow,
HWPFDocument,
+ HSSFWorkbook, EmbeddedExtractor, StringUtil, ...
+ <br/>
+ This may be useful if you try to process very large files which
otherwise trigger
+ the excessive-memory-allocation prevention in Apache POI.
+ </td>
+ </tr>
+
+ <tr>
+
<td>org.apache.poi.xslf.usermodel.XSLFPictureData.setMaxImageSize(int length)
+ </td>
+ <td>
+ Allows to override the default max image size allowed for XSLF
pictures.
+ </td>
+ </tr>
+
+ <tr>
+
<td>org.apache.poi.xssf.usermodel.XSSFPictureData#setMaxImageSize(int length)
+ </td>
+ <td>
+ Allows to override the default max image size allowed for XSSF
pictures.
+ </td>
+ </tr>
+
+ <tr>
+
<td>org.apache.poi.xwpf.usermodel.XWPFPictureData#setMaxImageSize(int length)
+ </td>
+ <td>
+ Allows to override the default max image size allowed for XWPF
pictures.
+ </td>
+ </tr>
+
+ </table>
+ </section>
+ <section><title>Observed Java System Properties</title>
+ <p>Apache POI supports some Java System Properties.
+ </p>
+ <table>
+ <tr>
+ <th>System property</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>java.io.tmpdir</td>
+ <td>
+ Apache POI uses the default mechanism of the JDK for specifying
the location of
+ temporary files.
+ </td>
+ </tr>
+
+ <tr>
+ <td>org.apache.poi.hwpf.preserveBinTables and
org.apache.poi.hwpf.preserveTextTable</td>
+ <td>
+ Allows to adjust how parsing Word documents via HWPF is handling
tables.
+ </td>
+ </tr>
+
+ <tr>
+ <td>org.apache.poi.ss.ignoreMissingFontSystem</td>
+ <td><strong>Added in POI 5.2.3.</strong>
+ Instructs Apache POI to ignore some errors due to missing fonts
and thus allows
+ to perform more functionality even when no fonts are installed.
+ <br/>
+ Note: Some functionality will still not be possible as it cannot
use default-values, e.g. rendering
+ slides, drawing, ...
+ </td>
+ </tr>
</table>
</section>
</body>
@@ -137,7 +225,7 @@
<legal>
Copyright (c) @year@ The Apache Software Foundation. All rights reserved.
<br />
- Apache POI, POI, Apache, the Apache feather logo, and the Apache
+ Apache POI, POI, Apache, the Apache feather logo, and the Apache
POI project logo are trademarks of The Apache Software Foundation.
</legal>
</footer>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
