net.namibsun.papio.lib.db.models

Class Wallet

DbModel

NamedDbModel

TransactionHolderModel

net.namibsun.papio.lib.db.models.Wallet

public class Wallet
extends TransactionHolderModel

Models a Wallet in the database

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Wallet.Companion Static Methods

Field Summary

Fields

Modifier and Type	Field and Description
static Wallet.Companion	Companion Static Methods

Constructor Summary

Constructors

Constructor and Description
Wallet(int id, java.lang.String name, Value startingValue) Models a Wallet in the database

Method Summary

Modifier and Type	Method and Description
void	convertCurrency(DbHandler dbHandler, Currency currency) Converts the currency of the wallet. All transaction values in the wallet will also be converted.
boolean	equals(java.lang.Object other) Checks for equality with another object
static Wallet	fromResultSet(java.sql.ResultSet resultSet) Generates a Wallet object from a ResultSet
static Wallet	get(DbHandler dbHandler, int id) Retrieves a Wallet from the database by its ID
static Wallet	get(DbHandler dbHandler, java.lang.String nameOrId) Retrieves a Wallet from the database by its name or ID
Value	getBalance(DbHandler dbHandler) Calculates the balance of all transactions
Currency	getCurrency() Retrieves the currency currently used within this wallet
java.lang.String	toString() Represents the wallet as a String
java.lang.String	toString(DbHandler dbHandler) Represents the wallet as String including the current balance

Methods inherited from class net.namibsun.papio.lib.db.TransactionHolderModel

getTransactions

Methods inherited from class net.namibsun.papio.lib.db.NamedDbModel

createHelper, getName, toString

Methods inherited from class net.namibsun.papio.lib.db.DbModel

delete, getId, getTable, toString

Field Detail

Companion

public static Wallet.Companion Companion

Static Methods

Constructor Detail

Wallet

public Wallet(int id,
              java.lang.String name,
              Value startingValue)

Models a Wallet in the database

Parameters:

id - : The ID of the wallet in the database

name - : The name of the wallet

id - : The ID of the wallet in the database

name - : The name of the wallet

Method Detail

getBalance

public Value getBalance(DbHandler dbHandler)

Calculates the balance of all transactions

Parameters:

dbHandler - : The database handler to use

Returns:

The current balance of the wallet

getCurrency

public Currency getCurrency()

Retrieves the currency currently used within this wallet

Returns:

The currently used currency of the wallet

convertCurrency

public void convertCurrency(DbHandler dbHandler,
                            Currency currency)

Converts the currency of the wallet. All transaction values in the wallet will also be converted.

toString

public java.lang.String toString()

Represents the wallet as a String

Returns:

The wallet representation as a String

toString

public java.lang.String toString(DbHandler dbHandler)

Represents the wallet as String including the current balance

Parameters:

dbHandler - : The database handler used to retrieve the transactions for calculating the balance

Returns:

The wallet represented as a String

equals

public boolean equals(java.lang.Object other)

Checks for equality with another object

Parameters:

other - : The other object

Returns:

true if the objects are equal, false otherwise

fromResultSet

public static Wallet fromResultSet(java.sql.ResultSet resultSet)

Generates a Wallet object from a ResultSet

Parameters:

resultSet - : The ResultSet to use to generate the Wallet object

Returns:

The generated Wallet object

get

public static Wallet get(DbHandler dbHandler,
                         int id)

Retrieves a Wallet from the database by its ID

Parameters:

dbHandler - : The database handler to use

id - : The ID of the Wallet

Returns:

The generated Wallet object or null if no applicable wallet was found

get

public static Wallet get(DbHandler dbHandler,
                         java.lang.String nameOrId)

Retrieves a Wallet from the database by its name or ID

Parameters:

dbHandler - : The database handler to use

nameOrId - : The name or ID of the Wallet

Returns:

The generated Wallet object or null if no applicable wallet was found