com.leonarduk.clearcheckbook

Class ClearCheckBookHelper

java.lang.Object

com.leonarduk.clearcheckbook.ClearCheckBookHelper

public class ClearCheckBookHelper
extends Object

A class to hold helper methods around the API. This adds caching to the ClearCheckBookConnection class. It is expected client code will use this class as an interface to the API.

Since:

6 Feb 2014

Version:

$Author:: $: Author of last commit, $Rev:: $: Revision of last commit, $Date:: $: Date of last commit

Author:

Stephen Leonard

Constructor Summary

Constructors

Constructor and Description
ClearCheckBookHelper(String userName, String password, int consumers)

Method Summary

Methods

Modifier and Type	Method and Description
File	exportAccounts(String fileName, List<AccountDataType> accounts)
File	exportCategories(String fileName, List<CategoryDataType> categories)
File	exportLimits(String fileName, List<LimitDataType> limits)
File	exportReminders(String fileName, List<ReminderDataType> reminders)
File	exportTransactions(String fileName, List<TransactionDataType> transactions)
List<AccountDataType>	getAccounts() fetch accounts from memory cache if fetched already.
Map<Long,AccountDataType>	getAccountsMap() fetch accounts from memory cache if fetched already.
List<CategoryDataType>	getCategories()
protected List<TransactionDataType>	getChangesOnly(List<TransactionDataType> modified, List<TransactionDataType> original)
List<LimitDataType>	getLimits()
List<ReminderDataType>	getReminders()
List<TransactionDataType>	getTransactions()
List<TransactionDataType>	getTransactions(AccountDataType account)
List<AccountDataType>	importAccounts(String fileName)
List<TransactionDataType>	importTransactions(String transactionsFileName, FilePreProcessor preprocessor)
boolean	isAccountIdValid(Long accountId) API extension to compare the provided account id with the list of ids for this user.
void	processAccounts(List<AccountDataType> accounts)
List<String>	processTransactions(List<TransactionDataType> modified)
List<String>	processTransactions(List<TransactionDataType> dataTypeList, ClearCheckBookTaskProcessor<TransactionDataType> processor)
List<String>	processTransactions(List<TransactionDataType> modified, List<TransactionDataType> original)
List<String>	processTransactions(List<TransactionDataType> modified, List<TransactionDataType> original, ClearCheckBookTaskProcessor<TransactionDataType> processor)
List<String>	processTransactionsInParallel(List<TransactionDataType> modified)
List<String>	processTransactionsInParallel(List<TransactionDataType> modified, List<TransactionDataType> original)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClearCheckBookHelper

public ClearCheckBookHelper(String userName,
                    String password,
                    int consumers)

Method Detail

exportAccounts

public File exportAccounts(String fileName,
                  List<AccountDataType> accounts)
                    throws ClearcheckbookException

Throws:

ClearcheckbookException

exportCategories

public File exportCategories(String fileName,
                    List<CategoryDataType> categories)
                      throws ClearcheckbookException

Throws:

ClearcheckbookException

exportLimits

public File exportLimits(String fileName,
                List<LimitDataType> limits)
                  throws ClearcheckbookException

Throws:

ClearcheckbookException

exportReminders

public File exportReminders(String fileName,
                   List<ReminderDataType> reminders)
                     throws ClearcheckbookException

Throws:

ClearcheckbookException

exportTransactions

public File exportTransactions(String fileName,
                      List<TransactionDataType> transactions)
                        throws ClearcheckbookException

Throws:

ClearcheckbookException

getAccounts

public List<AccountDataType> getAccounts()
                                  throws ClearcheckbookException

fetch accounts from memory cache if fetched already.

Returns:

Throws:

ClearcheckbookException

getAccountsMap

public Map<Long,AccountDataType> getAccountsMap()
                                         throws ClearcheckbookException

fetch accounts from memory cache if fetched already.

Returns:

Throws:

ClearcheckbookException

getCategories

public List<CategoryDataType> getCategories()
                                     throws ClearcheckbookException

Throws:

ClearcheckbookException

getLimits

public List<LimitDataType> getLimits()
                              throws ClearcheckbookException

Throws:

ClearcheckbookException

getReminders

public List<ReminderDataType> getReminders()
                                    throws ClearcheckbookException

Throws:

ClearcheckbookException

getTransactions

public List<TransactionDataType> getTransactions()
                                          throws ClearcheckbookException

Throws:

ClearcheckbookException

getTransactions

public List<TransactionDataType> getTransactions(AccountDataType account)
                                          throws ClearcheckbookException

Throws:

ClearcheckbookException

importAccounts

public List<AccountDataType> importAccounts(String fileName)
                                     throws ClearcheckbookException

Throws:

ClearcheckbookException

importTransactions

public List<TransactionDataType> importTransactions(String transactionsFileName,
                                           FilePreProcessor preprocessor)
                                             throws ClearcheckbookException

Throws:

ClearcheckbookException

isAccountIdValid

public boolean isAccountIdValid(Long accountId)
                         throws ClearcheckbookException

API extension to compare the provided account id with the list of ids for this user.

Parameters:

accountId -

Returns:

Throws:

ClearcheckbookException

processTransactions

public List<String> processTransactions(List<TransactionDataType> dataTypeList,
                               ClearCheckBookTaskProcessor<TransactionDataType> processor)
                                 throws ClearcheckbookException

Throws:

ClearcheckbookException

processTransactions

public List<String> processTransactions(List<TransactionDataType> modified,
                               List<TransactionDataType> original)
                                 throws ClearcheckbookException

Throws:

ClearcheckbookException

processTransactionsInParallel

public List<String> processTransactionsInParallel(List<TransactionDataType> modified,
                                         List<TransactionDataType> original)
                                           throws ClearcheckbookException

Throws:

ClearcheckbookException

processTransactionsInParallel

public List<String> processTransactionsInParallel(List<TransactionDataType> modified)
                                           throws ClearcheckbookException

Throws:

ClearcheckbookException

processTransactions

public List<String> processTransactions(List<TransactionDataType> modified)
                                 throws ClearcheckbookException

Throws:

ClearcheckbookException

processTransactions

public List<String> processTransactions(List<TransactionDataType> modified,
                               List<TransactionDataType> original,
                               ClearCheckBookTaskProcessor<TransactionDataType> processor)
                                 throws ClearcheckbookException

Throws:

ClearcheckbookException

getChangesOnly

protected List<TransactionDataType> getChangesOnly(List<TransactionDataType> modified,
                                       List<TransactionDataType> original)

processAccounts

public void processAccounts(List<AccountDataType> accounts)
                     throws ClearcheckbookException

Throws:

ClearcheckbookException