Package com.opengamma.strata.report.cashflow

Class CashFlowReport

java.lang.Object

com.opengamma.strata.report.cashflow.CashFlowReport

All Implemented Interfaces:

Report, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class CashFlowReport
extends Object
implements Report, org.joda.beans.ImmutableBean

Represents a cash flow report.

This consists of fields captured as part of a calculation. The rows are generally ordered through time, and neighbouring rows may show related flows - for example, a payment period containing multiple resets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CashFlowReport.Builder	The bean-builder for CashFlowReport.
static class	CashFlowReport.Meta	The meta-bean for CashFlowReport.

Method Summary

Modifier and Type	Method	Description
static CashFlowReport.Builder	builder()	Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
ImmutableList<String>	getColumnHeaders()	Gets the column headers.
ImmutableList<ExplainKey<?>>	getColumnKeys()	Gets the keys corresponding to the columns.
ImmutableTable<Integer,Integer,Object>	getData()	Gets the cashflow data table.
int	getRowCount()	Gets the number of rows in the report table.
Instant	getRunInstant()	Gets the instant at which the report was run.
LocalDate	getValuationDate()	Gets the valuation date.
int	hashCode()
static CashFlowReport.Meta	meta()	The meta-bean for CashFlowReport.
CashFlowReport.Meta	metaBean()
CashFlowReport.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
String	toString()
void	writeAsciiTable(OutputStream out)	Writes this report out as an ASCII table.
void	writeCsv(OutputStream out)	Writes this report out in a CSV format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Methods inherited from interface com.opengamma.strata.report.Report

getColumnCount, toAsciiTableString

Method Detail

getRowCount

public int getRowCount()

Description copied from interface: Report

Gets the number of rows in the report table.

Specified by:

getRowCount in interface Report

Returns:

the number of rows in the report table

writeCsv

public void writeCsv(OutputStream out)

Description copied from interface: Report

Writes this report out in a CSV format.

Specified by:

writeCsv in interface Report

Parameters:

out - the output stream to write to

writeAsciiTable

public void writeAsciiTable(OutputStream out)

Description copied from interface: Report

Writes this report out as an ASCII table.

Specified by:

writeAsciiTable in interface Report

Parameters:

out - the output stream to write to

meta

public static CashFlowReport.Meta meta()

The meta-bean for CashFlowReport.

Returns:

the meta-bean, not null

builder

public static CashFlowReport.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public CashFlowReport.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getValuationDate

public LocalDate getValuationDate()

Gets the valuation date.

Specified by:

getValuationDate in interface Report

Returns:

the value of the property, not null

getRunInstant

public Instant getRunInstant()

Gets the instant at which the report was run.

Specified by:

getRunInstant in interface Report

Returns:

the value of the property, not null

getColumnKeys

public ImmutableList<ExplainKey<?>> getColumnKeys()

Gets the keys corresponding to the columns.

Returns:

the value of the property, not null

getColumnHeaders

public ImmutableList<String> getColumnHeaders()

Gets the column headers.

Specified by:

getColumnHeaders in interface Report

Returns:

the value of the property, not null

getData

public ImmutableTable<Integer,Integer,Object> getData()

Gets the cashflow data table.

Returns:

the value of the property, not null

toBuilder

public CashFlowReport.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object