Class QueryReportDataSource
- java.lang.Object
-
- com.inductiveautomation.reporting.gateway.data.QueryReportDataSource
-
- All Implemented Interfaces:
ReportDataSource
public class QueryReportDataSource extends java.lang.Object implements ReportDataSource
Created by carl.gould on 3/5/2015.
-
-
Constructor Summary
Constructors Constructor Description QueryReportDataSource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
gatherData(ReportExecutionContext execContext, java.io.Serializable configObject, java.util.Map<java.lang.String,java.lang.Object> extraConfigs)
Called when a report is being executed to gather the data represented by this data source.java.lang.String
getId()
Return the unique ID for this data source.
-
-
-
Method Detail
-
getId
public java.lang.String getId()
Description copied from interface:ReportDataSource
Return the unique ID for this data source. Should be qualified, such as com.example.data-source-type. Must match the ID returned by your DataSourceConfigFactory in the designer scope.- Specified by:
getId
in interfaceReportDataSource
-
gatherData
public void gatherData(ReportExecutionContext execContext, java.io.Serializable configObject, java.util.Map<java.lang.String,java.lang.Object> extraConfigs) throws java.lang.Exception
Description copied from interface:ReportDataSource
Called when a report is being executed to gather the data represented by this data source. This method is high re-entrant. A given data source instance will be used for concurrently executing reports. This method must inject the data it gathers into the data map.- Specified by:
gatherData
in interfaceReportDataSource
- Parameters:
execContext
- This context holds the data map for the report, as well as other information about the report, its project, logging context, status feedback, etc.configObject
- The object that was saved for this data source in the designer.extraConfigs
- Any extra info datasources might need when running. Will be null if not sample data. It's up to the datasource to decide what object(s) from this map it wants. Key is the datasource id.- Throws:
java.lang.Exception
-
-