Class CashFlowReport

  • All Implemented Interfaces:
    Report, Bean, ImmutableBean

    public final class CashFlowReport
    extends java.lang.Object
    implements Report, 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.

    • 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​(java.io.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​(java.io.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
      • getValuationDate

        public java.time.LocalDate getValuationDate()
        Gets the valuation date.
        Specified by:
        getValuationDate in interface Report
        Returns:
        the value of the property, not null
      • getRunInstant

        public java.time.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 com.google.common.collect.ImmutableList<ExplainKey<?>> getColumnKeys()
        Gets the keys corresponding to the columns.
        Returns:
        the value of the property, not null
      • getColumnHeaders

        public com.google.common.collect.ImmutableList<java.lang.String> getColumnHeaders()
        Gets the column headers.
        Specified by:
        getColumnHeaders in interface Report
        Returns:
        the value of the property, not null
      • getData

        public com.google.common.collect.ImmutableTable<java.lang.Integer,​java.lang.Integer,​java.lang.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​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object