com.orchestranetworks.addon.dex.configuration

Class SpreadsheetExportConfigurationSpec

java.lang.Object

com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec

com.orchestranetworks.addon.dex.configuration.SpreadsheetExportConfigurationSpec

All Implemented Interfaces:

ConfigurationSpec<EBXTable>, ExportConfigurationSpec<EBXTable>

public final class SpreadsheetExportConfigurationSpec
extends FileExportConfigurationSpec

Specifies the configuration used to export data to an Excel file.

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, Map<EBXTable,TableFilter> sourceTableFilters, com.orchestranetworks.service.Session session)
SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, com.orchestranetworks.service.Session session)
SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session)
SpreadsheetExportConfigurationSpec(EBXTable sourceTable, TableFilter tableFilter, com.orchestranetworks.service.Session session)
SpreadsheetExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext)

Method Summary

Modifier and Type	Method and Description
String	getBaseURL() Returns the base URL for fetching a link to a record.
SpreadsheetFileFormat	getFileFormat() Returns the Excel file format.
ServiceType	getServiceType() Returns the service type.
Set<com.onwbp.base.text.Severity>	getSeveritiesOfValidationMessages() Returns validation message severity levels.
Map<EBXTable,TableFilter>	getSourceTableFilters() Returns a map of table filters and an EBXTable instance as the key parameter.
List<EBXTable>	getSourceTables() Returns the list of source tables.
SpreadsheetExportTemplate	getSpreadsheetTemplate() Returns a SpreadsheetExportTemplate instance to represent a spreadsheet template.
boolean	isEnumerationLabelExported() Returns true if the exported file will contain an information column with the label of the enumeration.
boolean	isEnumerationsExported() Returns true if the exported file will contain enumerations matching the one in the data model.
boolean	isForeignKeyLabelExported() Returns true if the exported file contains an information column with the label of the foreign key.
boolean	isForeignKeyPermalinkExported() Returns true if the exported file will contain the permalink for the foreign key.
boolean	isIgnoredFieldExported() Returns true if the ignored field is exported as a blank column.
boolean	isPrimaryKeyLabelExported() Returns true if the exported file contains an information column with the label of the primary key.
boolean	isPrimaryKeyPermalinkExported() Returns true if the exported file will contain the permalink for the primary key.
boolean	isReferenceSheetIncluded() Returns true if a reference sheet called 'Reference table mapping' is added at the end of the Excel file.
void	setBaseURL(String baseURL) Sets the base URL for fetching a link to a record.
void	setEnumerationLabelExported(boolean enumerationLabelExported) Sets whether the exported file will contain an information column with the label of the enumeration.
void	setEnumerationsExported(boolean enumerationsExported) Sets whether the exported file will contain enumerations matching the one in the data model.
void	setFileFormat(SpreadsheetFileFormat fileFormat) Sets the Excel file format.
void	setForeignKeyLabelExported(boolean foreignKeyLabelExported) Sets whether the exported file contains an information column with the label of the foreign key.
void	setForeignKeyPermalinkExported(boolean foreignKeyPermalinkExported) Sets whether the exported file will contain the permalink for the foreign key.
void	setIgnoredFieldExported(boolean ignoredFieldExported) Sets whether the ignored field is exported as a blank column.
void	setPrimaryKeyLabelExported(boolean primaryKeyLabelExported) Sets whether the exported file contains an information column with the label of the primary key.
void	setPrimaryKeyPermalinkExported(boolean primaryKeyPermalinkExported) Sets whether the exported file will contain the permalink for the primary key.
void	setReferenceSheetIncluded(boolean referenceSheetIncluded) Sets whether a reference sheet called 'Reference table mapping' is added at the end of the Excel file.
void	setSeveritiesOfValidationMessages(Set<com.onwbp.base.text.Severity> severitiesOfValidationMessages) Sets validation message severity levels.
void	setSpreadsheetTemplate(SpreadsheetExportTemplate spreadsheetTemplate) Sets a SpreadsheetExportTemplate instance to represent a spreadsheet template.

Methods inherited from class com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec

getCurrentDataset, getCurrentTable, getLocale, getSession, isComputedValueIncluded, isDataFromReferencedTablesExported, isDataReferencingSelectedRecordExported, isHeaderExported, isWriteAccessLockDisabled, setComputedValueIncluded, setDataFromReferencedTablesExported, setDataReferencingSelectedRecordExported, setHeaderExported, setLocale, setWriteAccessLockDisabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetExportConfigurationSpec

public SpreadsheetExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext)
                                   throws DataExchangeException

Throws:

DataExchangeException

SpreadsheetExportConfigurationSpec

public SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
                                          com.orchestranetworks.service.Session session)
                                   throws DataExchangeException

Throws:

DataExchangeException

SpreadsheetExportConfigurationSpec

public SpreadsheetExportConfigurationSpec(EBXTable sourceTable,
                                          TableFilter tableFilter,
                                          com.orchestranetworks.service.Session session)
                                   throws DataExchangeException

Throws:

DataExchangeException

SpreadsheetExportConfigurationSpec

public SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset,
                                          List<EBXTable> sourceTables,
                                          com.orchestranetworks.service.Session session)
                                   throws DataExchangeException

Throws:

DataExchangeException

SpreadsheetExportConfigurationSpec

public SpreadsheetExportConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset,
                                          List<EBXTable> sourceTables,
                                          Map<EBXTable,TableFilter> sourceTableFilters,
                                          com.orchestranetworks.service.Session session)
                                   throws DataExchangeException

Throws:

DataExchangeException

Method Detail

getServiceType

public ServiceType getServiceType()

Returns the service type.

isPrimaryKeyLabelExported

public boolean isPrimaryKeyLabelExported()

Returns true if the exported file contains an information column with the label of the primary key.

setPrimaryKeyLabelExported

public void setPrimaryKeyLabelExported(boolean primaryKeyLabelExported)

Sets whether the exported file contains an information column with the label of the primary key.

isForeignKeyLabelExported

public boolean isForeignKeyLabelExported()

Returns true if the exported file contains an information column with the label of the foreign key.

setForeignKeyLabelExported

public void setForeignKeyLabelExported(boolean foreignKeyLabelExported)

Sets whether the exported file contains an information column with the label of the foreign key.

isPrimaryKeyPermalinkExported

public boolean isPrimaryKeyPermalinkExported()

Returns true if the exported file will contain the permalink for the primary key. The permalink is only set if the export is executed within a UIService.

setPrimaryKeyPermalinkExported

public void setPrimaryKeyPermalinkExported(boolean primaryKeyPermalinkExported)

Sets whether the exported file will contain the permalink for the primary key. The permalink is only set if the export is executed within a UIService.

isForeignKeyPermalinkExported

public boolean isForeignKeyPermalinkExported()

Returns true if the exported file will contain the permalink for the foreign key. The permalink is only set if the export is executed within a UIService.

setForeignKeyPermalinkExported

public void setForeignKeyPermalinkExported(boolean foreignKeyPermalinkExported)

Sets whether the exported file will contain the permalink for the foreign key. The permalink is only set if the export is executed within a UIService.

getFileFormat

public SpreadsheetFileFormat getFileFormat()

Returns the Excel file format.

setFileFormat

public void setFileFormat(SpreadsheetFileFormat fileFormat)

Sets the Excel file format.

isReferenceSheetIncluded

public boolean isReferenceSheetIncluded()

Returns true if a reference sheet called 'Reference table mapping' is added at the end of the Excel file. This sheet contains metadata such as the sheet name, the table label and the table path used to detect the mapping between sheets and tables upon import. This option is only activated when exporting multiple tables to an Excel file.

setReferenceSheetIncluded

public void setReferenceSheetIncluded(boolean referenceSheetIncluded)

Sets whether a reference sheet called 'Reference table mapping' is added at the end of the Excel file. This sheet contains metadata such as the sheet name, the table label and the table path used to detect the mapping between sheets and tables upon import. This option is only activated when exporting multiple tables to an Excel file.

isEnumerationsExported

public boolean isEnumerationsExported()

Returns true if the exported file will contain enumerations matching the one in the data model. Warning: this can increase the file size.

setEnumerationsExported

public void setEnumerationsExported(boolean enumerationsExported)

Sets whether the exported file will contain enumerations matching the one in the data model. Warning: this can increase the file size.

getSpreadsheetTemplate

public SpreadsheetExportTemplate getSpreadsheetTemplate()

Returns a SpreadsheetExportTemplate instance to represent a spreadsheet template.

setSpreadsheetTemplate

public void setSpreadsheetTemplate(SpreadsheetExportTemplate spreadsheetTemplate)

Sets a SpreadsheetExportTemplate instance to represent a spreadsheet template.

getSourceTables

public List<EBXTable> getSourceTables()

Returns the list of source tables.

getSourceTableFilters

public Map<EBXTable,TableFilter> getSourceTableFilters()

Returns a map of table filters and an EBXTable instance as the key parameter. Returns null when importing CSV, Excel and XML.

getBaseURL

public String getBaseURL()

Returns the base URL for fetching a link to a record.

setBaseURL

public void setBaseURL(String baseURL)

Sets the base URL for fetching a link to a record.

isIgnoredFieldExported

public boolean isIgnoredFieldExported()

Returns true if the ignored field is exported as a blank column. Otherwise, the ignored field will not be exported.

Since:

2.4.0

setIgnoredFieldExported

public void setIgnoredFieldExported(boolean ignoredFieldExported)

Sets whether the ignored field is exported as a blank column.

Since:

2.4.0

getSeveritiesOfValidationMessages

public Set<com.onwbp.base.text.Severity> getSeveritiesOfValidationMessages()

Returns validation message severity levels. (Does not support com.onwbp.base.text.Severity.FATAL). If the severity of the messages is com.onwbp.base.text.Severity.INFO, the exported file includes information messages. If the severity of the messages is com.onwbp.base.text.Severity.WARNING, the exported file includes warning messages. If the severity of the messages is com.onwbp.base.text.Severity.ERROR, the exported file includes error messages.

Since:

2.5.0

setSeveritiesOfValidationMessages

public void setSeveritiesOfValidationMessages(Set<com.onwbp.base.text.Severity> severitiesOfValidationMessages)

Sets validation message severity levels. (Do not support com.onwbp.base.text.Severity.FATAL). If the severity of the messages is com.onwbp.base.text.Severity.INFO, the exported file includes information messages. If the severity of the messages is com.onwbp.base.text.Severity.WARNING, the exported file includes warning messages. If the severity of the messages is com.onwbp.base.text.Severity.ERROR, the exported file includes error messages.

Since:

2.5.0

isEnumerationLabelExported

public boolean isEnumerationLabelExported()

Returns true if the exported file will contain an information column with the label of the enumeration.

Since:

2.6.3

setEnumerationLabelExported

public void setEnumerationLabelExported(boolean enumerationLabelExported)

Sets whether the exported file will contain an information column with the label of the enumeration.

Since:

2.6.3