Skip to content

Commit

Permalink
add javadoc comments on new methods
Browse files Browse the repository at this point in the history
  • Loading branch information
JuicyDragon committed Dec 11, 2020
1 parent d75d465 commit 7fb21de
Showing 1 changed file with 28 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public void exportJson(String fileNameTemplate, JsonExporter jsonExporter) {

/***
* 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 @@ -189,6 +189,25 @@ public void setHeaderRenames(Map<String,String> renames) {
this.headerRenames = renames;
}

/***
* 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.
* @param columnHeaders 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.
*/
public void setColumnRemovals(Collection<String> columnHeaders) {
this.columnRemovals = new HashSet<String>();
this.columnRemovals.addAll(columnHeaders);
Expand Down Expand Up @@ -683,10 +702,18 @@ public void setExportXlsx(boolean exportXlsx) {
this.exportXlsx = exportXlsx;
}

/***
* Gets whether original DAT will be kept by moving it to final export directory.
* @return True if final DAT will be kept
*/
public boolean getKeepOriginalDat() {
return keepOriginalDat;
}

/***
* Sets whether final DAT will be kept by moving it to final export directory/
* @param keepOriginalDat True if final DAT should be kept
*/
public void setKeepOriginalDat(boolean keepOriginalDat) {
this.keepOriginalDat = keepOriginalDat;
}
Expand Down

0 comments on commit 7fb21de

Please sign in to comment.