Package com.inductiveautomation.reporting.gateway.scheduler

Class ReportSchedulerTask

java.lang.Object

com.inductiveautomation.reporting.gateway.scheduler.ReportSchedulerTask

All Implemented Interfaces:

java.lang.Runnable

public class ReportSchedulerTask
extends java.lang.Object
implements java.lang.Runnable

Filename: ReportSchedulerTask.java Created on Feb 06, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: Reporting

This class creates a task that is used by the cron4j scheduler when the schedule is active. The task gets the data for a report, creates the report, and then sends it to all the distributions for this schedule. The constructor takes the entire ReportResource, but also needs the particular ReportSchedule, since there can be more than one for the resource.

Constructor Summary

Constructors

Constructor	Description
ReportSchedulerTask(GatewayContext context, java.lang.String projectName, ReportResource reportResource, ReportSchedule reportSchedule, java.lang.String reportName, java.lang.String reportPath)

Method Summary

Modifier and Type	Method	Description
static AbstractReportAction	createReportDistributionAction(GatewayContext context, ReportExecutionContext reportExecutionContext, java.lang.String projectName, java.lang.String actionId)
void	run()
java.util.List<java.lang.String>	runImmediate(AbstractReportActionConfig config)
java.util.List<java.lang.String>	runImmediate(AbstractReportActionConfig config, java.util.Map<java.lang.String,java.lang.Object> parameterData)
void	setIsScheduledTask(boolean isScheduledTask)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportSchedulerTask

public ReportSchedulerTask(GatewayContext context,
                           java.lang.String projectName,
                           ReportResource reportResource,
                           ReportSchedule reportSchedule,
                           java.lang.String reportName,
                           java.lang.String reportPath)

Parameters:

reportSchedule - - the particular schedule we're scheduling. (The reportResource contains multiple schedules.)

reportName - - used for logging and parameters

reportPath - - used for logging and parameters

Method Detail

createReportDistributionAction

@Nonnull
public static AbstractReportAction createReportDistributionAction(GatewayContext context,
                                                                  ReportExecutionContext reportExecutionContext,
                                                                  java.lang.String projectName,
                                                                  java.lang.String actionId)

setIsScheduledTask

public void setIsScheduledTask(boolean isScheduledTask)

run

public void run()

Specified by:

run in interface java.lang.Runnable

runImmediate

public java.util.List<java.lang.String> runImmediate(AbstractReportActionConfig config)

runImmediate

public java.util.List<java.lang.String> runImmediate(AbstractReportActionConfig config,
                                                     java.util.Map<java.lang.String,java.lang.Object> parameterData)