Skip to content

Commit

Permalink
javadoc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
@JuicyDragon
JuicyDragon committed Dec 11, 2020
1 parent 7fb21de commit d973ee2
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 11 deletions.
97 changes: 86 additions & 11 deletions docs/com/nuix/superutilities/export/CustomExporter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -210,57 +210,75 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#getKeepOriginalDat--">getKeepOriginalDat</a></span>()</code>
<div class="block">Gets whether original DAT will be kept by moving it to final export directory.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>nuix.MetadataProfile</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#getProfile--">getProfile</a></span>()</code>
<div class="block">Gets the metadata profile which will be used during export.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#removeDynamicPlaceholder-java.lang.String-">removeDynamicPlaceholder</a></span>(java.lang.String&nbsp;placeholderName)</code>
<div class="block">Removes a previously added dynamic placeholder.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setColumnRemovals-java.util.Collection-">setColumnRemovals</a></span>(java.util.Collection&lt;java.lang.String&gt;&nbsp;columnHeaders)</code>
<div class="block">Allows you to provide a list of header names to specify columns to remove.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setDynamicPlaceholder-java.lang.String-java.util.function.BiFunction-">setDynamicPlaceholder</a></span>(java.lang.String&nbsp;placeholderName,
java.util.function.BiFunction&lt;nuix.Item,java.lang.String,java.lang.String&gt;&nbsp;function)</code>
<div class="block">Assigns a dynamically calculated placeholder to this instance.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setExportXlsx-boolean-">setExportXlsx</a></span>(boolean&nbsp;exportXlsx)</code>
<div class="block">Sets whether DAT contents should additionally be exported as an XLSX spreadsheet.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setHeaderRenames-java.util.Map-">setHeaderRenames</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;renames)</code>
<div class="block">Allows you to provide a Map of headers to rename.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setImagingOptions-java.util.Map-">setImagingOptions</a></span>(java.util.Map&lt;?,?&gt;&nbsp;settings)</code>
<div class="block">Sets the Map of settings which will be passed to <code>BatchExporter.setImagingOptions(Map)</code> when performing
the temporary export before restructuring.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setKeepOriginalDat-boolean-">setKeepOriginalDat</a></span>(boolean&nbsp;keepOriginalDat)</code>
<div class="block">Sets whether final DAT will be kept by moving it to final export directory/</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setParallelProcessingSettings-java.util.Map-">setParallelProcessingSettings</a></span>(java.util.Map&lt;?,?&gt;&nbsp;settings)</code>
<div class="block">Sets the Map of settings which will be passed to <code>BatchExporter.setParallelProcessingSettings(Map)</code> when performing
the temporary export before restructuring.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setProfile-nuix.MetadataProfile-">setProfile</a></span>(nuix.MetadataProfile&nbsp;profile)</code>
<div class="block">Sets the metadata profile used during export.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/export/CustomExporter.html#setStampingOptions-java.util.Map-">setStampingOptions</a></span>(java.util.Map&lt;?,?&gt;&nbsp;settings)</code>
<div class="block">Sets the Map of settings which will be passed to <code>BatchExporter.setStampingOptions(Map)</code> when performing
Expand Down Expand Up @@ -448,7 +466,7 @@ <h4>exportJson</h4>
<h4>setHeaderRenames</h4>
<pre>public&nbsp;void&nbsp;setHeaderRenames(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;renames)</pre>
<div class="block">Allows you to provide a Map of headers to rename. Intended to provide a way to rename headers that Nuix automatically adds
to DAT files is generates:<br>
to DAT files it generates:<br>
<code>DOCID</code><br>
<code>PARENT_DOCID</code><br>
<code>ATTACH_DOCID</code><br>
Expand All @@ -467,6 +485,35 @@ <h4>setHeaderRenames</h4>
</dl>
</li>
</ul>
<a name="setColumnRemovals-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnRemovals</h4>
<pre>public&nbsp;void&nbsp;setColumnRemovals(java.util.Collection&lt;java.lang.String&gt;&nbsp;columnHeaders)</pre>
<div class="block">Allows you to provide a list of header names to specify columns to remove. Intended to provide a way to remove columns that Nuix automatically adds
to DAT files it generates:<br>
<code>DOCID</code><br>
<code>PARENT_DOCID</code><br>
<code>ATTACH_DOCID</code><br>
<code>BEGINBATES</code><br>
<code>ENDBATES</code><br>
<code>BEGINGROUP</code><br>
<code>ENDGROUP</code><br>
<code>PAGECOUNT</code><br>
<code>ITEMPATH</code> (when exporting natives)<br>
<code>TEXTPATH</code> (when exporting text)<br>
<code>PDFPATH</code> (when exporting PDFs)<br>
<code>TIFFPATH</code> (when exporting TIFFs)<br>
Case sensitive and takes priority over column renaming, so make sure you provide original pre-rename headers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnHeaders</code> - Collection of column header names for columns to be removed. Case sensitive and takes priority over column renaming,
so make sure you provide original pre-rename headers.</dd>
</dl>
</li>
</ul>
<a name="exportItems-nuix.Case-java.lang.String-java.util.List-">
<!-- -->
</a>
Expand Down Expand Up @@ -581,7 +628,7 @@ <h4>getExportXlsx</h4>
<a name="setExportXlsx-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>setExportXlsx</h4>
<pre>public&nbsp;void&nbsp;setExportXlsx(boolean&nbsp;exportXlsx)</pre>
Expand All @@ -592,6 +639,34 @@ <h4>setExportXlsx</h4>
</dl>
</li>
</ul>
<a name="getKeepOriginalDat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeepOriginalDat</h4>
<pre>public&nbsp;boolean&nbsp;getKeepOriginalDat()</pre>
<div class="block">Gets whether original DAT will be kept by moving it to final export directory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if final DAT will be kept</dd>
</dl>
</li>
</ul>
<a name="setKeepOriginalDat-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setKeepOriginalDat</h4>
<pre>public&nbsp;void&nbsp;setKeepOriginalDat(boolean&nbsp;keepOriginalDat)</pre>
<div class="block">Sets whether final DAT will be kept by moving it to final export directory/</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keepOriginalDat</code> - True if final DAT should be kept</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
8 changes: 8 additions & 0 deletions docs/index-files/index-18.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,10 @@ <h2 class="title">S</h2>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html#setColumnLabel-java.lang.String-">setColumnLabel(String)</a></span> - Method in class com.nuix.superutilities.reporting.<a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html" title="class in com.nuix.superutilities.reporting">ColumnValueGenerator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/export/CustomExporter.html#setColumnRemovals-java.util.Collection-">setColumnRemovals(Collection&lt;String&gt;)</a></span> - Method in class com.nuix.superutilities.export.<a href="../com/nuix/superutilities/export/CustomExporter.html" title="class in com.nuix.superutilities.export">CustomExporter</a></dt>
<dd>
<div class="block">Allows you to provide a list of header names to specify columns to remove.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/export/ChunkedDATExporter.html#setConcurrency-int-">setConcurrency(int)</a></span> - Method in class com.nuix.superutilities.export.<a href="../com/nuix/superutilities/export/ChunkedDATExporter.html" title="class in com.nuix.superutilities.export">ChunkedDATExporter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/regex/RegexScanner.html#setContextSize-int-">setContextSize(int)</a></span> - Method in class com.nuix.superutilities.regex.<a href="../com/nuix/superutilities/regex/RegexScanner.html" title="class in com.nuix.superutilities.regex">RegexScanner</a></dt>
Expand Down Expand Up @@ -299,6 +303,10 @@ <h2 class="title">S</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html#setItem-nuix.Item-">setItem(Item)</a></span> - Method in class com.nuix.superutilities.annotations.<a href="../com/nuix/superutilities/annotations/NuixImageAnnotationRegion.html" title="class in com.nuix.superutilities.annotations">NuixImageAnnotationRegion</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/export/CustomExporter.html#setKeepOriginalDat-boolean-">setKeepOriginalDat(boolean)</a></span> - Method in class com.nuix.superutilities.export.<a href="../com/nuix/superutilities/export/CustomExporter.html" title="class in com.nuix.superutilities.export">CustomExporter</a></dt>
<dd>
<div class="block">Sets whether final DAT will be kept by moving it to final export directory/</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html#setLabel-java.lang.String-">setLabel(String)</a></span> - Method in class com.nuix.superutilities.reporting.<a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html" title="class in com.nuix.superutilities.reporting">ColumnValueGenerator</a></dt>
<dd>
<div class="block">Sets the label associated to this instance</div>
Expand Down
4 changes: 4 additions & 0 deletions docs/index-files/index-7.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Get file path of SuperUtilities.jar</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/export/CustomExporter.html#getKeepOriginalDat--">getKeepOriginalDat()</a></span> - Method in class com.nuix.superutilities.export.<a href="../com/nuix/superutilities/export/CustomExporter.html" title="class in com.nuix.superutilities.export">CustomExporter</a></dt>
<dd>
<div class="block">Gets whether original DAT will be kept by moving it to final export directory.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html#getLabel--">getLabel()</a></span> - Method in class com.nuix.superutilities.reporting.<a href="../com/nuix/superutilities/reporting/ColumnValueGenerator.html" title="class in com.nuix.superutilities.reporting">ColumnValueGenerator</a></dt>
<dd>
<div class="block">Gets the label associated to this instance.</div>
Expand Down

0 comments on commit d973ee2

Please sign in to comment.