report

Documentation

Index

• type Builder
  • func (b Builder) Build(bal []*balance.Balance) (*Report, error)
• type Collapse
  • func (c Collapse) MatchAccount(a *accounts.Account) bool
• type Position
• type Renderer
  • func (rn *Renderer) Render(r *Report) *table.Table
• type Report
• type Segment
  • func NewSegment(k string) *Segment

Types

type Builder

type Builder struct {
	Value    bool
	Collapse []Collapse
}

Builder contains configuration options to create a report.

func (Builder) Build

func (b Builder) Build(bal []*balance.Balance) (*Report, error)

Build creates a new report.

type Collapse

type Collapse struct {
	Level int
	Regex *regexp.Regexp
}

Collapse is a rule for collapsing (shortening) accounts.

func (Collapse) MatchAccount

func (c Collapse) MatchAccount(a *accounts.Account) bool

MatchAccount determines whether this Collapse matches the given Account.

type Position

type Position struct {
	balance.CommodityAccount
	Amounts vector.Vector
}

Position is a position.

type Renderer

type Renderer struct {
	Commodities bool
	// contains filtered or unexported fields
}

Renderer renders a report.

func (*Renderer) Render

func (rn *Renderer) Render(r *Report) *table.Table

Render renders a report.

type Report

type Report struct {
	Dates       []time.Time
	Segments    map[accounts.AccountType]*Segment
	Commodities []*commodities.Commodity
	Positions   map[*commodities.Commodity]vector.Vector
}

Report is a balance report for a range of dates.

type Segment

type Segment struct {
	Key         string
	Positions   map[*commodities.Commodity]vector.Vector
	Subsegments []*Segment
}

Segment is a hierarchical segment of a report.

func NewSegment

func NewSegment(k string) *Segment

NewSegment creates a new segment.