Class SpreadsheetExportConfigurationSpec
java.lang.Object
com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec
com.orchestranetworks.addon.dex.configuration.SpreadsheetExportConfigurationSpec
- All Implemented Interfaces:
ConfigurationSpec<EBXTable>
,ExportConfigurationSpec<EBXTable>
Specifies the configuration used to export data to an Excel file.
- Since:
- 2.3.0
-
Constructor Summary
ConstructorsConstructorDescriptionSpreadsheetExportConfigurationSpec
(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, com.orchestranetworks.service.Session session) SpreadsheetExportConfigurationSpec
(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, Map<EBXTable, TableFilter> sourceTableFilters, 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 TypeMethodDescriptionReturns the base URL for fetching a link to a record.Returns the Excel file format.Returns the service type.Set<com.onwbp.base.text.Severity>
Returns validation message severity levels.Returns a map of table filters and anEBXTable
instance as the key parameter.Returns the list of source tables.Returns aSpreadsheetExportTemplate
instance to represent a spreadsheet template.boolean
Returnstrue
if the exported file will contain an information column with the label of the enumeration.boolean
Returnstrue
if the exported file will contain enumerations matching the one in the data model.boolean
Returnstrue
if the exported file contains an information column with the label of the foreign key.boolean
Returnstrue
if the exported file will contain the permalink for the foreign key.boolean
Returnstrue
if the ignored field is exported as a blank column.boolean
Returnstrue
if the exported file contains an information column with the label of the primary key.boolean
Returnstrue
if the exported file will contain the permalink for the primary key.boolean
Returnstrue
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 aSpreadsheetExportTemplate
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
-
Constructor Details
-
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 Details
-
getServiceType
Returns the service type. -
isPrimaryKeyLabelExported
public boolean isPrimaryKeyLabelExported()Returnstrue
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()Returnstrue
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()Returnstrue
if the exported file will contain the permalink for the primary key. The permalink is only set if the export is executed within aUIService
. -
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 aUIService
. -
isForeignKeyPermalinkExported
public boolean isForeignKeyPermalinkExported()Returnstrue
if the exported file will contain the permalink for the foreign key. The permalink is only set if the export is executed within aUIService
. -
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 aUIService
. -
getFileFormat
Returns the Excel file format. -
setFileFormat
Sets the Excel file format. -
isReferenceSheetIncluded
public boolean isReferenceSheetIncluded()Returnstrue
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()Returnstrue
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
Returns aSpreadsheetExportTemplate
instance to represent a spreadsheet template. -
setSpreadsheetTemplate
Sets aSpreadsheetExportTemplate
instance to represent a spreadsheet template. -
getSourceTables
Returns the list of source tables. -
getSourceTableFilters
Returns a map of table filters and anEBXTable
instance as the key parameter. Returnsnull
when importing CSV, Excel and XML. -
getBaseURL
Returns the base URL for fetching a link to a record. -
setBaseURL
Sets the base URL for fetching a link to a record. -
isIgnoredFieldExported
public boolean isIgnoredFieldExported()Returnstrue
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
Returns validation message severity levels. (Does not supportcom.onwbp.base.text.Severity.FATAL
). If the severity of the messages iscom.onwbp.base.text.Severity.INFO
, the exported file includes information messages. If the severity of the messages iscom.onwbp.base.text.Severity.WARNING
, the exported file includes warning messages. If the severity of the messages iscom.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 supportcom.onwbp.base.text.Severity.FATAL
). If the severity of the messages iscom.onwbp.base.text.Severity.INFO
, the exported file includes information messages. If the severity of the messages iscom.onwbp.base.text.Severity.WARNING
, the exported file includes warning messages. If the severity of the messages iscom.onwbp.base.text.Severity.ERROR
, the exported file includes error messages.- Since:
- 2.5.0
-
isEnumerationLabelExported
public boolean isEnumerationLabelExported()Returnstrue
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
-