net.yapbam.data.Transaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yapbam-commons Show documentation
Commons Yapbam classes used by desktop and Android versions.
There is a newer version: 1.9.1
package net.yapbam.data;

import java.io.Serializable;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import net.yapbam.util.DateUtils;

/** A bank transaction */
public class Transaction extends AbstractTransaction implements Serializable {
	private static final long serialVersionUID = 1L;
	
	private int date;
	private String number;
	private int valueDate;
	private String statementId;
	
	/** Constructor.
	 * @param date The transaction's date in its integer representation.
	 * @param number The transaction's number (null if the description has not any number)
	 * @param description The transaction's description
	 * @param comment The transaction's comment (null if the transaction has no comment)
	 * @param amount The transaction's amount (negative for an expense)
	 * @param account  The transaction's account
	 * @param mode The transaction's payment mode 
	 * @param category The transaction's category
	 * @param valueDate The transaction's value date in its integer representation.
	 * @param statementId The transaction's the statement id (null if the transaction doesn't blong to a statement)
	 * @param subTransactions the subtransactions of the transaction (an empty List or null if the transaction has no subtransaction)
	 * @see DateUtils#dateToInteger(Date)
	 */
	public Transaction(int date, String number, String description, String comment, double amount,
			Account account, Mode mode, Category category, int valueDate, String statementId, List subTransactions) {
		super(description, comment, amount, account, mode, category, subTransactions);
		this.date = date;
		this.number = number;
		if ((number!=null) && number.trim().isEmpty()) {
			this.number = null;
		}
		this.valueDate = valueDate;
		this.statementId = statementId;
		if ((statementId!=null) && statementId.trim().isEmpty()) {
			this.statementId=null;
		}
	}

	/** Constructor.
	 * @param date The transaction's date
	 * @param number The transaction's number (null if the description has not any number)
	 * @param description The transaction's description
	 * @param comment The transaction's comment (null if the transaction has no comment)
	 * @param amount The transaction's amount (negative for an expense)
	 * @param account  The transaction's account
	 * @param mode The transaction's payment mode 
	 * @param category The transaction's category
	 * @param valueDate The transaction's value date
	 * @param statementId The transaction's the statement id (null if the transaction doesn't belong to a statement)
	 * @param subTransactions the subtransactions of the transaction (an empty List or null if the transaction has no subtransaction)
	 */
	public Transaction(Date date, String number, String description, String comment, double amount,
			Account account, Mode mode, Category category, Date valueDate, String statementId, List subTransactions) {
		this(DateUtils.dateToInteger(date), number, description, comment, amount, account, mode, category, DateUtils.dateToInteger(valueDate),
				statementId, subTransactions);
	}

	public String getNumber() {
		return this.number;
	}

	public Date getDate() {
		return DateUtils.integerToDate(this.date);
	}
	
	public int getDateAsInteger() {
		return this.date;
	}

	public Date getValueDate() {
		return DateUtils.integerToDate(valueDate);
	}

	public int getValueDateAsInteger() {
		return this.valueDate;
	}

	/** Gets this transaction's statement.
	 * @return This transaction's statement or null if the transaction doesn't belong to any statement. 
	 */
	public String getStatement() {
		return statementId;
	}

	@Override
	public String toString() {
		return MessageFormat.format("({0} \"{1}\" {2,date,short}->{3,date,short}: {4,number,currency})", getAccount(), getDescription(), getDate(), getValueDate(), getAmount()); //$NON-NLS-1$
	}

	/** Tests whether this transaction's is checked.
	 * @return true if this transaction is checked, false if not (the transaction doesn't belong to any statement). 
	 */
	public boolean isChecked() {
		return this.statementId!=null;
	}
	
	/** Creates a new transaction that differs only by the category.
	 * @param oldCategory The category to change.
	 * 
Note that the modifications operate even on the subtransactions, so, this
	 * @param newCategory The replacement category.
	 * @return a new updated transaction or null if the old category was not used in this transaction.
	 */
	Transaction change(Category oldCategory, Category newCategory) {
		if (!hasCategory(oldCategory)) {
			return null;
		}
		List subTransactions = changeSubTransactions(oldCategory, newCategory);
		return new Transaction(getDate(), getNumber(), getDescription(), getComment(), getAmount(), getAccount(), getMode(),
				getCategory().equals(oldCategory)?newCategory:getCategory(), getValueDate(), getStatement(), subTransactions);
	}

	Transaction change(Account account, Mode oldMode, Mode newMode) {
		if (getAccount().equals(account) && getMode().equals(oldMode)) {
			ArrayList subTransactionsClone = new ArrayList();
			for (int i=0;i