Package com.orchestranetworks.addon.dint.template

Class ExcelImportTemplateSpec

java.lang.Object

com.orchestranetworks.addon.dint.template.TemplateSpec<ST,TT>

com.orchestranetworks.addon.dint.template.ImportExportTemplateSpec<ExcelSourceTable,EBXTargetTable>

com.orchestranetworks.addon.dint.template.ExcelImportTemplateSpec

All Implemented Interfaces:

com.orchestranetworks.addon.dint.dataconnector.spec.InvalidDataExcelFileValidator

public final class ExcelImportTemplateSpec
extends ImportExportTemplateSpec<ExcelSourceTable,EBXTargetTable>
implements com.orchestranetworks.addon.dint.dataconnector.spec.InvalidDataExcelFileValidator

Template specification for Excel import.

Since:

4.1.0

Constructor Summary

Constructors

Constructor	Description
ExcelImportTemplateSpec(TemplateConfig<ExcelSourceTable,EBXTargetTable> templateConfig, java.io.File sourceFile, com.orchestranetworks.service.Session session)
ExcelImportTemplateSpec(java.lang.String templateId, java.io.File sourceFile, com.orchestranetworks.service.Session session)	Constructs a new ExcelImportTemplateSpec instance.
ExcelImportTemplateSpec(java.lang.String templateId, java.io.File sourceFile, java.lang.String sheetName, com.orchestranetworks.service.Session session)	Deprecated. Use ExcelImportTemplateSpec(String, File, Session) instead.

Method Summary

Modifier and Type	Method	Description
void	configureProcedure(java.util.function.Consumer<com.orchestranetworks.service.ProcedureContext> config)	Configures the ProcedureContext instance when writing in EBX.
java.io.File	getInvalidDataFile()	Returns the file that contains invalid records.
java.util.function.Consumer<com.orchestranetworks.service.ProcedureContext>	getProcedureConfig()	Returns the ProcedureContext configuration or null.
java.lang.String	getSheetName()	Deprecated. Since 4.3.2, it's no longer required to specify a sheet name.
java.io.File	getSourceFile()	Returns the source Excel file.
void	setInvalidDataFile(java.io.File invalidDataFile)	Sets the file that contains invalid records.

Methods inherited from class com.orchestranetworks.addon.dint.template.ImportExportTemplateSpec

getDataset, setDataset

Methods inherited from class com.orchestranetworks.addon.dint.template.TemplateSpec

getSession, getTemplateConfig, getTemplateId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orchestranetworks.addon.dint.dataconnector.spec.InvalidDataExcelFileValidator

validate

Constructor Detail

ExcelImportTemplateSpec

@Deprecated
public ExcelImportTemplateSpec(java.lang.String templateId,
                               java.io.File sourceFile,
                               java.lang.String sheetName,
                               com.orchestranetworks.service.Session session)

Deprecated.

Use ExcelImportTemplateSpec(String, File, Session) instead. Since v4.3.2, it's no longer required to specify a sheet name.

Constructs a new ExcelImportTemplateSpec instance.

Parameters:

templateId - The unique template id.

sourceFile - The source Excel file.

sheetName - The sheet name of the Excel file.

session - The session.

Throws:

java.lang.IllegalArgumentException - If any parameter is null or source file does not exist.

ExcelImportTemplateSpec

public ExcelImportTemplateSpec(java.lang.String templateId,
                               java.io.File sourceFile,
                               com.orchestranetworks.service.Session session)

Constructs a new ExcelImportTemplateSpec instance.

Parameters:

templateId - The unique template id.

sourceFile - The source Excel file.

session - The session.

Throws:

java.lang.IllegalArgumentException - If any parameter is null or the source file does not exist.

Since:

4.3.2

ExcelImportTemplateSpec

public ExcelImportTemplateSpec(TemplateConfig<ExcelSourceTable,EBXTargetTable> templateConfig,
                               java.io.File sourceFile,
                               com.orchestranetworks.service.Session session)

Method Detail

getSourceFile

public java.io.File getSourceFile()

Returns the source Excel file.

getSheetName

@Deprecated
public java.lang.String getSheetName()

Deprecated.

Since 4.3.2, it's no longer required to specify a sheet name.

Returns the sheet name.

configureProcedure

public void configureProcedure(java.util.function.Consumer<com.orchestranetworks.service.ProcedureContext> config)

Configures the ProcedureContext instance when writing in EBX.

Since:

4.5.0

See Also:

Procedure.execute(ProcedureContext)

getProcedureConfig

public java.util.function.Consumer<com.orchestranetworks.service.ProcedureContext> getProcedureConfig()

Returns the ProcedureContext configuration or null.

Since:

4.5.0

See Also:

Procedure.execute(ProcedureContext)

getInvalidDataFile

public java.io.File getInvalidDataFile()

Returns the file that contains invalid records.

Since:

4.5.0

setInvalidDataFile

public void setInvalidDataFile(java.io.File invalidDataFile)

Sets the file that contains invalid records.

Since:

4.5.0