Package org.nuxeo.ecm.csv.core

Class CSVImporterOptions

java.lang.Object

org.nuxeo.ecm.csv.core.CSVImporterOptions

All Implemented Interfaces:

Serializable

public class CSVImporterOptions
extends Object
implements Serializable

Since:

5.7

Author:

Thomas Roger

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSVImporterOptions.Builder
static enum	CSVImporterOptions.ImportMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	batchSize
protected final boolean	checkAllowedSubTypes
protected final Character	commentMarker
protected final long	computeTotalThresholdSize
protected final CSVImporterDocumentFactory	CSVImporterDocumentFactory
protected final DateFormat	dateFormat
static final CSVImporterOptions	DEFAULT_OPTIONS
protected final Character	escapeCharacter
protected CSVImporterOptions.ImportMode	importMode
static final String	LEGACY_DATE_FORMAT
static final String	LEGACY_DATE_FORMAT_PROP
protected final String	listSeparatorRegex
protected final boolean	sendEmail
protected final boolean	trim
static final String	TRIM_PROP
protected final boolean	updateExisting

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory, String dateFormat, String listSeparatorRegex, boolean updateExisting, boolean checkAllowedSubTypes, boolean sendEmail, int batchSize, CSVImporterOptions.ImportMode importMode)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.5, use CSVImporterOptions.Builder.build() instead
protected	CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory, String dateFormat, String listSeparatorRegex, Character escapeCharacter, boolean updateExisting, boolean checkAllowedSubTypes, boolean sendEmail, int batchSize, CSVImporterOptions.ImportMode importMode)	Deprecated, for removal: This API element is subject to removal in a future version. since 11.5, use CSVImporterOptions.Builder.build() instead
protected	CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory, String dateFormat, String listSeparatorRegex, Character commentMarker, Character escapeCharacter, boolean updateExisting, boolean checkAllowedSubTypes, boolean sendEmail, int batchSize, CSVImporterOptions.ImportMode importMode, long computeTotalThresholdSize)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use CSVImporterOptions.Builder.build() instead
protected	CSVImporterOptions(CSVImporterOptions.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	checkAllowedSubTypes()
protected DateFormat	computeDateFormat(String dateFormat)
int	getBatchSize()
Character	getCommentMarker()
long	getComputeTotalThresholdSize()
CSVImporterDocumentFactory	getCSVImporterDocumentFactory()
DateFormat	getDateFormat()
Character	getEscapeCharacter()
CSVImporterOptions.ImportMode	getImportMode()
String	getListSeparatorRegex()
boolean	sendEmail()
boolean	trim()
boolean	updateExisting()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LEGACY_DATE_FORMAT_PROP

public static final String LEGACY_DATE_FORMAT_PROP

See Also:

• Constant Field Values

TRIM_PROP

public static final String TRIM_PROP

Since:

2025.0

See Also:

• Constant Field Values

LEGACY_DATE_FORMAT

public static final String LEGACY_DATE_FORMAT

See Also:

• Constant Field Values

DEFAULT_OPTIONS

public static final CSVImporterOptions DEFAULT_OPTIONS

importMode

protected CSVImporterOptions.ImportMode importMode

CSVImporterDocumentFactory

protected final CSVImporterDocumentFactory CSVImporterDocumentFactory

dateFormat

protected final DateFormat dateFormat

listSeparatorRegex

protected final String listSeparatorRegex

commentMarker

protected final Character commentMarker

escapeCharacter

protected final Character escapeCharacter

updateExisting

protected final boolean updateExisting

trim

protected final boolean trim

checkAllowedSubTypes

protected final boolean checkAllowedSubTypes

sendEmail

protected final boolean sendEmail

batchSize

protected final int batchSize

computeTotalThresholdSize

protected final long computeTotalThresholdSize

Constructor Details

CSVImporterOptions

@Deprecated(since="11.5",
            forRemoval=true)
protected CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory,
 String dateFormat,
 String listSeparatorRegex,
 boolean updateExisting,
 boolean checkAllowedSubTypes,
 boolean sendEmail,
 int batchSize,
 CSVImporterOptions.ImportMode importMode)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.5, use CSVImporterOptions.Builder.build() instead

CSVImporterOptions

@Deprecated(since="11.5",
            forRemoval=true)
protected CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory,
 String dateFormat,
 String listSeparatorRegex,
 Character escapeCharacter,
 boolean updateExisting,
 boolean checkAllowedSubTypes,
 boolean sendEmail,
 int batchSize,
 CSVImporterOptions.ImportMode importMode)

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.5, use CSVImporterOptions.Builder.build() instead

Since:

7.2

CSVImporterOptions

@Deprecated(since="2025.0",
            forRemoval=true)
protected CSVImporterOptions(CSVImporterDocumentFactory CSVImporterDocumentFactory,
 String dateFormat,
 String listSeparatorRegex,
 Character commentMarker,
 Character escapeCharacter,
 boolean updateExisting,
 boolean checkAllowedSubTypes,
 boolean sendEmail,
 int batchSize,
 CSVImporterOptions.ImportMode importMode,
 long computeTotalThresholdSize)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, use CSVImporterOptions.Builder.build() instead

Since:

8.3

CSVImporterOptions

protected CSVImporterOptions(CSVImporterOptions.Builder builder)

Method Details

computeDateFormat

protected DateFormat computeDateFormat(String dateFormat)

getCSVImporterDocumentFactory

public CSVImporterDocumentFactory getCSVImporterDocumentFactory()

getDateFormat

public DateFormat getDateFormat()

getListSeparatorRegex

public String getListSeparatorRegex()

getCommentMarker

public Character getCommentMarker()

getEscapeCharacter

public Character getEscapeCharacter()

updateExisting

public boolean updateExisting()

trim

public boolean trim()

Since:

2025.0

checkAllowedSubTypes

public boolean checkAllowedSubTypes()

sendEmail

public boolean sendEmail()

getBatchSize

public int getBatchSize()

getComputeTotalThresholdSize

public long getComputeTotalThresholdSize()

Since:

11.5

getImportMode

public CSVImporterOptions.ImportMode getImportMode()