org.jboss.dashboard.export

Interface ExportManager

public interface ExportManager

Dashboard export manager.

Method Summary

Modifier and Type	Method and Description
ExportOptions	createExportOptions()
String	format(ExportOptions options)
void	format(ExportOptions options, PrintWriter out, int indent)
void	formatDataProviders(ExportOptions options, PrintWriter out, int indent) Formats a set of DataProviders.
void	formatKPIs(ExportOptions options, PrintWriter out, int indent) Formats a set ok KPIs.

Method Detail

createExportOptions

ExportOptions createExportOptions()

format

String format(ExportOptions options)
       throws Exception

Throws:

Exception

format

void format(ExportOptions options,
            PrintWriter out,
            int indent)
     throws Exception

Throws:

Exception

formatKPIs

void formatKPIs(ExportOptions options,
                PrintWriter out,
                int indent)
         throws Exception

Formats a set ok KPIs.

Below is a sample KPI formatted as XML:

<kpi code="kpi_1234999999">
<description language="es">Nota de gastos por departamento</description>
<description language="en">Expense reports by department</description>
<dataprovider code="dataprovider_1234999999" />
<datadisplayer class="org.jboss.dashboard.displayer.chart.BarChartDisplayer">
<barchartdisplayer>
<width>300</width>
<height>200</height>
</barchartdisplayer>
</datadisplayer>
</kpi>

Throws:

Exception

formatDataProviders

void formatDataProviders(ExportOptions options,
                         PrintWriter out,
                         int indent)
                  throws Exception

Formats a set of DataProviders.

Below is a sample DataProvider formatted as XML:

<dataprovider code="dataprovider_1234999999" type="sql">
<description language="es">Notas de gastos</description>
<description language="en">Expense reports</description>
<sqlprovider>
<datasource>local</datasource>
<query>SELECT * from EXPENSE_REPORTS</query>
</sqlprovider>
</dataprovider>

Throws:

Exception