Class DashboardExportSpec
- java.lang.Object
-
- com.orchestranetworks.addon.dqid.dashboard.AbstractDashboardExportSpec
-
- com.orchestranetworks.addon.dqid.dashboard.DashboardExportSpec
-
public final class DashboardExportSpec extends com.orchestranetworks.addon.dqid.dashboard.AbstractDashboardExportSpec
Contains all required information to export a dashboard.- Since:
- 1.6.0
-
-
Constructor Summary
Constructors Constructor Description DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.AdaptationHome dataspace, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the data space level.DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.Adaptation dataset, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the data set level.DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.AdaptationTable table, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the table level.DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.orchestranetworks.instance.Repository repository, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the repository level, or a dashboard with a dashboard context specified inDashboardConfiguration
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DashboardConfiguration
getDashboardConfiguration()
Returns the dashboard configuration.com.onwbp.adaptation.Adaptation
getDataset()
Returns the target data set.com.onwbp.adaptation.AdaptationHome
getDataspace()
Returns the 'Master data - Reference' data space if a context in the configuration is specified or the dashboard is at the repository level.DashboardExportType
getExportType()
Returns the export type.java.io.File
getPdfFile()
Returns the PDF file after an export.com.orchestranetworks.instance.Repository
getRepository()
Returns the current repository.com.orchestranetworks.service.Session
getSession()
Returns the current session.com.onwbp.adaptation.AdaptationTable
getTable()
Returns the target table.java.io.File
getXmlFile()
Returns the XML file after an export.void
setXmlFile(java.io.File xmlFile)
Specifies an XML file to transform the dashboard to PDF.
-
-
-
Constructor Detail
-
DashboardExportSpec
public DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.orchestranetworks.instance.Repository repository, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the repository level, or a dashboard with a dashboard context specified inDashboardConfiguration
.- Parameters:
exportType
- The output format.dashboardConfiguration
- Contains the dashboard's configuration information.repository
- The current repository.targetFile
- The target file or directory of the export. Currently, XML and PDF formats are supported.session
- The current session.- Throws:
java.lang.IllegalArgumentException
- If one of the parameters isnull
.- See Also:
DashboardExportType
,DashboardConfiguration
-
DashboardExportSpec
public DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.AdaptationHome dataspace, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the data space level.If a dashboard context is specified in
DashboardConfiguration
, it will be used instead.- Parameters:
exportType
- The output format.dashboardConfiguration
- Contains the dashboard's configuration information.dataspace
- The target data space for the dashboard.targetFile
- The target file or directory of the export. Currently, XML and PDF formats are supported.session
- The current session.- Throws:
java.lang.IllegalArgumentException
- If one of the parameters isnull
.- See Also:
DashboardExportType
,DashboardConfiguration
-
DashboardExportSpec
public DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.Adaptation dataset, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the data set level.If a dashboard context is specified in
DashboardConfiguration
, it will be used instead.- Parameters:
exportType
- The output format.dashboardConfiguration
- Contains the dashboard's configuration information.dataset
- The target data set for the dashboard.targetFile
- The target file or directory of the export. Currently, XML and PDF formats are supported.session
- The current session.- Throws:
java.lang.IllegalArgumentException
- If one of the parameters isnull
.- See Also:
DashboardExportType
,DashboardConfiguration
-
DashboardExportSpec
public DashboardExportSpec(DashboardExportType exportType, DashboardConfiguration dashboardConfiguration, com.onwbp.adaptation.AdaptationTable table, java.io.File targetFile, com.orchestranetworks.service.Session session)
The export specification for a dashboard at the table level.If a dashboard context is specified in
DashboardConfiguration
, it will be used instead.- Parameters:
exportType
- The output format.dashboardConfiguration
- Contains the dashboard's configuration information.table
- The target table for the dashboard.targetFile
- The target file or directory of the export. Currently, XML and PDF formats are supported.session
- The current session.- Throws:
java.lang.IllegalArgumentException
- If one of the parameters isnull
.- See Also:
DashboardExportType
,DashboardConfiguration
-
-
Method Detail
-
getExportType
public DashboardExportType getExportType()
Returns the export type.- See Also:
DashboardExportType
-
getDashboardConfiguration
public DashboardConfiguration getDashboardConfiguration()
Returns the dashboard configuration.- See Also:
DashboardConfiguration
-
getSession
public final com.orchestranetworks.service.Session getSession()
Returns the current session.
-
getXmlFile
public java.io.File getXmlFile()
Returns the XML file after an export.Otherwise, returns
null
.
-
setXmlFile
public void setXmlFile(java.io.File xmlFile)
Specifies an XML file to transform the dashboard to PDF.
-
getPdfFile
public java.io.File getPdfFile()
Returns the PDF file after an export.Returns
null
if the export type is notDashboardExportType.DASHBOARD_TO_PDF
or the export is not done.
-
getRepository
public com.orchestranetworks.instance.Repository getRepository()
Returns the current repository.
-
getDataspace
public com.onwbp.adaptation.AdaptationHome getDataspace()
Returns the 'Master data - Reference' data space if a context in the configuration is specified or the dashboard is at the repository level.Otherwise, returns the target data space.
- See Also:
DashboardExportSpec(DashboardExportType, DashboardConfiguration, Repository, File, Session)
,DashboardExportSpec(DashboardExportType, DashboardConfiguration, AdaptationHome, File, Session)
,DashboardExportSpec(DashboardExportType, DashboardConfiguration, Adaptation, File, Session)
,DashboardExportSpec(DashboardExportType, DashboardConfiguration, AdaptationTable, File, Session)
-
getDataset
public com.onwbp.adaptation.Adaptation getDataset()
Returns the target data set.Returns
null
if the context is data space or higher.
-
getTable
public com.onwbp.adaptation.AdaptationTable getTable()
Returns the target table.Returns
null
if the context is data set or higher.
-
-