com.orchestranetworks.addon.dex.configuration

Class FileImportConfigurationSpec<T extends Table>

java.lang.Object

com.orchestranetworks.addon.dex.configuration.FileImportConfigurationSpec<T>

All Implemented Interfaces:

ConfigurationSpec<T>, ImportConfigurationSpec<T>

Direct Known Subclasses:

CSVImportConfigurationSpec, SpreadsheetImportConfigurationSpec, XMLImportConfigurationSpec

public abstract class FileImportConfigurationSpec<T extends Table>
extends Object
implements ImportConfigurationSpec<T>

Specifies the configuration used when importing data from a file.

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
FileImportConfigurationSpec()

Method Summary

Modifier and Type	Method and Description
String	getErrorFilePath() Returns the path of exported file containing invalid data.
File	getImportedFile() Returns the imported file.
ImportMode	getImportMode() Returns the specified import mode.
boolean	isEmptyOrNullPrimaryKeyChecked() Returns true if all empty or null primary keys were checked before data import and false if this verification was not performed.
boolean	isEmptyOrNullValueIgnored() Returns true if all empty or null values are ignored in the process of importing data.
boolean	isHeaderUsed() Returns true if the first row of every column in the file contains the column label in the Excel/CSV file, or the imported XML file contains the {addon.label} header.
boolean	isImportForced() Returns true if all triggers and constraints are disabled in the process of importing data.
boolean	isInvalidDataDownloaded() Returns true if all records with errors in their data rows are exported to a downloadable file.
void	setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked) Sets whether all empty or null primary keys were checked before data import.
void	setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored) Sets whether all empty or null values are ignored in the process of importing data.
void	setErrorFilePath(String errorFilePath) Sets the path of the exported file containing invalid data.
void	setHeaderUsed(boolean headerUsed) Sets whether the first row of every column in the file contains the column label in the Excel/CSV file, or the imported XML file contains the {addon.label} header.
void	setImportedFile(File importedFile) Sets an imported file to the specified value.
void	setImportForced(boolean importForced) Sets whether all triggers and constraints are disabled in the process of importing data.
void	setImportMode(ImportMode importMode) Sets the import mode.
void	setInvalidDataDownloaded(boolean invalidDataDownloaded) Sets whether all records with errors in their data rows are exported to a downloadable file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orchestranetworks.addon.dex.configuration.ConfigurationSpec

getCurrentDataset, getCurrentTable, getServiceType, getSession, getSourceTableFilters, getSourceTables

Constructor Detail

FileImportConfigurationSpec

public FileImportConfigurationSpec()

Method Detail

isImportForced

public final boolean isImportForced()

Returns true if all triggers and constraints are disabled in the process of importing data.

Specified by:

isImportForced in interface ImportConfigurationSpec<T extends Table>

setImportForced

public final void setImportForced(boolean importForced)

Sets whether all triggers and constraints are disabled in the process of importing data.

getImportMode

public final ImportMode getImportMode()

Returns the specified import mode.

Specified by:

getImportMode in interface ImportConfigurationSpec<T extends Table>

setImportMode

public final void setImportMode(ImportMode importMode)

Sets the import mode.

isEmptyOrNullValueIgnored

public final boolean isEmptyOrNullValueIgnored()

Returns true if all empty or null values are ignored in the process of importing data.

Specified by:

isEmptyOrNullValueIgnored in interface ImportConfigurationSpec<T extends Table>

setEmptyOrNullValueIgnored

public final void setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored)

Sets whether all empty or null values are ignored in the process of importing data.

isEmptyOrNullPrimaryKeyChecked

public final boolean isEmptyOrNullPrimaryKeyChecked()

Returns true if all empty or null primary keys were checked before data import and false if this verification was not performed.

Specified by:

isEmptyOrNullPrimaryKeyChecked in interface ImportConfigurationSpec<T extends Table>

setEmptyOrNullPrimaryKeyChecked

public final void setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked)

Sets whether all empty or null primary keys were checked before data import.

isHeaderUsed

public final boolean isHeaderUsed()

Returns true if the first row of every column in the file contains the column label in the Excel/CSV file, or the imported XML file contains the {addon.label} header.

setHeaderUsed

public final void setHeaderUsed(boolean headerUsed)

Sets whether the first row of every column in the file contains the column label in the Excel/CSV file, or the imported XML file contains the {addon.label} header.

getImportedFile

public final File getImportedFile()

Returns the imported file.

setImportedFile

public final void setImportedFile(File importedFile)

Sets an imported file to the specified value.

isInvalidDataDownloaded

public final boolean isInvalidDataDownloaded()

Returns true if all records with errors in their data rows are exported to a downloadable file.

setInvalidDataDownloaded

public final void setInvalidDataDownloaded(boolean invalidDataDownloaded)

Sets whether all records with errors in their data rows are exported to a downloadable file.

getErrorFilePath

public String getErrorFilePath()

Returns the path of exported file containing invalid data.

setErrorFilePath

public void setErrorFilePath(String errorFilePath)

Sets the path of the exported file containing invalid data.