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 java.lang.Object implements ImportConfigurationSpec<T>
Specifies the configuration used when importing data from a file.- Since:
- 2.3.0
-
-
Constructor Summary
Constructors Constructor Description FileImportConfigurationSpec()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getErrorFilePath()
Returns the path of exported file containing invalid data.java.io.File
getImportedFile()
Returns the imported file.ImportMode
getImportMode()
Returns the specified import mode.boolean
isEmptyOrNullPrimaryKeyChecked()
Returnstrue
if all empty ornull
primary keys were checked before data import andfalse
if this verification was not performed.boolean
isEmptyOrNullValueIgnored()
Returnstrue
if all empty ornull
values are ignored in the process of importing data.boolean
isHeaderUsed()
Returnstrue
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()
Returnstrue
if all triggers and constraints are disabled in the process of importing data.boolean
isInvalidDataDownloaded()
Returnstrue
if all records with errors in their data rows are exported to a downloadable file.void
setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked)
Sets whether all empty ornull
primary keys were checked before data import.void
setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored)
Sets whether all empty ornull
values are ignored in the process of importing data.void
setErrorFilePath(java.lang.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(java.io.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
-
-
-
-
Method Detail
-
isImportForced
public final boolean isImportForced()
Returnstrue
if all triggers and constraints are disabled in the process of importing data.- Specified by:
isImportForced
in interfaceImportConfigurationSpec<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 interfaceImportConfigurationSpec<T extends Table>
-
setImportMode
public final void setImportMode(ImportMode importMode)
Sets the import mode.
-
isEmptyOrNullValueIgnored
public final boolean isEmptyOrNullValueIgnored()
Returnstrue
if all empty ornull
values are ignored in the process of importing data.- Specified by:
isEmptyOrNullValueIgnored
in interfaceImportConfigurationSpec<T extends Table>
-
setEmptyOrNullValueIgnored
public final void setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored)
Sets whether all empty ornull
values are ignored in the process of importing data.
-
isEmptyOrNullPrimaryKeyChecked
public final boolean isEmptyOrNullPrimaryKeyChecked()
Returnstrue
if all empty ornull
primary keys were checked before data import andfalse
if this verification was not performed.- Specified by:
isEmptyOrNullPrimaryKeyChecked
in interfaceImportConfigurationSpec<T extends Table>
-
setEmptyOrNullPrimaryKeyChecked
public final void setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked)
Sets whether all empty ornull
primary keys were checked before data import.
-
isHeaderUsed
public final boolean isHeaderUsed()
Returnstrue
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 java.io.File getImportedFile()
Returns the imported file.
-
setImportedFile
public final void setImportedFile(java.io.File importedFile)
Sets an imported file to the specified value.
-
isInvalidDataDownloaded
public final boolean isInvalidDataDownloaded()
Returnstrue
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 java.lang.String getErrorFilePath()
Returns the path of exported file containing invalid data.
-
setErrorFilePath
public void setErrorFilePath(java.lang.String errorFilePath)
Sets the path of the exported file containing invalid data.
-
-