CashFlowReportRunner (OpenGamma Strata)

java.lang.Object
- com.opengamma.strata.report.cashflow.CashFlowReportRunner

All Implemented Interfaces:: ReportRunner<CashFlowReportTemplate>

public final class CashFlowReportRunner
extends Object
implements ReportRunner<CashFlowReportTemplate>

Report runner for cash flow reports.

Field Summary

Fields
Modifier and Type Field Description

static CashFlowReportRunner INSTANCE
The single shared instance of this report runner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ReportRequirements`	`requirements(CashFlowReportTemplate reportTemplate)`	Gets a description of the requirements to run a report for the given template.
`Report`	`runReport(ReportCalculationResults calculationResults, CashFlowReportTemplate reportTemplate)`	Runs a report from a set of calculation results.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final CashFlowReportRunner INSTANCE
```
    The single shared instance of this report runner.
- Method Detail
  - requirements
```
public ReportRequirements requirements(CashFlowReportTemplate reportTemplate)
```
    Description copied from interface: ReportRunner
    
    Gets a description of the requirements to run a report for the given template. Requirements include trade-level measures.
    The report may be run on calculation results including at least these requirements.
    
    Specified by:
    
    requirements in interface ReportRunner<CashFlowReportTemplate>
    
    Parameters:
    
    reportTemplate - the report template
    
    Returns:
    
    the requirements to run the report
  - runReport
```
public Report runReport(ReportCalculationResults calculationResults,
                        CashFlowReportTemplate reportTemplate)
```
    Description copied from interface: ReportRunner
    
    Runs a report from a set of calculation results. The contents of the report are dictated by the template provided. The calculation results may be substantially more complete than the template requires.
    
    Specified by:
    
    runReport in interface ReportRunner<CashFlowReportTemplate>
    
    Parameters:
    
    calculationResults - the calculation results
    
    reportTemplate - the report template
    
    Returns:
    
    the report