Package com.orchestranetworks.addon.dex.configuration

Class XMLExportConfigurationSpec

java.lang.Object

com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec

com.orchestranetworks.addon.dex.configuration.XMLExportConfigurationSpec

All Implemented Interfaces:

ConfigurationSpec<EBXTable>, ExportConfigurationSpec<EBXTable>

public final class XMLExportConfigurationSpec
extends FileExportConfigurationSpec

Specifies the configuration used when exporting data to an XML file.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
XMLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session)	Exports a table and is used outside of a UIService.
XMLExportConfigurationSpec(EBXTable sourceTable, TableFilter tableFilter, com.orchestranetworks.service.Session session)	Exports a table with filter and is used outside of a UIService.
XMLExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext)	Uses within a UIService.

Method Summary

Modifier and Type	Method	Description
ServiceType	getServiceType()	Returns the service type.
java.util.Map<EBXTable,TableFilter>	getSourceTableFilters()	Returns a map of table filters and an EBXTable instance as the key parameter.
java.util.List<EBXTable>	getSourceTables()	Returns the list of source tables.
java.lang.String	getTargetVersion()	Returns the target application version.
boolean	isDefaultXML()	Returns true if data are exported using the default configuration.
boolean	isXMLCommentOmitted()	Returns true if the exported XML file omits comments.
boolean	isXMLIndented()	Returns true if the exported XML file indents lines.
void	setDefaultXML(boolean defaultXML)	Sets whether data are exported using the default configuration.
void	setTargetVersion(java.lang.String targetVersion)	Sets the version for the target application.
void	setXMLCommentOmitted(boolean xmlCommentOmitted)	Sets whether to omit XML comments from the exported XML file.
void	setXMLIndented(boolean xmlIndented)	Sets whether lines are indented in the exported XML file.

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

XMLExportConfigurationSpec

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

Uses within a UIService.

Throws:

DataExchangeException

XMLExportConfigurationSpec

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

Exports a table and is used outside of a UIService.

Throws:

DataExchangeException

XMLExportConfigurationSpec

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

Exports a table with filter and is used outside of a UIService.

Throws:

DataExchangeException

Method Detail

isXMLIndented

public boolean isXMLIndented()

Returns true if the exported XML file indents lines.

setXMLIndented

public void setXMLIndented(boolean xmlIndented)

Sets whether lines are indented in the exported XML file.

isXMLCommentOmitted

public boolean isXMLCommentOmitted()

Returns true if the exported XML file omits comments.

setXMLCommentOmitted

public void setXMLCommentOmitted(boolean xmlCommentOmitted)

Sets whether to omit XML comments from the exported XML file.

getTargetVersion

public java.lang.String getTargetVersion()

Returns the target application version.

setTargetVersion

public void setTargetVersion(java.lang.String targetVersion)

Sets the version for the target application.

getServiceType

public ServiceType getServiceType()

Returns the service type.

isDefaultXML

public boolean isDefaultXML()

Returns true if data are exported using the default configuration.

setDefaultXML

public void setDefaultXML(boolean defaultXML)

Sets whether data are exported using the default configuration.

getSourceTables

public java.util.List<EBXTable> getSourceTables()

Returns the list of source tables.

getSourceTableFilters

public java.util.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.