Type Members

1.  final case class AccountSelectorChecksum(hash: Checksum) extends MetadataItem with Product with Serializable

   Account Selector Checksum metadata item

   Account Selector Checksum metadata item

   hash

   of account selector

2.  sealed abstract class BBoxLatLon extends TxnFilter
3.  final case class BalanceGroupReport(metadata: Option[Metadata], title: String, groups: Seq[BalanceReport]) extends Product with Serializable
4.  final case class BalanceItem(accountSum: String, accountTreeSum: String, account: String, commodity: Option[String]) extends Product with Serializable
5.  final case class BalanceReport(metadata: Option[Metadata], title: String, balances: Seq[BalanceItem], deltas: Seq[Delta]) extends Product with Serializable
6.  final case class Checksum(algorithm: String, value: String) extends Product with Serializable
7.  final case class Delta(delta: String, commodity: Option[String]) extends Product with Serializable
8.  class GeoPoint extends AnyRef

   WGS84 (EPSG:4326) based Geo Location This is based on simplified geo uri scheme, see TEP-1010 for details.

9.  final case class GitInputReference(commit: String, ref: Option[String], dir: String, suffix: String, message: String) extends InputMetadataItem with Product with Serializable

   Reference information for Git txn input

   Reference information for Git txn input

   commit

   is commit id (sha1) of used git tree

   ref

   is set if source selection was done by git reference

   dir

   is path of top level directory which contains txns inside repository

   suffix

   is used to select txn

   message

   is short message of commit (one-line format)

10.  sealed trait InputMetadataItem extends MetadataItem

    Trait for txn input related metadata items.

11.  final case class Metadata(items: Seq[MetadataItem]) extends Product with Serializable
12.  sealed trait MetadataItem extends AnyRef
13.  final case class RegisterPosting(account: String, amount: String, runningTotal: String, commodity: Option[String]) extends Product with Serializable
14.  final case class RegisterReport(metadata: Option[Metadata], title: String, transactions: Seq[RegisterTxn]) extends Product with Serializable
15.  final case class RegisterTxn(txn: TxnHeader, postings: Seq[RegisterPosting]) extends Product with Serializable
16.  type Tags = List[String]
17.  final case class TimeZoneInfo(zoneId: ZoneId) extends MetadataItem with Product with Serializable

    Information about report's timezone

18.  sealed trait TxnFilter extends AnyRef
19.  final case class TxnFilterAND(txnFilters: Seq[TxnFilter]) extends TxnFilters with Product with Serializable

    Logical AND, e.g.

    Logical AND, e.g. selects transaction if and only if all contained filters select it.

    txnFilters

    sequence of TxnFilter filters. There must be at least two filters.

20.  final case class TxnFilterAll() extends TxnFilter with Product with Serializable

    Selects all transactions.

21.  final case class TxnFilterBBoxLatLon(south: BigDecimal, west: BigDecimal, north: BigDecimal, east: BigDecimal) extends BBoxLatLon with Product with Serializable

    Select Transaction if it has location attribute, and it's geo location is inside Bounding Box.

    Select Transaction if it has location attribute, and it's geo location is inside Bounding Box.

    This will ignore altitude, e.g. it will select 3D transaction if it fits 2D BBox. If transaction doesn't have location information, it will not be selected.

    south

    bbox bottom edge

    west

    bbox left edge

    north

    bbox top edge

    east

    bbox right edge

22.  final case class TxnFilterBBoxLatLonAlt(south: BigDecimal, west: BigDecimal, depth: BigDecimal, north: BigDecimal, east: BigDecimal, height: BigDecimal) extends BBoxLatLon with Product with Serializable

    Select Transaction if it has location attribute, and it's geo location is inside Bounding Box.

    Select Transaction if it has location attribute, and it's geo location is inside Bounding Box.

    This will select only transactions with altitude, e.g. it will not select any 2D transaction, even if it fits 2D BBox.

    If transaction doesn't have location information, it will not be selected.

    south

    bbox bottom edge

    west

    bbox left dege

    depth

    bbox floor

    north

    bbox top edge

    east

    bbox right edge

    height

    bbox ceiling

23.  final case class TxnFilterDefinition(txnFilter: TxnFilter) extends Product with Serializable

    Top-level container element of transaction filter definition.

    Top-level container element of transaction filter definition.

    Transaction filter definitions can form tree-like structures, and this is mandatory root node of transaction filter definition.

24.  final case class TxnFilterDescription(txnFilterDef: TxnFilterDefinition) extends MetadataItem with Product with Serializable

    Description of used Txn Filters

    Description of used Txn Filters

    txnFilterDef

    is Filter definition used to filter transactions

25.  sealed case class TxnFilterNOT(txnFilter: TxnFilter) extends TxnFilter with Product with Serializable

    Logical NOT, e.g.

    Logical NOT, e.g. selects all deselected transactions, and deselect all selected transactions.

    txnFilter

    which will be negated.

26.  final case class TxnFilterNone() extends TxnFilter with Product with Serializable

    Deselects all transactions.

27.  sealed case class TxnFilterOR(txnFilters: Seq[TxnFilter]) extends TxnFilters with Product with Serializable

    Logical OR, e.g.

    Logical OR, e.g. selects transaction any (or all) contained filters select it.

    txnFilters

    sequence of TxnFilter filters. There must be at least two filters.

28.  sealed abstract class TxnFilterPosting extends TxnFilterRegex
29.  final case class TxnFilterPostingAccount(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches any of this transactions's posting accounts.

    Select transaction if regular expression matches any of this transactions's posting accounts.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of this transaction's posting accounts

30.  final case class TxnFilterPostingAmountEqual(regex: String, amount: BigDecimal) extends TxnFilterPosting with Product with Serializable

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is equal with specified amount.

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is equal with specified amount.

    Q: Why there is also account regex as parameter? A: For consistency with less and greater, where it's mandatory.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of this transaction's posting accounts

    amount

    amount of that matched account (by regex) must be exactly this

31.  final case class TxnFilterPostingAmountGreater(regex: String, amount: BigDecimal) extends TxnFilterPosting with Product with Serializable

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is less than specified amount.

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is less than specified amount.

    Q: Why there is also account regex as parameter? A: Sum of all postings inside transaction must be zero. If you select "more than some negative amount", then all transactions will match, because there must be postings with positive amounts in every transaction to zero out the whole transaction.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of this transaction's posting accounts

    amount

    amount of matched account (by regex) must be greater than this

32.  final case class TxnFilterPostingAmountLess(regex: String, amount: BigDecimal) extends TxnFilterPosting with Product with Serializable

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is less than specified amount.

    Select transaction if regular expression matches any of this transaction's posting account and at the same time amount of that posting is less than specified amount.

    Q: Why there is also account regex as parameter? A: Sum of all postings inside transaction must be zero. If you select "less than some positive amount", be postings with negative amounts in every transaction to zero out the whole transaction.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of this transaction's posting accounts

    amount

    amount of matched account (by regex) must be less than this

33.  final case class TxnFilterPostingComment(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches any of this transaction's posting comment.

    Select transaction if regular expression matches any of this transaction's posting comment.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of this transaction's posting comment.

34.  final case class TxnFilterPostingCommodity(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches any of this transaction's posting commodity.

    Select transaction if regular expression matches any of this transaction's posting commodity.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match posting commodity

35.  sealed abstract class TxnFilterRegex extends TxnFilter
36.  final case class TxnFilterTxnCode(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches txn code.

    Select transaction if regular expression matches txn code.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match txn code.

37.  final case class TxnFilterTxnComments(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches any of txn comments.

    Select transaction if regular expression matches any of txn comments.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of txn comments.

38.  final case class TxnFilterTxnDescription(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches txn description.

    Select transaction if regular expression matches txn description.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match txn description

39.  sealed abstract class TxnFilterTxnTS extends TxnFilter
40.  final case class TxnFilterTxnTSBegin(begin: ZonedDateTime) extends TxnFilterTxnTS with Product with Serializable

    Selects transaction if txn timestamp is on or after specified time.

    Selects transaction if txn timestamp is on or after specified time.

    begin

    txn timestamp must be on or after this

41.  final case class TxnFilterTxnTSEnd(end: ZonedDateTime) extends TxnFilterTxnTS with Product with Serializable

    Selects transaction if txn timestamp is before of specified time.

    Selects transaction if txn timestamp is before of specified time.

    end

    txn timestamp is before of specified time.

42.  final case class TxnFilterTxnTags(regex: String) extends TxnFilterRegex with Product with Serializable

    Select transaction if regular expression matches any of txn tags.

    Select transaction if regular expression matches any of txn tags.

    Used regular expression engine is java.util.regex.Pattern.

    regex

    to match any of txn tags.

43.  final case class TxnFilterTxnUUID(uuid: UUID) extends TxnFilter with Product with Serializable

    Select transaction if txn UUID is same as specified uuid.

44.  sealed trait TxnFilters extends TxnFilter
45.  final case class TxnHeader(timestamp: ZonedDateTime, code: Option[String], description: Option[String], uuid: Option[UUID], location: Option[GeoPoint], tags: Option[Tags], comments: Option[List[String]]) extends Product with Serializable
46.  final case class TxnSetChecksum(size: Int, hash: Checksum) extends MetadataItem with Product with Serializable

    Txn Set Checksum metadata item

    Txn Set Checksum metadata item

    size

    of transaction set

    hash

    of Txn Set Checksum