com.orchestranetworks.addon.dex

Class SpreadsheetImportDataExchangeHelperContext

java.lang.Object

com.orchestranetworks.addon.dex.SpreadsheetImportDataExchangeHelperContext

All Implemented Interfaces:

DataExchangeHelperContext

public final class SpreadsheetImportDataExchangeHelperContext
extends Object
implements DataExchangeHelperContext

Provides the context to get the DataExchangeSpec for importing Excel from the configuration declared in the {addon.label} dataset.

Since:

2.7.0

Constructor Summary

Constructors

Constructor and Description
SpreadsheetImportDataExchangeHelperContext(String preferenceName, com.onwbp.adaptation.Adaptation currentDataset, com.orchestranetworks.service.Session session) Creates a new SpreadsheetImportDataExchangeHelperContext using the preference name when importing multiple tables.
SpreadsheetImportDataExchangeHelperContext(String preferenceName, com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session) Creates a new SpreadsheetImportDataExchangeHelperContext using the preference name when importing a single table.

Method Summary

Modifier and Type	Method and Description
com.onwbp.adaptation.Adaptation	getCurrentDataset() Returns the current dataset.
com.onwbp.adaptation.AdaptationTable	getCurrentTable() Returns the current table.
File	getImportedFile() Returns the imported file.
String	getPreferenceName() Returns the specified preference name declared in the Namefield of the Application interface preference table in the {addon.label} dataset.
ServiceType	getServiceType() Returns the specified service type.
com.orchestranetworks.service.Session	getSession() Returns the current session.
void	setImportedFile(File importedFile) Sets an imported file to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetImportDataExchangeHelperContext

public SpreadsheetImportDataExchangeHelperContext(String preferenceName,
                                                  com.onwbp.adaptation.AdaptationTable currentTable,
                                                  com.orchestranetworks.service.Session session)

Creates a new SpreadsheetImportDataExchangeHelperContext using the preference name when importing a single table.

Parameters:

preferenceName - the preference name is declared in Name field of the Application interface preference table in the {addon.label} dataset.

currentTable - the current table.

session - the current session.

SpreadsheetImportDataExchangeHelperContext

public SpreadsheetImportDataExchangeHelperContext(String preferenceName,
                                                  com.onwbp.adaptation.Adaptation currentDataset,
                                                  com.orchestranetworks.service.Session session)

Creates a new SpreadsheetImportDataExchangeHelperContext using the preference name when importing multiple tables.

Parameters:

preferenceName - the preference name is declared in Namefield of the Application interface preference table in the {addon.label} dataset.

currentDataset - the current dataset.

session - the current session.

Method Detail

getCurrentDataset

public com.onwbp.adaptation.Adaptation getCurrentDataset()

Returns the current dataset.

Specified by:

getCurrentDataset in interface DataExchangeHelperContext

getCurrentTable

public com.onwbp.adaptation.AdaptationTable getCurrentTable()

Returns the current table.

Specified by:

getCurrentTable in interface DataExchangeHelperContext

getSession

public com.orchestranetworks.service.Session getSession()

Returns the current session.

Specified by:

getSession in interface DataExchangeHelperContext

getServiceType

public ServiceType getServiceType()

Returns the specified service type.

Specified by:

getServiceType in interface DataExchangeHelperContext

getPreferenceName

public String getPreferenceName()

Returns the specified preference name declared in the Namefield of the Application interface preference table in the {addon.label} dataset.

getImportedFile

public File getImportedFile()

Returns the imported file.

setImportedFile

public void setImportedFile(File importedFile)

Sets an imported file to the specified value.