com.inet.report.database

Interface DataFactory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BaseDataFactory, Database, JdbcData

public interface DataFactory
extends java.io.Serializable

This interface is a layer between a your DBMS or any other data source and i-net Clear Reports. It compensates the differences between the different DBMS.

Since:

13.0

Method Summary

Modifier and Type	Method and Description
void	fetchData(Engine engine, FetchTables fetchTables, DataCollector collector) Fetches the part of the report data for which this data factory is responsible.
java.util.List<ColumnInfo>	getColumns(TableSource ts) Returns the column information for a TableSource
com.inet.report.DatabaseConfiguration	getConfiguration() Returns the DatabaseConfiguration of this DataFactory.
boolean	getReportDataPerInstance() Override this method only if you use subreport(s) and you set the data for the report with the getReportData or fetchData(Engine, FetchTables, DataCollector) method.
TableData	getTableSourceData(TableSource ts) Is called from getReportData to request the data of a single TableSource if the TableSource is not a joined table or view.
java.util.Map<java.lang.String,TableSourceInfo>	getTableSourceInfos(Datasource ds, java.lang.String catalog) Returns a map of objects in the database which can return table data.
void	setConfiguration(com.inet.report.DatabaseConfiguration configuration) Sets the DatabaseConfiguration for this DataFactory. this is calling from the runtime after creating.

Method Detail

getReportDataPerInstance

boolean getReportDataPerInstance()

Override this method only if you use subreport(s) and you set the data for the report with the getReportData or fetchData(Engine, FetchTables, DataCollector) method. For more information please refer to the sample Main_and_Subreport_Data_WithExternalResultSet.java.
With this method you can specify whether the engine should call getReportData per subreport instance or only once for each of the subreports in the executed report. The same subreport can execute multiple time in a report with different parameters depending on its location. A subreport instance means one execution of one subreport. The method should return true if you want to set the different report data depending on the state of the report or if you want to set data depending on one or more parameter values. If you want to set data only once per sub-report, this function must return false. For example if you have a sub-report taking one prompt p0, and getReportDataPerInstance() returns true, then your sub-report will be called $n$ times whenever the value for p0 has been changed. So if your report has sub-reports and your sub-report prompts are linked with fields of the main report and you want to set the data whenever the sub-report prompts change, let getReportDataPerInstance() return true.

Returns:

true if the engine should invoke getReportData for every subreport instance or false otherwise.

Since:

13.0

getTableSourceData

@Nonnull
TableData getTableSourceData(@Nonnull
                                       TableSource ts)
                                throws ReportException

Is called from getReportData to request the data of a single TableSource if the TableSource is not a joined table or view. So it's called for procedures, commands and single tables or views.

Parameters:

ts - The current table source

Returns:

The resulting data, never null.

Throws:

ReportException - if error occurs in the API access

Since:

13.0

getTableSourceInfos

@Nonnull
java.util.Map<java.lang.String,TableSourceInfo> getTableSourceInfos(@Nonnull
                                                                              Datasource ds,
                                                                              java.lang.String catalog)
                                                                       throws ReportException

Returns a map of objects in the database which can return table data. It can contain tables, views, stored procedures or your own objects. Keys of the returned map are table names and values are objects of type TableSourceInfo.

Parameters:

ds - datasource which describes the data

catalog - an optional catalog

Returns:

a map of available objects, never null

Throws:

ReportException - if any error occurs

Since:

13.0

getColumns

@Nonnull
java.util.List<ColumnInfo> getColumns(@Nonnull
                                                TableSource ts)
                                         throws ReportException

Returns the column information for a TableSource

Parameters:

ts - the table source to get the data for

Returns:

A list with column information, can be empty but not null

Throws:

ReportException - if any error occurs

Since:

15.0

setConfiguration

void setConfiguration(@Nonnull
                      com.inet.report.DatabaseConfiguration configuration)

Sets the DatabaseConfiguration for this DataFactory. this is calling from the runtime after creating.

Parameters:

configuration - the current configuration

Since:

13.0

getConfiguration

com.inet.report.DatabaseConfiguration getConfiguration()

Returns the DatabaseConfiguration of this DataFactory.

Returns:

the DatabaseConfiguration

Since:

13.0

fetchData

void fetchData(@Nonnull
               Engine engine,
               @Nonnull
               FetchTables fetchTables,
               @Nonnull
               DataCollector collector)
        throws ReportException

Fetches the part of the report data for which this data factory is responsible. A description about what tables are required to fetch is given in the specified FetchTables instance. The resulting fetched data is put to the specified DataCollector during execution of this method.

An example implementation for this method:

 for( TableSource tableSource : fetchDef.getTableSources() ) {
     TableData tableData;
     
      // retrieve data for table source "tableSource"
     tableData = [...]
     
     // deliver the data to the collector:
     collector.addUnjoinedData( tableSource, tableData );
 }
 

Parameters:

engine - the engine of the report to render

fetchTables - a model of joining table describing the data this data factory needs to deliver

collector - the collector which receives any resulting data

Throws:

ReportException - on failures during data fetching

Since:

15.0