org.beigesoft.accounting.service

Class SrvBalanceStd<RS>

java.lang.Object

org.beigesoft.accounting.service.SrvBalanceStd<RS>

Type Parameters:

RS - platform dependent record set type

All Implemented Interfaces:

ISrvBalance

public class SrvBalanceStd<RS>
extends Object
implements ISrvBalance

Service that maintenance BalanceAt and implements dirty check for all account. If balance for account at given date is NULL then it will be no record BalanceAt, this is cheap approach. All work include recalculation all balances is executed in single transaction

Author:

Yury Demidenko

Constructor Summary

Constructors

Constructor and Description
SrvBalanceStd() minimum constructor.
SrvBalanceStd(org.beigesoft.service.ISrvOrm<RS> pSrvOrm, org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase, ISrvAccSettings pSrvAccSettings, org.beigesoft.log.ILogger pLogger) Useful constructor.

Method Summary

Modifier and Type	Method and Description
void	changeBalanceStorePeriod(Map<String,Object> pAddParam, org.beigesoft.model.EPeriod pPeriod) Change period of stored balances EPeriod.DAILY/WEEKLY/MONTHLY and switch on "current balances are dirty".
BalanceAt	evalBalanceAt(Map<String,Object> pAddParam, Account pAcc, Long pSubaccId, Date pDateFor) Evaluate BalanceAt for given pAcc which itsDate less or equals pDateFor.
org.beigesoft.model.EPeriod	evalBalanceStorePeriod(Map<String,Object> pAddParam) Evaluate period of stored balances according settings, if it's changed then it switch on "current balances are dirty".
Date	evalDateBalanceStoreStart(Map<String,Object> pAddParam) Evaluate date start of stored balances according settings, this is the first month of the first accounting entry or start of current year if there are no any acc-entry.
Date	evalDateNextPeriodStart(Map<String,Object> pAddParam, Date pDateFor) Evaluate date start of next balance store period.
Date	evalDatePeriodStartFor(Map<String,Object> pAddParam, Date pDateFor) Evaluate start of period nearest to pDateFor.
String	evalQueryBalance(Map<String,Object> pAddParam, Date pDate) Evaluate Trial Balance query.
org.beigesoft.log.ILogger	getLogger() Geter for logger.
String	getQueryBalance() Getter for queryBalance.
ISrvAccSettings	getSrvAccSettings() Getter for srvAccSettings.
org.beigesoft.service.ISrvDatabase<RS>	getSrvDatabase() Geter for srvDatabase.
org.beigesoft.service.ISrvOrm<RS>	getSrvOrm() Getter for srvOrm.
void	handleNewAccountEntry(Map<String,Object> pAddParam, Account pAcc, Long pSubaccId, Date pDateAt) Handle new accounting entry is created to check dirty.
BalanceAtAllDirtyCheck	lazyGetBalanceAtAllDirtyCheck(Map<String,Object> pAddParam) Lazy getter for balanceAtAllDirtyCheck.
String	loadString(String pFileName) Load string file (usually SQL query).
void	recalculateAll(Map<String,Object> pAddParam, Date pDateFor, boolean pIsPrepareNeed) Forced recalculation all balances for all dates less or equals pDateFor.
void	recalculateAllIfNeed(Map<String,Object> pAddParam, Date pDateFor) Recalculate if need for all balances for all dates less or equals pDateFor, this method is always invoked by report ledger.
void	recalculateFor(Map<String,Object> pAddParam, Account pAcc, Long pSubaccId, Date pDateFor) Forced recalculation all stored balances for this account for all dates less or equals pDateFor.
List<TrialBalanceLine>	retrieveBalanceLines(Map<String,Object> pAddParam, String pQuery) Retrieve Trial Balance lines with given query and precision cost.
List<TrialBalanceLine>	retrieveBalanceLinesForStore(String pQuery) Retrieve Trial Balance lines with given query for store.
List<TrialBalanceLine>	retrieveTrialBalance(Map<String,Object> pAddParam, Date pDate) Retrieve Trial Balance.
void	setLogger(org.beigesoft.log.ILogger pLogger) Setter for logger.
void	setQueryBalance(String pQueryBalance) Setter for queryBalance.
void	setSrvAccSettings(ISrvAccSettings pSrvAccSettings) Setter for srvAccSettings.
void	setSrvDatabase(org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase) Setter for srvDatabase.
void	setSrvOrm(org.beigesoft.service.ISrvOrm<RS> pSrvOrm) Setter for srvOrm.

Methods inherited from class java.lang.Object

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

Constructor Detail

SrvBalanceStd

public SrvBalanceStd()

minimum constructor.

SrvBalanceStd

public SrvBalanceStd(org.beigesoft.service.ISrvOrm<RS> pSrvOrm,
                     org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase,
                     ISrvAccSettings pSrvAccSettings,
                     org.beigesoft.log.ILogger pLogger)

Useful constructor.

Parameters:

pSrvOrm - ORM service

pSrvDatabase - Database service

pSrvAccSettings - AccSettings service

pLogger - reference

Method Detail

changeBalanceStorePeriod

public final void changeBalanceStorePeriod(Map<String,Object> pAddParam,
                                           org.beigesoft.model.EPeriod pPeriod)
                                    throws Exception

Change period of stored balances EPeriod.DAILY/WEEKLY/MONTHLY and switch on "current balances are dirty".

Specified by:

changeBalanceStorePeriod in interface ISrvBalance

Parameters:

pAddParam - additional param

pPeriod - EPeriod e.g. MONTHLY

Throws:

Exception - - an exception

evalBalanceStorePeriod

public final org.beigesoft.model.EPeriod evalBalanceStorePeriod(Map<String,Object> pAddParam)
                                                         throws Exception

Evaluate period of stored balances according settings, if it's changed then it switch on "current balances are dirty".

Specified by:

evalBalanceStorePeriod in interface ISrvBalance

Parameters:

pAddParam - additional param

Returns:

pPeriod EPeriod e.g. MONTHLY

Throws:

Exception - - an exception

evalBalanceAt

public final BalanceAt evalBalanceAt(Map<String,Object> pAddParam,
                                     Account pAcc,
                                     Long pSubaccId,
                                     Date pDateFor)
                              throws Exception

Evaluate BalanceAt for given pAcc which itsDate less or equals pDateFor. If required BalanceAt (and all BalanceAt from start of year) is null or dirty it makes it (they).

Specified by:

evalBalanceAt in interface ISrvBalance

Parameters:

pAddParam - additional param

pAcc - account

pSubaccId - subaccount ID

pDateFor - date for

Returns:

BalanceAt data

Throws:

Exception - - an exception

handleNewAccountEntry

public final void handleNewAccountEntry(Map<String,Object> pAddParam,
                                        Account pAcc,
                                        Long pSubaccId,
                                        Date pDateAt)
                                 throws Exception

Handle new accounting entry is created to check dirty. This is implementation of dirty check for all accounts.

Specified by:

handleNewAccountEntry in interface ISrvBalance

Parameters:

pAddParam - additional param

pAcc - account

pSubaccId - subaccount ID

pDateAt - date at

Throws:

Exception - - an exception

recalculateAllIfNeed

public final void recalculateAllIfNeed(Map<String,Object> pAddParam,
                                       Date pDateFor)
                                throws Exception

Recalculate if need for all balances for all dates less or equals pDateFor, this method is always invoked by report ledger.

Specified by:

recalculateAllIfNeed in interface ISrvBalance

Parameters:

pAddParam - additional param

pDateFor - date for

Throws:

Exception - - an exception

recalculateFor

public final void recalculateFor(Map<String,Object> pAddParam,
                                 Account pAcc,
                                 Long pSubaccId,
                                 Date pDateFor)
                          throws Exception

Forced recalculation all stored balances for this account for all dates less or equals pDateFor. This method usually invoked by account subaccount line service when subaccount is added.

Specified by:

recalculateFor in interface ISrvBalance

Parameters:

pAddParam - additional param

pAcc - account

pSubaccId - subaccount ID

pDateFor - date for

Throws:

Exception - - an exception

recalculateAll

public final void recalculateAll(Map<String,Object> pAddParam,
                                 Date pDateFor,
                                 boolean pIsPrepareNeed)
                          throws Exception

Forced recalculation all balances for all dates less or equals pDateFor. If balance for account at given date is NULL then it will be no recorded into BalanceAt, this is cheap approach.

Specified by:

recalculateAll in interface ISrvBalance

Parameters:

pAddParam - additional param

pDateFor - date for

pIsPrepareNeed - if need evaluation store period/start of store

Throws:

Exception - - an exception

retrieveTrialBalance

public final List<TrialBalanceLine> retrieveTrialBalance(Map<String,Object> pAddParam,
                                                         Date pDate)
                                                  throws Exception

Retrieve Trial Balance.

Specified by:

retrieveTrialBalance in interface ISrvBalance

Parameters:

pAddParam - additional param

pDate - date

Returns:

balance lines

Throws:

Exception - - an exception

evalDatePeriodStartFor

public final Date evalDatePeriodStartFor(Map<String,Object> pAddParam,
                                         Date pDateFor)
                                  throws Exception

Evaluate start of period nearest to pDateFor. Tested in beige-common org.beigesoft.test.CalendarTest.

Specified by:

evalDatePeriodStartFor in interface ISrvBalance

Parameters:

pAddParam - additional param

pDateFor - date for

Returns:

Start of period nearest to pDateFor

Throws:

Exception - - an exception

evalDateBalanceStoreStart

public final Date evalDateBalanceStoreStart(Map<String,Object> pAddParam)
                                     throws Exception

Evaluate date start of stored balances according settings, this is the first month of the first accounting entry or start of current year if there are no any acc-entry.

Parameters:

pAddParam - additional param

Returns:

Date

Throws:

Exception - - an exception

evalQueryBalance

public final String evalQueryBalance(Map<String,Object> pAddParam,
                                     Date pDate)
                              throws Exception

Evaluate Trial Balance query.

Parameters:

pAddParam - additional param

pDate - date of balance

Returns:

query of balance

Throws:

Exception - - an exception

retrieveBalanceLines

public final List<TrialBalanceLine> retrieveBalanceLines(Map<String,Object> pAddParam,
                                                         String pQuery)
                                                  throws Exception

Retrieve Trial Balance lines with given query and precision cost.

Parameters:

pAddParam - additional param

pQuery - date

Returns:

balance lines

Throws:

Exception - - an exception

retrieveBalanceLinesForStore

public final List<TrialBalanceLine> retrieveBalanceLinesForStore(String pQuery)
                                                          throws Exception

Retrieve Trial Balance lines with given query for store.

Parameters:

pQuery - date

Returns:

balance lines

Throws:

Exception - - an exception

loadString

public final String loadString(String pFileName)
                        throws IOException

Load string file (usually SQL query).

Parameters:

pFileName - file name

Returns:

String usually SQL query

Throws:

IOException - - IO exception

lazyGetBalanceAtAllDirtyCheck

public final BalanceAtAllDirtyCheck lazyGetBalanceAtAllDirtyCheck(Map<String,Object> pAddParam)
                                                           throws Exception

Lazy getter for balanceAtAllDirtyCheck.

Parameters:

pAddParam - additional param

Returns:

BalanceAtAllDirtyCheck

Throws:

Exception - - an exception

evalDateNextPeriodStart

public final Date evalDateNextPeriodStart(Map<String,Object> pAddParam,
                                          Date pDateFor)
                                   throws Exception

Evaluate date start of next balance store period. Tested in beige-common org.beigesoft.test.CalendarTest.

Parameters:

pAddParam - additional param

pDateFor - date for

Returns:

Start of next period nearest to pDateFor

Throws:

Exception - - an exception

getSrvOrm

public final org.beigesoft.service.ISrvOrm<RS> getSrvOrm()

Getter for srvOrm.

Returns:

ISrvOrm

setSrvOrm

public final void setSrvOrm(org.beigesoft.service.ISrvOrm<RS> pSrvOrm)

Setter for srvOrm.

Parameters:

pSrvOrm - reference

getSrvDatabase

public final org.beigesoft.service.ISrvDatabase<RS> getSrvDatabase()

Geter for srvDatabase.

Returns:

ISrvDatabase

setSrvDatabase

public final void setSrvDatabase(org.beigesoft.service.ISrvDatabase<RS> pSrvDatabase)

Setter for srvDatabase.

Parameters:

pSrvDatabase - reference

getSrvAccSettings

public final ISrvAccSettings getSrvAccSettings()

Getter for srvAccSettings.

Returns:

ISrvAccSettings

setSrvAccSettings

public final void setSrvAccSettings(ISrvAccSettings pSrvAccSettings)

Setter for srvAccSettings.

Parameters:

pSrvAccSettings - reference

getQueryBalance

public final String getQueryBalance()

Getter for queryBalance.

Returns:

String

setQueryBalance

public final void setQueryBalance(String pQueryBalance)

Setter for queryBalance.

Parameters:

pQueryBalance - reference

getLogger

public final org.beigesoft.log.ILogger getLogger()

Geter for logger.

Returns:

ILogger

setLogger

public final void setLogger(org.beigesoft.log.ILogger pLogger)

Setter for logger.

Parameters:

pLogger - reference