Skip to content

Commit 7fb21de

Browse files
committed
add javadoc comments on new methods
1 parent d75d465 commit 7fb21de

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

Java/src/main/java/com/nuix/superutilities/export/CustomExporter.java

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ public void exportJson(String fileNameTemplate, JsonExporter jsonExporter) {
170170

171171
/***
172172
* Allows you to provide a Map of headers to rename. Intended to provide a way to rename headers that Nuix automatically adds
173-
* to DAT files is generates:<br>
173+
* to DAT files it generates:<br>
174174
* <code>DOCID</code><br>
175175
* <code>PARENT_DOCID</code><br>
176176
* <code>ATTACH_DOCID</code><br>
@@ -189,6 +189,25 @@ public void setHeaderRenames(Map<String,String> renames) {
189189
this.headerRenames = renames;
190190
}
191191

192+
/***
193+
* 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
194+
* to DAT files it generates:<br>
195+
* <code>DOCID</code><br>
196+
* <code>PARENT_DOCID</code><br>
197+
* <code>ATTACH_DOCID</code><br>
198+
* <code>BEGINBATES</code><br>
199+
* <code>ENDBATES</code><br>
200+
* <code>BEGINGROUP</code><br>
201+
* <code>ENDGROUP</code><br>
202+
* <code>PAGECOUNT</code><br>
203+
* <code>ITEMPATH</code> (when exporting natives)<br>
204+
* <code>TEXTPATH</code> (when exporting text)<br>
205+
* <code>PDFPATH</code> (when exporting PDFs)<br>
206+
* <code>TIFFPATH</code> (when exporting TIFFs)<br>
207+
* Case sensitive and takes priority over column renaming, so make sure you provide original pre-rename headers.
208+
* @param columnHeaders Collection of column header names for columns to be removed. Case sensitive and takes priority over column renaming,
209+
* so make sure you provide original pre-rename headers.
210+
*/
192211
public void setColumnRemovals(Collection<String> columnHeaders) {
193212
this.columnRemovals = new HashSet<String>();
194213
this.columnRemovals.addAll(columnHeaders);
@@ -683,10 +702,18 @@ public void setExportXlsx(boolean exportXlsx) {
683702
this.exportXlsx = exportXlsx;
684703
}
685704

705+
/***
706+
* Gets whether original DAT will be kept by moving it to final export directory.
707+
* @return True if final DAT will be kept
708+
*/
686709
public boolean getKeepOriginalDat() {
687710
return keepOriginalDat;
688711
}
689712

713+
/***
714+
* Sets whether final DAT will be kept by moving it to final export directory/
715+
* @param keepOriginalDat True if final DAT should be kept
716+
*/
690717
public void setKeepOriginalDat(boolean keepOriginalDat) {
691718
this.keepOriginalDat = keepOriginalDat;
692719
}

0 commit comments

Comments
 (0)