com.inductiveautomation.reporting.gateway

Class ReportStatusManager

java.lang.Object

com.inductiveautomation.reporting.gateway.ReportStatusManager

public class ReportStatusManager
extends java.lang.Object

Filename: ReportStatusManager.java Created on Apr 02, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: Reporting Keeps track of what reports are currently executing and the last execution time for any report executed since the Gateway last started.

Constructor Summary

Constructors

Constructor and Description
ReportStatusManager(GatewayContext context)

Method Summary

Modifier and Type	Method and Description
void	cancel(java.util.UUID uuid)
void	finish(ReportExecutionContext reportExecutionContext) Call this when report execution is finished to save last execution time and remove the report from the current execution map.
java.util.List<ReportExecutionContext>	getCurrentReportContexts()
java.util.List<ReportExecutionContext>	getCurrentReportContextsForProject(long projectId)
java.util.Date	getLastExecution(long projectId, java.lang.String reportPath) Returns the start time of the last finished execution for this report.
long	getLastExecutionDuration(long projectId, java.lang.String reportPath)
java.util.Date	getLastScheduledExecution(long projectId, java.lang.String reportPath) Returns the start time of the last finished scheduled execution for this report.
ReportExecutionContext	getReportExecutionContext(long projectId, java.lang.String reportPath, boolean isSampleData)
java.util.List<ReportStatusWatcher>	getStatusList() Used by ReportStatusView to populate the status page.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportStatusManager

public ReportStatusManager(GatewayContext context)

Method Detail

getReportExecutionContext

public ReportExecutionContext getReportExecutionContext(long projectId,
                                                        java.lang.String reportPath,
                                                        boolean isSampleData)

getCurrentReportContexts

public java.util.List<ReportExecutionContext> getCurrentReportContexts()

getCurrentReportContextsForProject

public java.util.List<ReportExecutionContext> getCurrentReportContextsForProject(long projectId)

getLastExecution

public java.util.Date getLastExecution(long projectId,
                                       java.lang.String reportPath)

Returns the start time of the last finished execution for this report.

Parameters:

projectId -

reportPath -

Returns:

getLastScheduledExecution

public java.util.Date getLastScheduledExecution(long projectId,
                                                java.lang.String reportPath)

Returns the start time of the last finished scheduled execution for this report.

Parameters:

projectId -

reportPath -

Returns:

getLastExecutionDuration

public long getLastExecutionDuration(long projectId,
                                     java.lang.String reportPath)

Parameters:

projectId -

reportPath -

Returns:

Difference between start and end time in millis. Returns 0 if no last run date since gateway restart.

finish

public void finish(ReportExecutionContext reportExecutionContext)

Call this when report execution is finished to save last execution time and remove the report from the current execution map.

Parameters:

reportExecutionContext -

getStatusList

public java.util.List<ReportStatusWatcher> getStatusList()

Used by ReportStatusView to populate the status page.

Returns:

List of ReportStatusWatcher objects for reports currently executing and reports finished within FINISHED_FADE_TIME millis.

cancel

public void cancel(java.util.UUID uuid)