Class PrepStmtQuerySource
- java.lang.Object
-
- com.inductiveautomation.reporting.gateway.data.queries.PrepStmtQuerySource
-
- All Implemented Interfaces:
QuerySource<PrepStmtQueryConfig>
public class PrepStmtQuerySource extends java.lang.Object implements QuerySource<PrepStmtQueryConfig>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.inductiveautomation.reporting.gateway.api.QuerySource
QuerySource.SubQueryTransaction
-
-
Constructor Summary
Constructors Constructor Description PrepStmtQuerySource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QuerySource.SubQueryTransaction
begin(ReportExecutionContext context, PrepStmtQueryConfig config, java.util.Map<java.lang.String,java.lang.Object> extraConfigs, QueryResults parent)
Begin a nested query "transaction".java.lang.String
getId()
The unique ID for this query source.Dataset
query(ReportExecutionContext execContext, PrepStmtQueryConfig config, java.util.Map<java.lang.String,java.lang.Object> extraConfigs)
Execute a top level query.
-
-
-
Method Detail
-
getId
public java.lang.String getId()
Description copied from interface:QuerySource
The unique ID for this query source. Should be qualified with module name first- Specified by:
getId
in interfaceQuerySource<PrepStmtQueryConfig>
-
query
public Dataset query(ReportExecutionContext execContext, PrepStmtQueryConfig config, java.util.Map<java.lang.String,java.lang.Object> extraConfigs) throws java.lang.Exception
Description copied from interface:QuerySource
Execute a top level query.- Specified by:
query
in interfaceQuerySource<PrepStmtQueryConfig>
- Parameters:
execContext
- The context for the report being executed.config
- The config object which was configured in the designer for this query.extraConfigs
- Extra configuration data the designer may need to send. Unused by most data sources, because the queryConfig should contain all data needed to execute the query. May be null.- Returns:
- A dataset of results for executing this query
- Throws:
java.lang.Exception
-
begin
public QuerySource.SubQueryTransaction begin(ReportExecutionContext context, PrepStmtQueryConfig config, java.util.Map<java.lang.String,java.lang.Object> extraConfigs, QueryResults parent) throws java.lang.Exception
Description copied from interface:QuerySource
Begin a nested query "transaction". This means that a nested query (defined by a single query config) is about to be executed, and will probably be executed many times.- Specified by:
begin
in interfaceQuerySource<PrepStmtQueryConfig>
- Parameters:
context
- The context for the report being executedconfig
- The config object which was configured in designer for this nested query.extraConfigs
- Extra configuration data the designer may need to send. Unused by most data sources, because the queryConfig should contain all data needed to execute the query. May be null.parent
- The QueryResults object for the parent query of this nested query.- Returns:
- A new transaction object to handle the execution of this nested query.
- Throws:
java.lang.Exception
-
-